The IAudio resource object interface. More...

#include "murl_resource_i_audio.h"

Inheritance diagram for Murl::Resource::IAudio:

Classes

struct  Iff
 IFF file specific structs. More...
 

Public Member Functions

virtual IObjectGetObjectInterface ()=0
 Get the mutable Resource::IObject interface. More...
 
virtual const IObjectGetObjectInterface () const =0
 Get the constant Resource::IObject interface. More...
 
virtual UInt32 GetNumberOfStreams () const =0
 Get the number of individual audio streams. More...
 
virtual UInt32 GetSampleRate (UInt32 streamIndex) const =0
 Get the audio stream's sample rate. More...
 
virtual UInt32 GetNumberOfSamples (UInt32 streamIndex) const =0
 Get the audio stream's total number of samples. More...
 
virtual IEnums::SampleFormat GetSampleFormat (UInt32 streamIndex) const =0
 Get the audio stream's original (preferred) sample format. More...
 
virtual IEnums::AudioStreamFormat GetAudioStreamFormat (UInt32 streamIndex) const =0
 Get the audio stream's actual format. More...
 
virtual IAudioStreamCreateStream (UInt32 streamIndex) const =0
 Create an IAudioStream object from the resource, with default sample format. More...
 
virtual IAudioStreamCreateStream (UInt32 streamIndex, IEnums::SampleFormat sampleFormat) const =0
 Create an IAudioStream object from the resource, with given sample format. More...
 

Detailed Description

The IAudio resource object interface.

Member Function Documentation

◆ GetObjectInterface() [1/2]

virtual IObject* Murl::Resource::IAudio::GetObjectInterface ( )
pure virtual

Get the mutable Resource::IObject interface.

Returns
The IObject interface.

◆ GetObjectInterface() [2/2]

virtual const IObject* Murl::Resource::IAudio::GetObjectInterface ( ) const
pure virtual

Get the constant Resource::IObject interface.

Returns
The IObject interface.

◆ GetNumberOfStreams()

virtual UInt32 Murl::Resource::IAudio::GetNumberOfStreams ( ) const
pure virtual

Get the number of individual audio streams.

Returns
The number of streams.

◆ GetSampleRate()

virtual UInt32 Murl::Resource::IAudio::GetSampleRate ( UInt32  streamIndex) const
pure virtual

Get the audio stream's sample rate.

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
Returns
The sample rate in Hertz.

◆ GetNumberOfSamples()

virtual UInt32 Murl::Resource::IAudio::GetNumberOfSamples ( UInt32  streamIndex) const
pure virtual

Get the audio stream's total number of samples.

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
Returns
The number of samples.

◆ GetSampleFormat()

virtual IEnums::SampleFormat Murl::Resource::IAudio::GetSampleFormat ( UInt32  streamIndex) const
pure virtual

Get the audio stream's original (preferred) sample format.

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
Returns
The sample format.

◆ GetAudioStreamFormat()

virtual IEnums::AudioStreamFormat Murl::Resource::IAudio::GetAudioStreamFormat ( UInt32  streamIndex) const
pure virtual

Get the audio stream's actual format.

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
Returns
The stream format.

◆ CreateStream() [1/2]

virtual IAudioStream* Murl::Resource::IAudio::CreateStream ( UInt32  streamIndex) const
pure virtual

Create an IAudioStream object from the resource, with default sample format.

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
Returns
The newly created stream object, or null if failed.

◆ CreateStream() [2/2]

virtual IAudioStream* Murl::Resource::IAudio::CreateStream ( UInt32  streamIndex,
IEnums::SampleFormat  sampleFormat 
) const
pure virtual

Create an IAudioStream object from the resource, with given sample format.

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
sampleFormatThe desired output sample format.
Returns
The newly created stream object, or null if failed.

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


Copyright © 2011-2018 Spraylight GmbH.