MIPSpeexEncoder Class Reference

Compress audio using the Speex codec. More...

#include <mipspeexencoder.h>

Inheritance diagram for MIPSpeexEncoder:

Collaboration diagram for MIPSpeexEncoder:

List of all members.

Public Types
enum	SpeexBandWidth { NarrowBand, WideBand, UltraWideBand }
	Used to select speex encoding type. More...
Public Member Functions
bool	init (SpeexBandWidth bandWidth=WideBand, int quality=10, int complexity=1, bool vad=true, bool dtx=false)
	Initialize the Speex encoding component.
bool	destroy ()
	Clean up the Speex encoder.

---

Detailed Description

Using this component, floating point mono raw audio messages and raw 16 bit raw audio messages can be compressed using the Speex codec. Messages generated by this component are encoded audio messages with subtype MIPENCODEDAUDIOMESSAGE_TYPE_SPEEX.

---

Member Enumeration Documentation

enum MIPSpeexEncoder::SpeexBandWidth

Enumerator:

NarrowBand	Narrow band mode (8000 Hz)
WideBand	Wide band mode (16000 Hz)
UltraWideBand	Ultra wide band mode (32000 Hz)

---

Member Function Documentation

bool MIPSpeexEncoder::destroy

(

)

bool MIPSpeexEncoder::init	(	SpeexBandWidth	bandWidth = WideBand,
		int	quality = 10,
		int	complexity = 1,
		bool	vad = true,
		bool	dtx = false
	)

This function initializes the Speex encoding component.

Parameters:

bandWidth	Selects the encoding type.
quality	Speex quality parameter.
complexity	Speex complexity parameter.
vad	Enable or disable voice activity detection.
dtx	Enable or disable discontinuous transmission.

---

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

• src/components/codec/mipspeexencoder.h