![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
Class handling the play state and volume of a Graph::ITimelineNode which is enclosing a Graph::IAudioSequenceNode node.
e.g.
Create a GraphSoundObject object. The default master volume is 1.0.
Murl.SharedPointer.LogicGraphSoundObject new()
Create a GraphSoundObject object with a given master volume.
Murl.SharedPointer.LogicGraphSoundObject new(Number masterVolume)
masterVolume | The master volume in range [0.0 .. 1.0]. |
Create a GraphSoundObject object. The default master volume is 1.0.
Murl.SharedPointer.LogicGraphSoundObject Create()
Create a GraphSoundObject object with a given master volume.
Murl.SharedPointer.LogicGraphSoundObject Create(Number masterVolume)
masterVolume | The master volume in range [0.0 .. 1.0]. |
Initialize the object.
Boolean Init(Murl.Logic.INodeObserver nodeObserver, Murl.Graph.INamespace namespaceNode, String timelinePath, String sequencePath, Integer index)
nodeObserver | The INodeObserver object. |
namespaceNode | The graph namespace node. |
timelinePath | The relative path to the graph timeline node instance. |
sequencePath | The relative path to the graph audio sequence node instance. |
index | The index of the instance. |
Initialize the object.
Boolean Init(Murl.Logic.INodeObserver nodeObserver, Murl.Graph.IRoot root, String timelinePath, String sequencePath, Integer index)
nodeObserver | The INodeObserver object. |
root | The graph root node. |
timelinePath | The full path to the graph timeline node instance. |
sequencePath | The full path to the graph audio sequence node instance. |
index | The index of the instance. |
Deinitialize the object.
Boolean DeInit()
Start playing the sound.
Boolean StartPlaying(Number startTime)
startTime | The start time in seconds. |
Start playing the sound.
Boolean StartPlaying(Number startTime, Number endTime)
startTime | The start time in seconds. |
endTime | The end time in seconds. |
Check if the sound is playing.
Boolean IsPlaying()
Pause playing the sound.
Boolean PausePlaying()
Continue playing the sound. Continue if the sound is paused, otherwise start the sound.
Boolean ContinuePlaying()
Stop playing the sound.
Boolean StopPlaying()
Set the sound volume. The sound volume is multiplied by the master volume.
SetVolume(Number volume)
volume | The volume in range [0.0 .. 1.0]. |
Set the master volume.
SetMasterVolume(Number volume)
volume | The master volume in range [0.0 .. 1.0]. |
Get the master volume.
Number GetMasterVolume()
The timeline node reference.
The audio sequence node reference.