resip::SdpContents::Session::Codec Class Reference

parameters for a specific codec are stored in this class. More...

#include <SdpContents.hxx>

Public Types
typedef HashMap< int, Codec >	CodecMap

Public Member Functions
	Codec ()
	Codec (const Data &name, unsigned long rate, const Data &parameters=Data::Empty, const Data &encodingParameters=Data::Empty)
	full constructor for a Codec.
	Codec (const Data &name, int payloadType, int rate=8000)
	constructor for a Codec
	Codec (const Codec &rhs)
Codec &	operator= (const Codec &codec)
void	parse (ParseBuffer &pb, const SdpContents::Session::Medium &medium, int payLoadType)
void	assignFormatParameters (const SdpContents::Session::Medium &medium)
const Data &	getName () const
	returns the name of the codec.
int	getRate () const
	returns the name of the codec.
int	payloadType () const
	returns the RTP payload type associated with this codec.
int &	payloadType ()
	returns the RTP payload type associated with this codec.
const Data &	parameters () const
	returns the parameters associated with this codec
Data &	parameters ()
	returns the parameters associated with this codec
const Data &	encodingParameters () const
	returns the encoding parameters associated with this codec
Data &	encodingParameters ()
	returns the encoding parameters associated with this codec

Static Public Member Functions
static CodecMap &	getStaticCodecs ()

Static Public Attributes
static const Codec	ULaw_8000
static const Codec	GSM_8000
static const Codec	G723_8000
static const Codec	ALaw_8000
static const Codec	G722_8000
static const Codec	CN
static const Codec	G729_8000
static const Codec	H263
static const Codec	TelephoneEvent
static const Codec	FrfDialedDigit

Friends
bool	operator== (const Codec &, const Codec &)
EncodeStream &	operator<< (EncodeStream &, const Codec &)

Detailed Description

parameters for a specific codec are stored in this class.

Definition at line 79 of file SdpContents.hxx.

Member Typedef Documentation

CodecMap

typedef HashMap<int, Codec> resip::SdpContents::Session::Codec::CodecMap

Definition at line 162 of file SdpContents.hxx.

Constructor & Destructor Documentation

Codec() [1/4]

resip::SdpContents::Session::Codec::Codec ( )

inline

Definition at line 82 of file SdpContents.hxx.

Codec() [2/4]

Codec::Codec	(	const Data &	name,
		unsigned long	rate,
		const Data &	parameters = Data::Empty,
		const Data &	encodingParameters = Data::Empty
	)

full constructor for a Codec.

This constructor allows a rate and optional parameters to be specified.

Parameters

name	a string identifying the codec
rate	number of samples/sec
parameters	optional list of parameters for the codec
encodingParameters	optional encoding parameters for the codec

Definition at line 2071 of file SdpContents.cxx.

Codec() [3/4]

Codec::Codec	(	const Data &	name,
		int	payloadType,
		int	rate = 8000
	)

constructor for a Codec

This constructor allows for payload type and rate parameters to be specified.

Parameters

name	a string identifying the codec
payloadType	RTP payload type to associate with this codec
rate	sample rate of this codec

Definition at line 2092 of file SdpContents.cxx.

Codec() [4/4]

Codec::Codec

(

const Codec &

rhs

)

Definition at line 2083 of file SdpContents.cxx.

Member Function Documentation

assignFormatParameters()

void Codec::assignFormatParameters

(

const SdpContents::Session::Medium &

medium

)

Definition at line 2139 of file SdpContents.cxx.

encodingParameters() [1/2]

Data & resip::SdpContents::Session::Codec::encodingParameters ( )

inline

returns the encoding parameters associated with this codec

Returns

encoding parameters

Definition at line 148 of file SdpContents.hxx.

encodingParameters() [2/2]

const Data & resip::SdpContents::Session::Codec::encodingParameters ( ) const

inline

returns the encoding parameters associated with this codec

Returns

encoding parameters

Definition at line 144 of file SdpContents.hxx.

getName()

const Data & Codec::getName

(

)

const

returns the name of the codec.

Returns

name of the codec

Definition at line 2168 of file SdpContents.cxx.

getRate()

int Codec::getRate

(

)

const

returns the name of the codec.

Returns

name of the codec

Definition at line 2174 of file SdpContents.cxx.

getStaticCodecs()

Codec::CodecMap & Codec::getStaticCodecs ( )

static

Definition at line 2179 of file SdpContents.cxx.

operator=()

Codec & Codec::operator=

(

const Codec &

codec

)

Definition at line 2100 of file SdpContents.cxx.

parameters() [1/2]

Data & resip::SdpContents::Session::Codec::parameters ( )

inline

returns the parameters associated with this codec

Returns

codec parameters

Definition at line 139 of file SdpContents.hxx.

parameters() [2/2]

const Data & resip::SdpContents::Session::Codec::parameters ( ) const

inline

returns the parameters associated with this codec

Returns

codec parameters

Definition at line 135 of file SdpContents.hxx.

parse()

void Codec::parse	(	ParseBuffer &	pb,
		const SdpContents::Session::Medium &	medium,
		int	payLoadType
	)

Definition at line 2114 of file SdpContents.cxx.

payloadType() [1/2]

int & resip::SdpContents::Session::Codec::payloadType ( )

inline

returns the RTP payload type associated with this codec.

Returns

RTP payload type

Definition at line 130 of file SdpContents.hxx.

payloadType() [2/2]

int resip::SdpContents::Session::Codec::payloadType ( ) const

inline

returns the RTP payload type associated with this codec.

Returns

RTP payload type

Definition at line 126 of file SdpContents.hxx.

Friends And Related Symbol Documentation

operator<<

EncodeStream & operator<< ( EncodeStream &  , const Codec &    )

friend

operator==

bool operator== ( const Codec &  , const Codec &    )

friend

Member Data Documentation

ALaw_8000

const Codec Codec::ALaw_8000

static

Definition at line 153 of file SdpContents.hxx.

CN

const Codec Codec::CN

static

Definition at line 155 of file SdpContents.hxx.

FrfDialedDigit

const Codec Codec::FrfDialedDigit

static

Definition at line 160 of file SdpContents.hxx.

G722_8000

const Codec Codec::G722_8000

static

Definition at line 154 of file SdpContents.hxx.

G723_8000

const Codec Codec::G723_8000

static

Definition at line 152 of file SdpContents.hxx.

G729_8000

const Codec Codec::G729_8000

static

Definition at line 156 of file SdpContents.hxx.

GSM_8000

const Codec Codec::GSM_8000

static

Definition at line 151 of file SdpContents.hxx.

H263

const Codec Codec::H263

static

Definition at line 157 of file SdpContents.hxx.

TelephoneEvent

const Codec Codec::TelephoneEvent

static

Definition at line 159 of file SdpContents.hxx.

ULaw_8000

const Codec Codec::ULaw_8000

static

Definition at line 150 of file SdpContents.hxx.

---

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

• resip/stack/SdpContents.hxx
• resip/stack/SdpContents.cxx