Murl::Graph::IAudioSequence Interface Referenceabstract

The IAudioSequence graph node interface. More...

#include "murl_graph_i_audio_sequence.h"

Inheritance diagram for Murl::Graph::IAudioSequence:

Public Member Functions

virtual INodeGetNodeInterface ()=0
 Get the mutable Graph::INode interface. More...
 
virtual const INodeGetNodeInterface () const =0
 Get the constant Graph::INode interface. More...
 
virtual ITransformGetTransformInterface ()=0
 Get the mutable Graph::ITransform interface. More...
 
virtual const ITransformGetTransformInterface () const =0
 Get the constant Graph::ITransform interface. More...
 
virtual IAudioSourceNodeTargetGetAudioSourceNodeTarget ()=0
 Get the mutable Graph::IAudioSourceNodeTarget container. More...
 
virtual const IAudioSourceNodeTargetGetAudioSourceNodeTarget () const =0
 Get the constant Graph::IAudioSourceNodeTarget container. More...
 
- Public Member Functions inherited from Murl::Graph::IPlayable
virtual Bool SetEndlessLoopEnabled (Bool enabled)=0
 Enable/disable endless looping. More...
 
virtual Bool IsEndlessLoopEnabled () const =0
 Check if endless looping is enabled. More...
 
virtual Bool SetTimelineStallingEnabled (Bool enabled)=0
 Enable/disable timeline stalling. More...
 
virtual Bool IsTimelineStallingEnabled () const =0
 Check if timeline stalling is enabled. More...
 
virtual Double GetTotalDuration () const =0
 Get the total duration of the playable. More...
 
- Public Member Functions inherited from Murl::Graph::IAudible
virtual Bool SetSampleFormat (IEnums::SampleFormat sampleFormat)=0
 Set the sample format used for playback. More...
 
virtual IEnums::SampleFormat GetSampleFormat () const =0
 Get the sample format used for playback. More...
 
virtual Bool SetMaxNumberOfStreamBuffers (UInt32 maxNumBuffers)=0
 Set the maximum number of stream buffers used during playback. More...
 
virtual UInt32 GetMaxNumberOfStreamBuffers () const =0
 Get the maximum number of stream buffers used during playback. More...
 
virtual Bool SetVolume (Real volume)=0
 Set the playback volume. More...
 
virtual Real GetVolume () const =0
 Get the playback volume. More...
 
virtual Bool SetReferenceDistance (Real referenceDistance)=0
 Set the reference distance. More...
 
virtual Real GetReferenceDistance () const =0
 Get the reference distance. More...
 
virtual Bool SetRolloffFactor (Real rolloffFactor)=0
 Set the rolloff factor. More...
 
virtual Real GetRolloffFactor () const =0
 Get the rolloff factor. More...
 
virtual Bool SetMaxDistance (Real maxDistance)=0
 Set the maximum distance. More...
 
virtual Real GetMaxDistance () const =0
 Get the maximum distance. More...
 

Detailed Description

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.

Member Function Documentation

◆ GetNodeInterface() [1/2]

virtual INode* Murl::Graph::IAudioSequence::GetNodeInterface ( )
pure virtual

Get the mutable Graph::INode interface.

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

Returns
The mutable Graph::INode interface, or null if not available

◆ GetNodeInterface() [2/2]

virtual const INode* Murl::Graph::IAudioSequence::GetNodeInterface ( ) const
pure virtual

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.

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

◆ GetTransformInterface() [1/2]

virtual ITransform* Murl::Graph::IAudioSequence::GetTransformInterface ( )
pure virtual

Get the mutable Graph::ITransform interface.

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

Returns
The mutable Graph::ITransform interface, or null if not available

◆ GetTransformInterface() [2/2]

virtual const ITransform* Murl::Graph::IAudioSequence::GetTransformInterface ( ) const
pure virtual

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.

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

◆ GetAudioSourceNodeTarget() [1/2]

virtual IAudioSourceNodeTarget* Murl::Graph::IAudioSequence::GetAudioSourceNodeTarget ( )
pure virtual

Get the mutable Graph::IAudioSourceNodeTarget container.

This method returns a mutable pointer to the node's Graph::IAudioSourceNodeTarget container, which allows to add, remove or query the audio sequence's referenced audio objects.

Returns
The mutable Graph::IAudioSourceNodeTarget container, or null if not available

◆ GetAudioSourceNodeTarget() [2/2]

virtual const IAudioSourceNodeTarget* Murl::Graph::IAudioSequence::GetAudioSourceNodeTarget ( ) const
pure virtual

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.

Returns
The constant Graph::IAudioSourceNodeTarget container, or null if not available

The documentation for this interface was generated from the following file:
  • murl_graph_i_audio_sequence.h


Copyright © 2011-2018 Spraylight GmbH.