AudioObjectInterface Class Reference

#include <audioobject.h>

Inheritance diagram for AudioObjectInterface:

Public Member Functions
MAXON_METHOD Result< void >	Init (Int channelCount, Int bitsPerChannel, Float sampleRate, Int sampleCount, const TimeValue &length, const Block< const Char > &data)
MAXON_METHOD Int	GetChannelCount () const
MAXON_METHOD Int	GetBitsPerChannel () const
MAXON_METHOD Float	GetSampleRate () const
MAXON_METHOD Int	GetSampleCount () const
MAXON_METHOD TimeValue	GetLength () const
MAXON_METHOD Block< const Char >	GetDataPtr () const

Private Member Functions
	MAXON_INTERFACE (AudioObjectInterface, MAXON_REFERENCE_NORMAL, "net.maxon.image.interface.audioobject")

Member Function Documentation

MAXON_INTERFACE()

MAXON_INTERFACE ( AudioObjectInterface  , MAXON_REFERENCE_NORMAL  , "net.maxon.image.interface.audioobject"    )

private

Init()

MAXON_METHOD Result<void> Init	(	Int	channelCount,
		Int	bitsPerChannel,
		Float	sampleRate,
		Int	sampleCount,
		const TimeValue &	length,
		const Block< const Char > &	data
	)

Initializes the object with some sound data.

Parameters

[in]	channelCount	Number of sound channels to set.
[in]	bitsPerChannel	Bits per channel (e.g. 16).
[in]	sampleRate	Sample Rate.
[in]	sampleCount	Number of Samples.
[in]	length	Sound length in Time units.
[in]	data	Block with the sound data.

Returns

OK on success.

GetChannelCount()

MAXON_METHOD Int GetChannelCount

(

)

const

Return the number of channels.

GetBitsPerChannel()

MAXON_METHOD Int GetBitsPerChannel

(

)

const

Return the number of bits per channel.

GetSampleRate()

MAXON_METHOD Float GetSampleRate

(

)

const

Return the sample rate in Hz.

GetSampleCount()

MAXON_METHOD Int GetSampleCount

(

)

const

Return the duration/length of the sound in samples.

GetLength()

MAXON_METHOD TimeValue GetLength

(

)

const

Return the length as BaseTime.

GetDataPtr()

MAXON_METHOD Block<const Char> GetDataPtr

(

)

const

Read only data buffer access.