 |
Om
1.0.0
A universal framework for multimedia simulation
|
A class that contains information about a single playback instance for a sound player. More...
#include <omSoundPlayer.h>
Public Member Functions | |
| Instance () | |
| Create a new default playback instance without a valid sound resource. More... | |
| Instance (SoundInputStream *newStream) | |
| Create a new default playback instance with the specified sound stream. More... | |
| Instance (const SoundRegion ®ion) | |
| Create a new playback instance for the specified sound region. More... | |
Public Attributes | |
| SoundInputStream * | stream |
| A pointer to the sound stream that this instance uses for sound data. More... | |
| SoundFilter * | insert |
| A filter that should be used to process the audio for the instance. More... | |
| Time | start |
| The starting playback position in the sound resource of this instance. More... | |
| Time | length |
| The length of time to play from the sound stream. More... | |
| Time | fadeInTime |
| The length of time that should be used to fade in the sound stream to its full volume. More... | |
| Time | fadeOutTime |
| The length of time that should be used to fade out the sound stream from its full volume to silence. More... | |
| PanDirection | pan |
| The panning direction that should be used when playing this instance. More... | |
| Float | speed |
| A scale factor for the playback speed, where 1 is the normal speed. More... | |
| Float | gain |
| A linear gain factor for the sound from this playback instance. More... | |
| Float | priority |
| A value that indicates the priority for the playback instance. More... | |
| Size | loopCount |
| The number of times that the stream should be repeated after the first playback if looping is enabled. More... | |
| Index | userID |
| A user defined identifier for this playback instance. More... | |
| Bool | loop |
| A boolean value indicating whether or not looping is enabled for this instance. More... | |
A class that contains information about a single playback instance for a sound player.
|
inline |
Create a new default playback instance without a valid sound resource.
|
inline |
Create a new default playback instance with the specified sound stream.
|
inline |
Create a new playback instance for the specified sound region.
| SoundInputStream* om::sound::filters::SoundPlayer::Instance::stream |
A pointer to the sound stream that this instance uses for sound data.
| SoundFilter* om::sound::filters::SoundPlayer::Instance::insert |
A filter that should be used to process the audio for the instance.
| Time om::sound::filters::SoundPlayer::Instance::start |
The starting playback position in the sound resource of this instance.
| Time om::sound::filters::SoundPlayer::Instance::length |
The length of time to play from the sound stream.
A value of zero indicates the entire sound should be played.
| Time om::sound::filters::SoundPlayer::Instance::fadeInTime |
The length of time that should be used to fade in the sound stream to its full volume.
A value of zero indicates there is no fading performed.
| Time om::sound::filters::SoundPlayer::Instance::fadeOutTime |
The length of time that should be used to fade out the sound stream from its full volume to silence.
A value of zero indicates there is no fading performed.
| PanDirection om::sound::filters::SoundPlayer::Instance::pan |
The panning direction that should be used when playing this instance.
| Float om::sound::filters::SoundPlayer::Instance::speed |
A scale factor for the playback speed, where 1 is the normal speed.
| Float om::sound::filters::SoundPlayer::Instance::gain |
A linear gain factor for the sound from this playback instance.
| Float om::sound::filters::SoundPlayer::Instance::priority |
A value that indicates the priority for the playback instance.
| Size om::sound::filters::SoundPlayer::Instance::loopCount |
The number of times that the stream should be repeated after the first playback if looping is enabled.
A value of 0 indicates that the stream should be looped indefinitely.
| Index om::sound::filters::SoundPlayer::Instance::userID |
A user defined identifier for this playback instance.
| Bool om::sound::filters::SoundPlayer::Instance::loop |
A boolean value indicating whether or not looping is enabled for this instance.
1.8.11
