The IAudible property interface. More...

#include "murl_graph_i_audible.h"

Inheritance diagram for Murl::Graph::IAudible:

Public Member Functions

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 IAudible property interface.

This interface provides setting and retrieving common properties of an audible object (i.e. a sound), including volume, reference and maximum distance, and rolloff factor. For a detailed description of the distance model, see the IListener interface.

Animation controllers may call the SetVolume() method when volume keys are present in a given Resource::IAnimation.

Member Function Documentation

◆ SetSampleFormat()

virtual Bool Murl::Graph::IAudible::SetSampleFormat ( IEnums::SampleFormat  sampleFormat)
pure virtual

Set the sample format used for playback.

This method sets the internal sample format used for playback. Usually, the native sample format of a given sound object is used by default, but can be overridden by any other value.

Parameters
sampleFormatThe internal sample format to use.
Returns
true if successful.

◆ GetSampleFormat()

virtual IEnums::SampleFormat Murl::Graph::IAudible::GetSampleFormat ( ) const
pure virtual

Get the sample format used for playback.

Returns
The sample format.

◆ SetMaxNumberOfStreamBuffers()

virtual Bool Murl::Graph::IAudible::SetMaxNumberOfStreamBuffers ( UInt32  maxNumBuffers)
pure virtual

Set the maximum number of stream buffers used during playback.

Parameters
maxNumBuffersThe maximum number of stream buffers.
Returns
true if successful.

◆ GetMaxNumberOfStreamBuffers()

virtual UInt32 Murl::Graph::IAudible::GetMaxNumberOfStreamBuffers ( ) const
pure virtual

Get the maximum number of stream buffers used during playback.

Returns
The maximum number of stream buffers.

◆ SetVolume()

virtual Bool Murl::Graph::IAudible::SetVolume ( Real  volume)
pure virtual

Set the playback volume.

Parameters
volumeThe playback volume in the range from 0.0 (silent) to 1.0 (full volume).
Returns
true if successful.

Referenced by Murl::Logic::GraphSoundObject::SetVolume().

◆ GetVolume()

virtual Real Murl::Graph::IAudible::GetVolume ( ) const
pure virtual

Get the playback volume.

Returns
The playback volume in the range from 0.0 (silent) to 1.0 (full volume).

◆ SetReferenceDistance()

virtual Bool Murl::Graph::IAudible::SetReferenceDistance ( Real  referenceDistance)
pure virtual

Set the reference distance.

Parameters
referenceDistanceThe reference distance. See the IListener interface for details.
Returns
true if successful.

◆ GetReferenceDistance()

virtual Real Murl::Graph::IAudible::GetReferenceDistance ( ) const
pure virtual

Get the reference distance.

Returns
The reference distance.

◆ SetRolloffFactor()

virtual Bool Murl::Graph::IAudible::SetRolloffFactor ( Real  rolloffFactor)
pure virtual

Set the rolloff factor.

Parameters
rolloffFactorThe rolloff factor. See the IListener interface for details.
Returns
true if successful.

◆ GetRolloffFactor()

virtual Real Murl::Graph::IAudible::GetRolloffFactor ( ) const
pure virtual

Get the rolloff factor.

Returns
The rolloff factor.

◆ SetMaxDistance()

virtual Bool Murl::Graph::IAudible::SetMaxDistance ( Real  maxDistance)
pure virtual

Set the maximum distance.

Parameters
maxDistanceThe maximum distance. See the IListener interface for details.
Returns
true if successful.

◆ GetMaxDistance()

virtual Real Murl::Graph::IAudible::GetMaxDistance ( ) const
pure virtual

Get the maximum distance.

Returns
The maximum distance.

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


Copyright © 2011-2018 Spraylight GmbH.