This interface represents a playable sound object, which can reference a number of IBuffer objects to play back.
More...
#include <murl_audio_i_playable.h>
This interface represents a playable sound object, which can reference a number of IBuffer objects to play back.
Used internally by Graph::AudioSequence.
Inherited by Murl::Audio::Al11::Playable, and Murl::Audio::Dummy::Playable.
◆ GetObjectInterface() [1/2]
virtual IObject* Murl::Audio::IPlayable::GetObjectInterface |
( |
| ) |
|
|
pure virtual |
◆ GetObjectInterface() [2/2]
virtual const IObject* Murl::Audio::IPlayable::GetObjectInterface |
( |
| ) |
const |
|
pure virtual |
◆ Play()
virtual Bool Murl::Audio::IPlayable::Play |
( |
const Matrix & |
worldTransform, |
|
|
Double |
time |
|
) |
| |
|
pure virtual |
Trigger playback for a single frame.
- Parameters
-
worldTransform | The current transform of the object in 3D space. |
time | The current playback time. |
- Returns
- true if successful.
◆ Stop()
virtual Bool Murl::Audio::IPlayable::Stop |
( |
| ) |
|
|
pure virtual |
Stop playback.
- Returns
- true if successful.
◆ SetEndlessLoopEnabled()
virtual Bool Murl::Audio::IPlayable::SetEndlessLoopEnabled |
( |
Bool |
enabled | ) |
|
|
pure virtual |
Enable/disable endless looping.
- Parameters
-
enabled | If true, endless looping is enabled. |
- Returns
- true if successful.
◆ IsEndlessLoopEnabled()
virtual Bool Murl::Audio::IPlayable::IsEndlessLoopEnabled |
( |
| ) |
const |
|
pure virtual |
Check if endless looping is enabled.
- Returns
- true if endless looping is enabled.
◆ SetSampleFormat()
Set the desired output sample format.
- Parameters
-
- Returns
- true if successful.
◆ GetSampleFormat()
Get the output sample format.
- Returns
- The sample format.
◆ SetMaxNumberOfStreamBuffers()
virtual Bool Murl::Audio::IPlayable::SetMaxNumberOfStreamBuffers |
( |
UInt32 |
maxNumBuffers | ) |
|
|
pure virtual |
Set the maximum number of stream buffers used during playback.
- Parameters
-
maxNumBuffers | The maximum number of stream buffers. |
- Returns
- true if successful.
◆ GetMaxNumberOfStreamBuffers()
virtual UInt32 Murl::Audio::IPlayable::GetMaxNumberOfStreamBuffers |
( |
| ) |
const |
|
pure virtual |
Get the maximum number of stream buffers used during playback.
- Returns
- The maximum number of stream buffers.
◆ SetVolume()
virtual Bool Murl::Audio::IPlayable::SetVolume |
( |
Real |
volume | ) |
|
|
pure virtual |
Set the playable's actual volume.
- Parameters
-
volume | The playback volume. |
- Returns
- true if successful.
◆ GetVolume()
virtual Real Murl::Audio::IPlayable::GetVolume |
( |
| ) |
const |
|
pure virtual |
Get the playable's actual volume.
- Returns
- The playback volume.
◆ SetReferenceDistance()
virtual Bool Murl::Audio::IPlayable::SetReferenceDistance |
( |
Real |
referenceDistance | ) |
|
|
pure virtual |
Set the reference distance.
See Graph::IListener for details.
- Parameters
-
referenceDistance | The reference distance. |
- Returns
- true if successful.
◆ GetReferenceDistance()
virtual Real Murl::Audio::IPlayable::GetReferenceDistance |
( |
| ) |
const |
|
pure virtual |
Get the reference distance.
- Returns
- The reference distance.
◆ SetRolloffFactor()
virtual Bool Murl::Audio::IPlayable::SetRolloffFactor |
( |
Real |
rolloffFactor | ) |
|
|
pure virtual |
Set the rolloff factor.
See Graph::IListener for details.
- Parameters
-
rolloffFactor | The rolloff factor. |
- Returns
- true if successful.
◆ GetRolloffFactor()
virtual Real Murl::Audio::IPlayable::GetRolloffFactor |
( |
| ) |
const |
|
pure virtual |
Get the rolloff factor.
- Returns
- The rolloff factor.
◆ SetMaxDistance()
virtual Bool Murl::Audio::IPlayable::SetMaxDistance |
( |
Real |
maxDistance | ) |
|
|
pure virtual |
Set the maximum distance.
See Graph::IListener for details.
- Parameters
-
maxDistance | The maximum distance. |
- Returns
- true if successful.
◆ GetMaxDistance()
virtual Real Murl::Audio::IPlayable::GetMaxDistance |
( |
| ) |
const |
|
pure virtual |
Get the maximum distance.
- Returns
- The maximum distance.
◆ ClearBuffers()
virtual Bool Murl::Audio::IPlayable::ClearBuffers |
( |
| ) |
|
|
pure virtual |
Detach all buffers from the playable object.
- Returns
- true if successful.
◆ AddBuffer()
virtual Bool Murl::Audio::IPlayable::AddBuffer |
( |
IBuffer * |
buffer | ) |
|
|
pure virtual |
Attach a buffer to the playable object's buffer sequence.
- Parameters
-
- Returns
- true if successful.
◆ GetNumberOfBuffers()
virtual UInt32 Murl::Audio::IPlayable::GetNumberOfBuffers |
( |
| ) |
const |
|
pure virtual |
Get the number of currently attached buffer objects.
- Returns
- The number of buffers.
◆ GetBuffer()
virtual IBuffer* Murl::Audio::IPlayable::GetBuffer |
( |
UInt32 |
index | ) |
const |
|
pure virtual |
Get the buffer attached at a given index.
- Parameters
-
- Returns
- The buffer, or null if the index is out of range.
◆ GetBufferStartTime()
virtual Double Murl::Audio::IPlayable::GetBufferStartTime |
( |
UInt32 |
index | ) |
const |
|
pure virtual |
Get the actual start time of an attached buffer in the sequence.
- Parameters
-
- Returns
- The start time, or 0.0 if the index is out of range.
◆ HasDataToPlay()
virtual Bool Murl::Audio::IPlayable::HasDataToPlay |
( |
| ) |
const |
|
pure virtual |
Check if the playable actually has data to play back.
- Returns
- true if playback data is present.
The documentation for this interface was generated from the following file: