xn::AudioMetaData Class ReferenceMeta-Data Objects (Frame Objects)

#include <XnCppWrapper.h>

Inheritance diagram for xn::AudioMetaData:

[legend]

List of all members.

Public Member Functions
	XN_PRAGMA_START_DISABLED_WARNING_SECTION (XN_UNALIGNED_ADDRESS_WARNING_ID)
	AudioMetaData ()
void	InitFrom (const AudioMetaData &other)
XnUInt8	NumberOfChannels () const
XnUInt8 &	NumberOfChannels ()
XnUInt32	SampleRate () const
XnUInt32 &	SampleRate ()
XnUInt16	BitsPerSample () const
XnUInt16 &	BitsPerSample ()
const XnAudioMetaData *	GetUnderlying () const
XnAudioMetaData *	GetUnderlying ()
Public Attributes
	XN_PRAGMA_STOP_DISABLED_WARNING_SECTION

---

Detailed Description

For saving the audio data from the xn::AudioGenerator node. This saved metadata object provides fast and easy access to the AudioGenerator node's data and configuration information.

---

Constructor & Destructor Documentation

xn::AudioMetaData::AudioMetaData

(

)

[inline]

---

Member Function Documentation

XnUInt16 xn::AudioMetaData::BitsPerSample

(

)

const [inline]

Gets the number of bits per channel in a sample. This is a packet configuration setting associated with the saved audio metadata object.

XnUInt16& xn::AudioMetaData::BitsPerSample

(

)

[inline]

Gets the number of bits per channel in a sample. This is a packet configuration setting associated with the saved audio metadata object.

const XnAudioMetaData* xn::AudioMetaData::GetUnderlying

(

)

const [inline]

Gets the C object that is wrapped by this object.

Reimplemented from xn::OutputMetaData.

XnAudioMetaData* xn::AudioMetaData::GetUnderlying

(

)

[inline]

Gets the C object that is wrapped by this object.

Reimplemented from xn::OutputMetaData.

void xn::AudioMetaData::InitFrom

(

const AudioMetaData &

other

)

[inline]

Shallow-Copies an AudioMetaData object.

Parameters:

[in]

other

source object.

Remarks:

Note that the data buffer is not copied, and that both object will point to the same buffer.

XnUInt8 xn::AudioMetaData::NumberOfChannels

(

)

const [inline]

Gets the number of channels in each sample. This is a packet configuration setting associated with the saved audio metadata object.

XnUInt8& xn::AudioMetaData::NumberOfChannels

(

)

[inline]

Gets the number of channels in each sample. This is a packet configuration setting associated with the saved audio metadata object.

XnUInt32 xn::AudioMetaData::SampleRate

(

)

const [inline]

Gets the rate at which the audio interface was sampled. This is a packet configuration setting associated with the saved audio metadata object.

XnUInt32& xn::AudioMetaData::SampleRate

(

)

[inline]

Gets the rate at which the audio interface was sampled. This is a packet configuration setting associated with the saved audio metadata object.

xn::AudioMetaData::XN_PRAGMA_START_DISABLED_WARNING_SECTION

(

XN_UNALIGNED_ADDRESS_WARNING_ID

)

---

Member Data Documentation

xn::AudioMetaData::XN_PRAGMA_STOP_DISABLED_WARNING_SECTION

---

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

• XnCppWrapper.h