![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
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.
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.
Boolean SetSampleFormat(Murl.IEnums.SampleFormat sampleFormat)
sampleFormat | The internal sample format to use. |
Get the sample format used for playback.
Murl.IEnums.SampleFormat GetSampleFormat()
Set the maximum number of stream buffers used during playback.
Boolean SetMaxNumberOfStreamBuffers(Integer maxNumBuffers)
maxNumBuffers | The maximum number of stream buffers. |
Get the maximum number of stream buffers used during playback
Integer GetMaxNumberOfStreamBuffers()
Set the playback volume.
Boolean SetVolume(Number volume)
volume | The playback volume in the range from 0.0 (silent) to 1.0 (full volume). |
Get the playback volume.
Number GetVolume()
Set the reference distance.
Boolean SetReferenceDistance(Number referenceDistance)
referenceDistance | The reference distance. See the IListener interface for details. |
Get the reference distance.
Number GetReferenceDistance()
Set the rolloff factor.
Boolean SetRolloffFactor(Number rolloffFactor)
rolloffFactor | The rolloff factor. See the IListener interface for details. |
Get the rolloff factor.
Number GetRolloffFactor()
Set the maximum distance.
Boolean SetMaxDistance(Number maxDistance)
maxDistance | The maximum distance. See the IListener interface for details. |
Get the maximum distance.
Number GetMaxDistance()