MIPAudioMessage Class Reference

Base class for encoded and raw audio messages. More...

#include <mipaudiomessage.h>

Inheritance diagram for MIPAudioMessage:

Collaboration diagram for MIPAudioMessage:

List of all members.

Public Member Functions
int	getSamplingRate () const
	Returns the sampling rate.
int	getNumberOfFrames () const
	Returns the number of frames in the message.
int	getNumberOfChannels () const
	Returns the number of channels.
void	setSamplingRate (int sampRate)
	Stores the sampling rate.
void	setNumberOfFrames (int numFrames)
	Stores the number of frames.
void	setNumberOfChannels (int numChannels)
	Stores the number of channels.
void	copyAudioInfoFrom (MIPAudioMessage &msg)
	Copies the info stored in msg, including the MIPMediaMessage info.
Protected Member Functions
	MIPAudioMessage (bool isRaw, uint32_t msgSubtype, int sampRate, int channels, int frames)
	Constructor of the class.

---

Detailed Description

This class is the base class of both raw audio messages and encoded audio messages.

---

Constructor & Destructor Documentation

MIPAudioMessage::MIPAudioMessage	(	bool	isRaw,
		uint32_t	msgSubtype,
		int	sampRate,
		int	channels,
		int	frames
	)		[inline, protected]

Constructor of the class, meant to be used by subclasses.

Parameters:

isRaw	Flag indicating is the message is intended for raw audio samples or encoded audio.
msgSubtype	Subtype of the message.
sampRate	Sampling rate.
channels	The number of channels.
frames	The number of frames contained in the message.

---

Member Function Documentation

void MIPAudioMessage::copyAudioInfoFrom

(

MIPAudioMessage &

msg

)

[inline]

int MIPAudioMessage::getNumberOfChannels

(

)

const [inline]

Referenced by MIPRaw16bitAudioMessage::createCopy(), MIPRawU8AudioMessage::createCopy(), MIPRawFloatAudioMessage::createCopy(), and MIPEncodedAudioMessage::createCopy().

int MIPAudioMessage::getNumberOfFrames

(

)

const [inline]

Referenced by MIPRaw16bitAudioMessage::createCopy(), MIPRawU8AudioMessage::createCopy(), MIPRawFloatAudioMessage::createCopy(), and MIPEncodedAudioMessage::createCopy().

int MIPAudioMessage::getSamplingRate

(

)

const [inline]

Referenced by MIPRaw16bitAudioMessage::createCopy(), MIPRawU8AudioMessage::createCopy(), MIPRawFloatAudioMessage::createCopy(), and MIPEncodedAudioMessage::createCopy().

void MIPAudioMessage::setNumberOfChannels

(

int

numChannels

)

[inline]

References MIPMediaMessage::copyMediaInfoFrom().

void MIPAudioMessage::setNumberOfFrames

(

int

numFrames

)

[inline]

void MIPAudioMessage::setSamplingRate

(

int

sampRate

)

[inline]

---

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

• src/core/mipaudiomessage.h