Audaspace
1.3.0
A high level audio library.
|
This sound represents sequenced entries to play a sound scene. More...
#include <Sequence.h>
Public Member Functions | |
Sequence (Specs specs, float fps, bool muted) | |
Creates a new sound scene. More... | |
Specs | getSpecs () |
Retrieves the audio output specification. More... | |
void | setSpecs (Specs specs) |
Sets the audio output specification. More... | |
float | getFPS () const |
Retrieves the scene's FPS. More... | |
void | setFPS (float fps) |
Sets the scene's FPS. More... | |
void | mute (bool muted) |
Sets the muting state of the scene. More... | |
bool | isMuted () const |
Retrieves the muting state of the scene. More... | |
float | getSpeedOfSound () const |
Retrieves the speed of sound. More... | |
void | setSpeedOfSound (float speed) |
Sets the speed of sound. More... | |
float | getDopplerFactor () const |
Retrieves the doppler factor. More... | |
void | setDopplerFactor (float factor) |
Sets the doppler factor. More... | |
DistanceModel | getDistanceModel () const |
Retrieves the distance model. More... | |
void | setDistanceModel (DistanceModel model) |
Sets the distance model. More... | |
AnimateableProperty * | getAnimProperty (AnimateablePropertyType type) |
Retrieves one of the animated properties of the sound. More... | |
std::shared_ptr< SequenceEntry > | add (std::shared_ptr< ISound > sound, float begin, float end, float skip) |
Adds a new entry to the scene. More... | |
void | remove (std::shared_ptr< SequenceEntry > entry) |
Removes an entry from the scene. More... | |
std::shared_ptr< IReader > | createQualityReader () |
Creates a new reader with high quality resampling. More... | |
virtual std::shared_ptr< IReader > | createReader () |
Creates a reader for playback of the sound source. More... | |
![]() | |
virtual | ~ISound () |
Destroys the sound. | |
Friends | |
class | SequenceReader |
This sound represents sequenced entries to play a sound scene.
Sequence::Sequence | ( | Specs | specs, |
float | fps, | ||
bool | muted | ||
) |
Creates a new sound scene.
specs | The output audio data specification. |
fps | The FPS of the scene. |
muted | Whether the whole scene is muted. |
std::shared_ptr<SequenceEntry> Sequence::add | ( | std::shared_ptr< ISound > | sound, |
float | begin, | ||
float | end, | ||
float | skip | ||
) |
Adds a new entry to the scene.
sound | The sound this entry should play. |
begin | The start time. |
end | The end time or a negative value if determined by the sound. |
skip | How much seconds should be skipped at the beginning. |
std::shared_ptr<IReader> Sequence::createQualityReader | ( | ) |
Creates a new reader with high quality resampling.
|
virtual |
AnimateableProperty* Sequence::getAnimProperty | ( | AnimateablePropertyType | type | ) |
Retrieves one of the animated properties of the sound.
type | Which animated property to retrieve. |
DistanceModel Sequence::getDistanceModel | ( | ) | const |
Retrieves the distance model.
float Sequence::getDopplerFactor | ( | ) | const |
Retrieves the doppler factor.
This value is a scaling factor for the velocity vectors of sources and listener which is used while calculating the doppler effect.
float Sequence::getFPS | ( | ) | const |
Retrieves the scene's FPS.
Specs Sequence::getSpecs | ( | ) |
Retrieves the audio output specification.
float Sequence::getSpeedOfSound | ( | ) | const |
Retrieves the speed of sound.
This value is needed for doppler effect calculation.
bool Sequence::isMuted | ( | ) | const |
Retrieves the muting state of the scene.
void Sequence::mute | ( | bool | muted | ) |
Sets the muting state of the scene.
muted | Whether the scene is muted. |
void Sequence::remove | ( | std::shared_ptr< SequenceEntry > | entry | ) |
Removes an entry from the scene.
entry | The entry to remove. |
void Sequence::setDistanceModel | ( | DistanceModel | model | ) |
Sets the distance model.
model | distance model. |
void Sequence::setDopplerFactor | ( | float | factor | ) |
Sets the doppler factor.
This value is a scaling factor for the velocity vectors of sources and listener which is used while calculating the doppler effect.
factor | The new doppler factor. |
void Sequence::setFPS | ( | float | fps | ) |
Sets the scene's FPS.
fps | The new FPS. |
void Sequence::setSpecs | ( | Specs | specs | ) |
Sets the audio output specification.
specs | The new specification. |
void Sequence::setSpeedOfSound | ( | float | speed | ) |
Sets the speed of sound.
This value is needed for doppler effect calculation.
speed | The new speed of sound. |