![]() |
Murl Engine API
Version 2018.3
|
The IAudible property interface. More...
#include <murl_graph_i_audible.h>
The IAudible property interface.
This interface provides setting and retrieving common properties of an audible object (i.e. a sound), including volume, reference and maximum distance, and rolloff factor. For a detailed description of the distance model, see the IListener interface.
Animation controllers may call the SetVolume() method when volume keys are present in a given Resource::IAnimation.
Public Member Functions | |
virtual Bool | SetSampleFormat (IEnums::SampleFormat sampleFormat)=0 |
Set the sample format used for playback. More... | |
virtual IEnums::SampleFormat | GetSampleFormat () const =0 |
Get the sample format used for playback. More... | |
virtual Bool | SetMaxNumberOfStreamBuffers (UInt32 maxNumBuffers)=0 |
Set the maximum number of stream buffers used during playback. More... | |
virtual UInt32 | GetMaxNumberOfStreamBuffers () const =0 |
Get the maximum number of stream buffers used during playback. More... | |
virtual Bool | SetVolume (Real volume)=0 |
Set the playback volume. More... | |
virtual Real | GetVolume () const =0 |
Get the playback volume. More... | |
virtual Bool | SetReferenceDistance (Real referenceDistance)=0 |
Set the reference distance. More... | |
virtual Real | GetReferenceDistance () const =0 |
Get the reference distance. More... | |
virtual Bool | SetRolloffFactor (Real rolloffFactor)=0 |
Set the rolloff factor. More... | |
virtual Real | GetRolloffFactor () const =0 |
Get the rolloff factor. More... | |
virtual Bool | SetMaxDistance (Real maxDistance)=0 |
Set the maximum distance. More... | |
virtual Real | GetMaxDistance () const =0 |
Get the maximum distance. More... | |
|
pure virtual |
Set the sample format used for playback.
This method sets the internal sample format used for playback. Usually, the native sample format of a given sound object is used by default, but can be overridden by any other value.
sampleFormat | The internal sample format to use. |
|
pure virtual |
Get the sample format used for playback.
|
pure virtual |
Set the maximum number of stream buffers used during playback.
maxNumBuffers | The maximum number of stream buffers. |
|
pure virtual |
Get the maximum number of stream buffers used during playback.
Set the playback volume.
volume | The playback volume in the range from 0.0 (silent) to 1.0 (full volume). |
|
pure virtual |
Get the playback volume.
Set the reference distance.
referenceDistance | The reference distance. See the IListener interface for details. |
|
pure virtual |
Get the reference distance.
Set the rolloff factor.
rolloffFactor | The rolloff factor. See the IListener interface for details. |
|
pure virtual |
Get the rolloff factor.
Set the maximum distance.
maxDistance | The maximum distance. See the IListener interface for details. |
|
pure virtual |
Get the maximum distance.