![]() |
Murl Engine API
Version 2018.3
|
Class handling the play state and volume of a Graph::ITimelineNode which is enclosing a Graph::IAudioSequenceNode node. More...
#include <murl_logic_graph_sound_object.h>
Class handling the play state and volume of a Graph::ITimelineNode which is enclosing a Graph::IAudioSequenceNode node.
e.g.
Public Member Functions | |
GraphSoundObject () | |
The default constructor. More... | |
GraphSoundObject (Real masterVolume) | |
Constructor taking a master volume. More... | |
virtual | ~GraphSoundObject () |
The destructor. | |
virtual Bool | Init (INodeObserver *nodeObserver, const Graph::IRoot *root, const String &timelinePath, const String &sequencePath, SInt32 index) |
Initialize the object. More... | |
virtual Bool | Init (INodeObserver *nodeObserver, Graph::INamespace *namespaceNode, const String &timelinePath, const String &sequencePath, SInt32 index) |
Initialize the object. More... | |
virtual Bool | DeInit () |
Deinitialize the object. More... | |
virtual Bool | StartPlaying (Real startTime=0) |
Start playing the sound. More... | |
virtual Bool | StartPlaying (Real startTime, Real endTime) |
Start playing the sound. More... | |
virtual Bool | IsPlaying () const |
Check if the sound is playing. More... | |
virtual Bool | PausePlaying () |
Pause playing the sound. More... | |
virtual Bool | ContinuePlaying () |
Continue playing the sound. More... | |
virtual Bool | StopPlaying () |
Stop playing the sound. More... | |
virtual void | SetVolume (Real volume) |
Set the sound volume. More... | |
virtual void | SetMasterVolume (Real volume) |
Set the master volume. More... | |
virtual Real | GetMasterVolume () const |
Get the master volume. More... | |
Static Public Member Functions | |
static GraphSoundObjectPtr | Create () |
Create a GraphSoundObject object. More... | |
static GraphSoundObjectPtr | Create (Real masterVolume) |
Create a GraphSoundObject object with a given master volume. More... | |
Public Attributes | |
TimelineNode | mTimelineNode |
The timeline node reference. More... | |
AudioSequenceNode | mAudioSequenceNode |
The audio sequence node reference. More... | |
|
inline |
The default constructor.
The default master volume is 1.0.
|
inline |
Constructor taking a master volume.
masterVolume | The master volume in range [0.0 .. 1.0]. |
|
inlinestatic |
Create a GraphSoundObject object.
The default master volume is 1.0.
|
inlinestatic |
Create a GraphSoundObject object with a given master volume.
masterVolume | The master volume in range [0.0 .. 1.0]. |
|
inlinevirtual |
Initialize the object.
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. |
|
inlinevirtual |
Initialize the object.
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. |
|
inlinevirtual |
Deinitialize the object.
Reimplemented in Murl::Logic::GraphSoundInstance.
Start playing the sound.
startTime | The start time in seconds. |
|
inlinevirtual |
Start playing the sound.
startTime | The start time in seconds. |
endTime | The end time in seconds. |
|
inlinevirtual |
Check if the sound is playing.
|
inlinevirtual |
Pause playing the sound.
|
inlinevirtual |
Continue playing the sound.
Continue if the sound is paused, otherwise start the sound.
|
inlinevirtual |
Stop playing the sound.
|
inlinevirtual |
Set the sound volume.
The sound volume is multiplied by the master volume.
volume | The volume in range [0.0 .. 1.0]. |
|
inlinevirtual |
Set the master volume.
volume | The master volume in range [0.0 .. 1.0]. |
|
inlinevirtual |
Get the master volume.
TimelineNode Murl::Logic::GraphSoundObject::mTimelineNode |
The timeline node reference.
AudioSequenceNode Murl::Logic::GraphSoundObject::mAudioSequenceNode |
The audio sequence node reference.