Parameters for an audio session. More...

#include <mipaudiosession.h>

Public Types
enum	CompressionType { ULaw, ALaw, LPC, GSM, Speex, L16Mono }
	Used to select compression/encoding type. More...
enum	SpeexBandWidth { NarrowBand, WideBand, UltraWideBand }
	If Speex compression is used, this is sed to select speex encoding type. More...
Public Member Functions
unsigned int	getInputDeviceID () const
	Returns the ID of the input device (only used on Win32; default: WAVE_MAPPER)
unsigned int	getOutputDeviceID () const
	Returns the ID of the output device (only used on Win32; default: WAVE_MAPPER)
std::string	getInputDeviceName () const
	Returns the name of the input device (not used on Win32/WinCE; default: /dev/dsp).
std::string	getOutputDeviceName () const
	Returns the name of the output device (not used on Win32/WinCE; default: /dev/dsp).
bool	getUseHighPriority () const
	Returns `true` if the audio threads will receive high priority (only used on Win32/WinCE; default: false).
uint16_t	getPortbase () const
	Returns the RTP portbase (default: 5000).
bool	getAcceptOwnPackets () const
	Returns `true` if own packets will be accepted (default: `false`).
CompressionType	getCompressionType () const
	Returns the requested compression/encoding type (default: U-law).
SpeexBandWidth	getSpeexEncoding () const
	Returns the Speex mode (default: WideBand).
uint8_t	getSpeexIncomingPayloadType () const
	Incoming packets with this payload type will be interpreted as Speex packets.
uint8_t	getSpeexOutgoingPayloadType () const
	This payload type will be set on outgoing Speex packets.
int	getInputMultiplier () const
	Returns the size of the input sampling interval, in units of 20ms.
int	getOutputMultiplier () const
	Returns the size of the output sampling interval, in units of 20ms.
bool	getDisableInterChainTimer () const
	Returns a flag indicating if inter-chain timing is disabled.
void	setInputDevice (unsigned int ID)
	Sets the ID of the input device (only used on Win32/WinCE).
void	setOutputDevice (unsigned int ID)
	Sets the ID of the output device (only used on Win32/WinCE).
void	setInputDevice (const std::string &devName)
	Sets the name of the input device (not used on Win32/WinCE).
void	setOutputDevice (const std::string &devName)
	Sets the name of the input device (not used on Win32/WinCE).
void	setUseHighPriority (bool f)
	Sets a flag indicating if high priority audio threads should be used (only used on Win32/WinCE).
void	setPortbase (uint16_t p)
	Sets the RTP portbase.
void	setAcceptOwnPackets (bool v)
	Sets a flag indicating if own packets should be accepted.
void	setCompressionType (CompressionType t)
	Sets the compression/encoding type.
void	setSpeexEncoding (SpeexBandWidth b)
	Sets the Speex encoding mode.
void	setSpeexIncomingPayloadType (uint8_t pt)
	This will interpret incoming packets with payload type `pt` as Speex packets.
void	setSpeexOutgoingPayloadType (uint8_t pt)
	Sets the payload type for outgoing Speex packets.
void	setInputMultiplier (int m)
	Sets the input sampling interval to `m` * 20ms.
void	setOutputMultiplier (int m)
	Sets the output sampling interval to `m` * 20ms.
void	setDisableInterChainTimer (bool f)
	This can be used to always disable inter-chain timing.

Detailed Description

Member Enumeration Documentation

enum MIPAudioSessionParams::CompressionType

Enumerator:

ULaw	U-law encoding.
ALaw	A-law encoding.
LPC	LPC compression.
GSM	GSM 06.10 compression.
Speex	Speex compression.
L16Mono	L16 mono.

enum MIPAudioSessionParams::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 MIPAudioSessionParams::getAcceptOwnPackets ( ) const [inline]

CompressionType MIPAudioSessionParams::getCompressionType ( ) const [inline]

bool MIPAudioSessionParams::getDisableInterChainTimer ( ) const [inline]

Returns a flag indicating if inter-chain timing is disabled. See setDisableInterChainTimer for more information.

std::string MIPAudioSessionParams::getInputDeviceName ( ) const [inline]

int MIPAudioSessionParams::getInputMultiplier ( ) const [inline]

std::string MIPAudioSessionParams::getOutputDeviceName ( ) const [inline]

int MIPAudioSessionParams::getOutputMultiplier ( ) const [inline]

uint16_t MIPAudioSessionParams::getPortbase ( ) const [inline]

SpeexBandWidth MIPAudioSessionParams::getSpeexEncoding ( ) const [inline]

uint8_t MIPAudioSessionParams::getSpeexIncomingPayloadType ( ) const [inline]

uint8_t MIPAudioSessionParams::getSpeexOutgoingPayloadType ( ) const [inline]

bool MIPAudioSessionParams::getUseHighPriority ( ) const [inline]

void MIPAudioSessionParams::setAcceptOwnPackets ( bool v ) [inline]

void MIPAudioSessionParams::setCompressionType ( CompressionType t ) [inline]

void MIPAudioSessionParams::setDisableInterChainTimer ( bool f ) [inline]

This can be used to always disable inter-chain timing. If two chains are used, one for recording/transmission and another for reception/playback, it may be possible to use the timing component of the recording chain to drive the playback chain. By default, this is turned on (if possible). Using this flag, it can be turned off entirely, and a simple timing component will then control the output chain.

void MIPAudioSessionParams::setInputDevice ( const std::string & devName ) [inline]

void MIPAudioSessionParams::setInputDevice ( unsigned int ID ) [inline]

void MIPAudioSessionParams::setInputMultiplier ( int m ) [inline]

void MIPAudioSessionParams::setOutputDevice ( unsigned int ID ) [inline]

void MIPAudioSessionParams::setOutputDevice ( const std::string & devName ) [inline]

void MIPAudioSessionParams::setOutputMultiplier ( int m ) [inline]

void MIPAudioSessionParams::setPortbase ( uint16_t p ) [inline]

void MIPAudioSessionParams::setSpeexEncoding ( SpeexBandWidth b ) [inline]

void MIPAudioSessionParams::setSpeexIncomingPayloadType ( uint8_t pt ) [inline]

void MIPAudioSessionParams::setSpeexOutgoingPayloadType ( uint8_t pt ) [inline]

void MIPAudioSessionParams::setUseHighPriority ( bool f ) [inline]

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

src/sessions/mipaudiosession.h

MIPAudioSessionParams Class Reference

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation