Murl Engine Lua Addon API  Version 1.0 beta
Murl.Graph.IAudible

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.


Table members

Methods


SetSampleFormat(sampleFormat)

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)

Parameters
sampleFormatThe internal sample format to use.
Returns
Boolean true if successful.

GetSampleFormat()

Get the sample format used for playback.

Murl.IEnums.SampleFormat GetSampleFormat()

Returns
Murl.IEnums.SampleFormat The sample format.

SetMaxNumberOfStreamBuffers(maxNumBuffers)

Set the maximum number of stream buffers used during playback.

Boolean SetMaxNumberOfStreamBuffers(Integer maxNumBuffers)

Parameters
maxNumBuffersThe maximum number of stream buffers.
Returns
Boolean true if successful.

GetMaxNumberOfStreamBuffers()

Get the maximum number of stream buffers used during playback

Integer GetMaxNumberOfStreamBuffers()

Returns
Integer The maximum number of stream buffers.

SetVolume(volume)

Set the playback volume.

Boolean SetVolume(Number volume)

Parameters
volumeThe playback volume in the range from 0.0 (silent) to 1.0 (full volume).
Returns
Boolean true if successful.

GetVolume()

Get the playback volume.

Number GetVolume()

Returns
Number The playback volume in the range from 0.0 (silent) to 1.0 (full volume).

SetReferenceDistance(referenceDistance)

Set the reference distance.

Boolean SetReferenceDistance(Number referenceDistance)

Parameters
referenceDistanceThe reference distance. See the IListener interface for details.
Returns
Boolean true if successful.

GetReferenceDistance()

Get the reference distance.

Number GetReferenceDistance()

Returns
Number The reference distance.

SetRolloffFactor(rolloffFactor)

Set the rolloff factor.

Boolean SetRolloffFactor(Number rolloffFactor)

Parameters
rolloffFactorThe rolloff factor. See the IListener interface for details.
Returns
Boolean true if successful.

GetRolloffFactor()

Get the rolloff factor.

Number GetRolloffFactor()

Returns
Number The rolloff factor.

SetMaxDistance(maxDistance)

Set the maximum distance.

Boolean SetMaxDistance(Number maxDistance)

Parameters
maxDistanceThe maximum distance. See the IListener interface for details.
Returns
Boolean true if successful.

GetMaxDistance()

Get the maximum distance.

Number GetMaxDistance()

Returns
Number The maximum distance.