MIPRaw16bitAudioMessage Class Reference

Container for sixteen-bit raw audio data. More...

#include <miprawaudiomessage.h>

Inheritance diagram for MIPRaw16bitAudioMessage:

Collaboration diagram for MIPRaw16bitAudioMessage:

List of all members.

Public Types
enum	SampleEncoding
	Used in constructor to specify sample encoding. More...
Public Member Functions
	MIPRaw16bitAudioMessage (int sampRate, int numChannels, int numFrames, bool isSigned, SampleEncoding sampleEncoding, uint16_t *pFrames, bool deleteFrames)
	Creates a MIPRaw16bitAudioMessage instance.
uint16_t *	getFrames () const
	Returns the audio data.
void	setFrames (bool isSigned, SampleEncoding sampleEncoding, uint16_t *pFrames, bool deleteFrames)
	Stores audio data.
bool	isSigned () const
	Returns true if the stored data uses a signed encoding, false otherwise.
bool	isBigEndian () const
	Returns true if the stored data uses a big endian encoding, false otherwise.
bool	isLittleEndian () const
	Returns true if the stored data uses a little endian encoding, false otherwise.
bool	isNative () const
	Returns true if the stored data uses a native encoding, false otherwise.
SampleEncoding	getSampleEncoding () const
	Returns sample encoding.
MIPMediaMessage *	createCopy () const
	Create a copy of this message.

---

Detailed Description

---

Member Enumeration Documentation

enum MIPRaw16bitAudioMessage::SampleEncoding

---

Constructor & Destructor Documentation

MIPRaw16bitAudioMessage::MIPRaw16bitAudioMessage	(	int	sampRate,
		int	numChannels,
		int	numFrames,
		bool	isSigned,
		SampleEncoding	sampleEncoding,
		uint16_t *	pFrames,
		bool	deleteFrames
	)		[inline]

Creates a MIPRaw16bitAudioMessage instance.

Parameters:

sampRate	Sampling rate.
numChannels	Number of channels.
numFrames	Number of frames.
isSigned	Flag indicating if the samples are stored as signed or unsigned data.
sampleEncoding	Indicates if the samples are encoded in little endian, big endian or native format.
pFrames	The audio data.
deleteFrames	Flag indicating if the data contained in pFrames should be deleted when this message is destroyed or when the data is replaced.

---

Member Function Documentation

MIPMediaMessage* MIPRaw16bitAudioMessage::createCopy

(

)

const [inline, virtual]

Reimplemented from MIPMediaMessage.

References MIPMediaMessage::copyMediaInfoFrom(), MIPAudioMessage::getNumberOfChannels(), MIPAudioMessage::getNumberOfFrames(), and MIPAudioMessage::getSamplingRate().

uint16_t* MIPRaw16bitAudioMessage::getFrames

(

)

const [inline]

SampleEncoding MIPRaw16bitAudioMessage::getSampleEncoding

(

)

const [inline]

bool MIPRaw16bitAudioMessage::isBigEndian

(

)

const [inline]

bool MIPRaw16bitAudioMessage::isLittleEndian

(

)

const [inline]

bool MIPRaw16bitAudioMessage::isNative

(

)

const [inline]

bool MIPRaw16bitAudioMessage::isSigned

(

)

const [inline]

void MIPRaw16bitAudioMessage::setFrames	(	bool	isSigned,
		SampleEncoding	sampleEncoding,
		uint16_t *	pFrames,
		bool	deleteFrames
	)		[inline]

Stores audio data.

Parameters:

isSigned	Flag indicating if the samples are stored as signed or unsigned data.
sampleEncoding	Indicates if the samples are encoded in little endian, big endian or native format.
pFrames	The audio data.
deleteFrames	Flag indicating if the data contained in pFrames should be deleted when this message is destroyed or when the data is replaced.

References MIPMessage::setMessageSubtype().

---

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

• src/core/miprawaudiomessage.h