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

The IAudioSequence graph node interface.

An audio sequence represents a single instance of a playable sound object, that can be positioned within the virtual world space. It can reference any number of individual audio source nodes that can be seamlessly played back in the order they are specified through the node's Graph::IAudioSourceNodeTarget.

Use the interface's Graph::IPlayable base to query the total duration, and set or query endless looping.

Use the interface's Graph::IAudible base to access audio parameters like volume, sample format etc.

See Graph::IAudioSource for defining individual sound objects.


Table members

Inherited


Murl.Graph.IPlayable
Murl.Graph.IAudible

Methods


GetNodeInterface()

Get the constant Graph::INode interface. This method returns a constant pointer to the node's Graph::INode interface, to be able to query common node properties such as active state, visibility or ID.

Murl.Graph.INode GetNodeInterface()

Returns
Murl.Graph.INode The constant Graph::INode interface, or null if not available

GetTransformInterface()

Get the constant Graph::ITransform interface. This method returns a constant pointer to the node's Graph::ITransform interface, to be able to query the node's transformation matrix and depth order.

Murl.Graph.ITransform GetTransformInterface()

Returns
Murl.Graph.ITransform The constant Graph::ITransform interface, or null if not available

GetAudioSourceNodeTarget()

Get the constant Graph::IAudioSourceNodeTarget container. This method returns a constant pointer to the node's Graph::IAudioSourceNodeTarget container, which allows to query the audio sequence's referenced audio objects.

Murl.Graph.IGenericNodeTarget.GraphIAudioSource GetAudioSourceNodeTarget()

Returns
Murl.Graph.IGenericNodeTarget.GraphIAudioSource The constant Graph::IAudioSourceNodeTarget container, or null if not available

SetTimelineUnit(unit)

Set the timeline unit to respond to.

Boolean SetTimelineUnit(Integer unit)

Parameters
unitThe timeline unit in the range from 0 to IEnums::NUM_TIMELINE_UNITS-1.
Returns
Boolean true if successful.

GetTimelineUnit()

Get the timeline unit responding to.

Integer GetTimelineUnit()

Returns
Integer The timeline unit in the range from 0 to IEnums::NUM_TIMELINE_UNITS-1.