Murl Engine Lua Addon API  Version 1.0 beta
Murl.Resource.IAudio

The IAudio resource object interface.


Table members

Methods


GetNumberOfStreams()

Get the number of individual audio streams.

Integer GetNumberOfStreams()

Returns
Integer The number of streams.

GetSampleRate(streamIndex)

Get the audio stream's sample rate.

Integer GetSampleRate(Integer streamIndex)

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
Returns
Integer The sample rate in Hertz.

GetNumberOfSamples(streamIndex)

Get the audio stream's total number of samples.

Integer GetNumberOfSamples(Integer streamIndex)

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
Returns
Integer The number of samples.

GetSampleFormat(streamIndex)

Get the audio stream's original (preferred) sample format.

Murl.IEnums.SampleFormat GetSampleFormat(Integer streamIndex)

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
Returns
Murl.IEnums.SampleFormat The sample format.

GetAudioStreamFormat(streamIndex)

Get the audio stream's actual format.

Murl.IEnums.AudioStreamFormat GetAudioStreamFormat(Integer streamIndex)

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
Returns
Murl.IEnums.AudioStreamFormat The stream format.

CreateStream(streamIndex)

Create an IAudioStream object from the resource, with default sample format.

Murl.IAudioStream CreateStream(Integer streamIndex)

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
Returns
Murl.IAudioStream The newly created stream object, or null if failed.

CreateStream(streamIndex, sampleFormat)

Create an IAudioStream object from the resource, with given sample format.

Murl.IAudioStream CreateStream(Integer streamIndex, Murl.IEnums.SampleFormat sampleFormat)

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
sampleFormatThe desired output sample format.
Returns
Murl.IAudioStream The newly created stream object, or null if failed.