A abstract audio resource. More...

#include <CeresEngine/Audio/AudioResource.hpp>

Inheritance diagram for CeresEngine::AbstractAudioResource:

Public Types
using	Sample = unsigned short
	A audio sample type.

using	Samples = Vector< Sample >
	A collection of multiple audio samples.

using	SampleIndex = unsigned int
	A type representing the index of a sample.

using	SampleOffset = int
	A type representing a sample offset.

Public Member Functions
virtual	~AbstractAudioResource ()=default

virtual const AudioMetadata &	getMetadata () const =0

virtual AudioResourceType	getType () const =0

bool	isClip () const

AudioClip &	asClip ()

const AudioClip &	asClip () const

bool	isStream () const

AudioStream &	asStream ()

const AudioStream &	asStream () const

Detailed Description

A abstract audio resource.

This class represents both a audio clip and a audio stream.

Member Typedef Documentation

◆ Sample

using CeresEngine::AbstractAudioResource::Sample = unsigned short

A audio sample type.

◆ SampleIndex

using CeresEngine::AbstractAudioResource::SampleIndex = unsigned int

A type representing the index of a sample.

◆ SampleOffset

using CeresEngine::AbstractAudioResource::SampleOffset = int

A type representing a sample offset.

◆ Samples

using CeresEngine::AbstractAudioResource::Samples = Vector<Sample>

A collection of multiple audio samples.

Constructor & Destructor Documentation

◆ ~AbstractAudioResource()

virtual CeresEngine::AbstractAudioResource::~AbstractAudioResource ( )

virtualdefault

Member Function Documentation

◆ asClip() [1/2]

AudioClip & CeresEngine::AbstractAudioResource::asClip ( )

Returns: The audio resource as a clip NOTE: this method throws if isClip() returns false.

◆ asClip() [2/2]

const AudioClip & CeresEngine::AbstractAudioResource::asClip ( ) const

Returns: The audio resource as a clip NOTE: this method throws if isClip() returns false.

◆ asStream() [1/2]

AudioStream & CeresEngine::AbstractAudioResource::asStream ( )

Returns: The audio resource as a stream

NOTE: this method throws if isStream() returns false.

◆ asStream() [2/2]

const AudioStream & CeresEngine::AbstractAudioResource::asStream ( ) const

Returns: The audio resource as a stream

NOTE: this method throws if isStream() returns false.

◆ getMetadata()

virtual const AudioMetadata & CeresEngine::AbstractAudioResource::getMetadata ( ) const

pure virtual

Returns: The audio resource metadata

Implemented in CeresEngine::SimpleAudioClip.

◆ getType()

virtual AudioResourceType CeresEngine::AbstractAudioResource::getType ( ) const

pure virtual

Returns: The audio resource type

Implemented in CeresEngine::AudioClip, and CeresEngine::AudioStream.

◆ isClip()

bool CeresEngine::AbstractAudioResource::isClip ( ) const

Returns: True if the audio resource is a clip

◆ isStream()

bool CeresEngine::AbstractAudioResource::isStream ( ) const

Returns: True if the audio resource is a stream

The documentation for this class was generated from the following file:

/Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Audio/AudioResource.hpp

Public Types

Public Member Functions