Murl Engine API  Version 2018.3
Murl::Audio::IBuffer Interface Referenceabstract

The IBuffer audio object interface. More...

#include <murl_audio_i_buffer.h>

Detailed Description

The IBuffer audio object interface.

This interface represents an audio sample buffer with typical properties such as sample format and sample rate.

Used internally by Graph::AudioSource and Graph::AudioSequence.

Inherited by Murl::Audio::Al11::Buffer, and Murl::Audio::Dummy::Buffer.

Public Member Functions

virtual IObjectGetObjectInterface ()=0
 Get the mutable Audio::IObject interface. More...
 
virtual const IObjectGetObjectInterface () const =0
 Get the constant Audio::IObject interface. More...
 
virtual Bool SetType (IEnums::BufferType type)=0
 Set the buffer type (stream or static). More...
 
virtual IEnums::BufferType GetType () const =0
 Get the buffer type. More...
 
virtual Bool SetAccessMode (IEnums::BufferAccessMode mode)=0
 Set the access mode hint (read only or read/write). More...
 
virtual IEnums::BufferAccessMode GetAccessMode () const =0
 Get the access mode hint. More...
 
virtual Bool SetSampleFormat (IEnums::SampleFormat format)=0
 Set the desired output sample format. More...
 
virtual IEnums::SampleFormat GetSampleFormat () const =0
 Get the output sample format. More...
 
virtual Bool SetSampleRate (UInt32 sampleRate)=0
 Set the desired output sample rate. More...
 
virtual UInt32 GetSampleRate () const =0
 Get the output sample rate. More...
 
virtual Bool SetNumberOfSamples (UInt32 numberOfSamples)=0
 Set the total number of samples. More...
 
virtual UInt32 GetNumberOfSamples () const =0
 Get the total number of samples. More...
 
virtual Bool SetAudioStream (IAudioStream *stream)=0
 Set the audio stream source. More...
 
virtual IAudioStreamGetAudioStream () const =0
 Get the audio stream source. More...
 

Member Function Documentation

◆ GetObjectInterface() [1/2]

virtual IObject* Murl::Audio::IBuffer::GetObjectInterface ( )
pure virtual

Get the mutable Audio::IObject interface.

Returns
The IObject interface.

◆ GetObjectInterface() [2/2]

virtual const IObject* Murl::Audio::IBuffer::GetObjectInterface ( ) const
pure virtual

Get the constant Audio::IObject interface.

Returns
The IObject interface.

◆ SetType()

virtual Bool Murl::Audio::IBuffer::SetType ( IEnums::BufferType  type)
pure virtual

Set the buffer type (stream or static).

Parameters
typeThe buffer type.
Returns
true if successful.

◆ GetType()

virtual IEnums::BufferType Murl::Audio::IBuffer::GetType ( ) const
pure virtual

Get the buffer type.

Returns
The buffer type.

◆ SetAccessMode()

virtual Bool Murl::Audio::IBuffer::SetAccessMode ( IEnums::BufferAccessMode  mode)
pure virtual

Set the access mode hint (read only or read/write).

Parameters
modeThe access mode.
Returns
true if successful.

◆ GetAccessMode()

virtual IEnums::BufferAccessMode Murl::Audio::IBuffer::GetAccessMode ( ) const
pure virtual

Get the access mode hint.

Returns
The access mode.

◆ SetSampleFormat()

virtual Bool Murl::Audio::IBuffer::SetSampleFormat ( IEnums::SampleFormat  format)
pure virtual

Set the desired output sample format.

Parameters
formatThe sample format.
Returns
true if successful.

◆ GetSampleFormat()

virtual IEnums::SampleFormat Murl::Audio::IBuffer::GetSampleFormat ( ) const
pure virtual

Get the output sample format.

Returns
The sample format.

◆ SetSampleRate()

virtual Bool Murl::Audio::IBuffer::SetSampleRate ( UInt32  sampleRate)
pure virtual

Set the desired output sample rate.

Parameters
sampleRateThe sample rate in Hertz.
Returns
true if successful.

◆ GetSampleRate()

virtual UInt32 Murl::Audio::IBuffer::GetSampleRate ( ) const
pure virtual

Get the output sample rate.

Returns
The sample rate in Hertz.

◆ SetNumberOfSamples()

virtual Bool Murl::Audio::IBuffer::SetNumberOfSamples ( UInt32  numberOfSamples)
pure virtual

Set the total number of samples.

Parameters
numberOfSamplesThe number of samples.
Returns
true if successful.

◆ GetNumberOfSamples()

virtual UInt32 Murl::Audio::IBuffer::GetNumberOfSamples ( ) const
pure virtual

Get the total number of samples.

Returns
The number of samples.

◆ SetAudioStream()

virtual Bool Murl::Audio::IBuffer::SetAudioStream ( IAudioStream stream)
pure virtual

Set the audio stream source.

Parameters
streamThe audio stream.
Returns
true if successful.

◆ GetAudioStream()

virtual IAudioStream* Murl::Audio::IBuffer::GetAudioStream ( ) const
pure virtual

Get the audio stream source.

Returns
The audio stream.

The documentation for this interface was generated from the following file: