Collapse all Symbian^3 Product Developer Library

CSdpFmtAttributeField Class Reference

class CSdpFmtAttributeField : public CBase

This class encapsulates the attribute field of the Session Description Protocol for media format/payload type level attributes. Media and session level attributes are supported by the CSdpAttributeField class.

The normative reference for correct formatting and values is draft-ietf-mmusic-sdp-new-14 unless specified otherwise in member documentation. The implementation supports this normative reference, but does not enforce it fully.

sdpcodec.lib

Inherits from

CSdpFmtAttributeField
- CBase

Public Member Functions
	~CSdpFmtAttributeField()
IMPORT_C RStringF	Attribute()
const CSdpAttributeField *	AttributeField()
IMPORT_C CSdpFmtAttributeField *	CloneL()
IMPORT_C CSdpFmtAttributeField *	DecodeL(const TDesC8 &)
IMPORT_C CSdpFmtAttributeField *	DecodeLC(const TDesC8 &)
IMPORT_C void	EncodeL(RWriteStream &)
void	ExternalizeL(RWriteStream &)
IMPORT_C const TDesC8 &	Format()
CSdpFmtAttributeField *	InternalizeL(RReadStream &)
IMPORT_C CSdpFmtAttributeField *	NewL(RStringF, const TDesC8 &, const TDesC8 &)
IMPORT_C CSdpFmtAttributeField *	NewLC(RStringF, const TDesC8 &, const TDesC8 &)
IMPORT_C void	SetL(RStringF, const TDesC8 &, const TDesC8 &)
IMPORT_C const TDesC8 &	Value()
IMPORT_C TBool	operator==(const CSdpFmtAttributeField &)

Private Member Functions
	CSdpFmtAttributeField()
void	ConstructL(const TDesC8 &)
void	ConstructL(RStringF, const TDesC8 &, const TDesC8 &)
void	DecodeFormatL(const TDesC8 &)
void	DoInternalizeL(RReadStream &)
void	FormatValueParamsL(CSdpAttributeField *)
void	__DbgTestInvariant()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CSdpAttributeField *	iAttributeField
TPtrC8	iFormat
RStringPool	iPool
TPtrC8	iValuePart

Constructor & Destructor Documentation

CSdpFmtAttributeField()

CSdpFmtAttributeField

(

)

[private]

Constructor

~CSdpFmtAttributeField()

IMPORT_C

~CSdpFmtAttributeField

(

)

Deletes the resources held by the instance.

Member Functions Documentation

Attribute()

IMPORT_C RStringF

Attribute

(

)

const

Gets the attribute.

AttributeField()

const CSdpAttributeField *

AttributeField

(

)

const

Returns attribute field

CloneL()

IMPORT_C CSdpFmtAttributeField *

CloneL

(

)

const

Creates a new instance that is equal to the target.

ConstructL(const TDesC8 &)

void

ConstructL

(

const TDesC8 &

aText

)

[private]

Second phase construction

Parameters

const TDesC8 & aText

A string containing a correctly formatted field value terminated by a CRLF.

ConstructL(RStringF, const TDesC8 &, const TDesC8 &)

void	ConstructL	(	RStringF	aAttribute,
			const TDesC8 &	aFormat,
			const TDesC8 &	aValue
		)	[private]

Second phase construction

Parameters

RStringF aAttribute	The attribute from the pre-defined SDP string table or defined by the user
const TDesC8 & aFormat	A valid format/payload identifier used in the format list of the media description.
const TDesC8 & aValue	A valid attribute value or an empty descriptor to omit the value part.

DecodeFormatL(const TDesC8 &)

void

DecodeFormatL

(

const TDesC8 &

aText

)

[private]

Decode format parameter from string

Parameters

const TDesC8 & aText

A text includeing format parameter.

DecodeL(const TDesC8 &)

IMPORT_C CSdpFmtAttributeField *

DecodeL

(

const TDesC8 &

aText

)

[static]

Constructs a new media format level attribute field.

Parameters

const TDesC8 & aText

A string containing a correctly formatted field value terminated by a CRLF.

DecodeLC(const TDesC8 &)

IMPORT_C CSdpFmtAttributeField *

DecodeLC

(

const TDesC8 &

aText

)

[static]

Constructs a new media format level attribute field and adds the pointer to the cleanup stack.

Parameters

const TDesC8 & aText

A string containing a correctly formatted field value terminated by a CRLF.

DoInternalizeL(RReadStream &)

void

DoInternalizeL

(

RReadStream &

aStream

)

[private]

Creates object from the stream data. Does the "2nd phase construction" of internalization.

Parameters

RReadStream & aStream

Stream where the object's state will be read

EncodeL(RWriteStream &)

IMPORT_C void

EncodeL

(

RWriteStream &

aStream

)

const

Outputs the field formatted according to SDP syntax and including the terminating CRLF.

Parameters

RWriteStream & aStream

Stream used for output. On return the stream includes correctly formatted attribute field.

ExternalizeL(RWriteStream &)

void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalizes the object to stream

Parameters

RWriteStream & aStream

Stream where the object's state will be stored

Format()

IMPORT_C const TDesC8 &

Format

(

)

const

Gets the format.

FormatValueParamsL(CSdpAttributeField *)

void

FormatValueParamsL

(

CSdpAttributeField *

aField

)

[private]

Formats value parameters

Parameters

CSdpAttributeField * aField

Attribute field object

InternalizeL(RReadStream &)

CSdpFmtAttributeField *

InternalizeL

(

RReadStream &

aStream

)

[static]

Creates object from the stream data

Parameters

RReadStream & aStream

Stream where the object's state will be read

NewL(RStringF, const TDesC8 &, const TDesC8 &)

IMPORT_C CSdpFmtAttributeField *	NewL	(	RStringF	aAttribute,
			const TDesC8 &	aFormat,
			const TDesC8 &	aValue
		)	[static]

Constructs a new media level format attribute field.

Parameters

RStringF aAttribute	The attribute name. It can be a pre-defined name in the SDP string pool or defined by the client.
const TDesC8 & aFormat	A valid format/payload identifier used in the format list of the media description.
const TDesC8 & aValue	A valid attribute value or an empty descriptor to omit the value part.

NewLC(RStringF, const TDesC8 &, const TDesC8 &)

IMPORT_C CSdpFmtAttributeField *	NewLC	(	RStringF	aAttribute,
			const TDesC8 &	aFormat,
			const TDesC8 &	aValue
		)	[static]

Constructs a new media format level attribute field and adds the pointer to the cleanup stack.

Parameters

RStringF aAttribute	The attribute name. It can be a pre-defined name in the SDP string pool or defined by the client.
const TDesC8 & aFormat	A valid format/payload identifier used in the format list of the media description.
const TDesC8 & aValue	A valid attribute value or an empty descriptor to omit the value part.

SetL(RStringF, const TDesC8 &, const TDesC8 &)

IMPORT_C void	SetL	(	RStringF	aAttribute,
			const TDesC8 &	aFormat,
			const TDesC8 &	aValue
		)

Sets the attribute, format/payload type and attribute value.

leave: KErrSdpCodecMediaAttributeField if aAttribute is not rtpmap or fmtp attribute.

Parameters

RStringF aAttribute	A valid attribute name. It can be a pre-defined name in the SDP string pool or defined by the client.
const TDesC8 & aFormat	A valid format/payload identifier used in the formatlist of the media description.
const TDesC8 & aValue	A valid attribute value or an empty descriptor to omit the value part.

Value()

IMPORT_C const TDesC8 &

Value

(

)

const

Gets the attribute value.

__DbgTestInvariant()

void

__DbgTestInvariant

(

)

const [private]

operator==(const CSdpFmtAttributeField &)

IMPORT_C TBool

operator==

(

const CSdpFmtAttributeField &

aObj

)

const

Compares this instance to another for equality.

Parameters

const CSdpFmtAttributeField & aObj

The instance to compare to.

Member Data Documentation

CSdpAttributeField * iAttributeField

CSdpAttributeField *

iAttributeField

[private]

TPtrC8 iFormat

TPtrC8

iFormat

[private]

Pointer to the format part

RStringPool iPool

RStringPool

iPool

[private]

TPtrC8 iValuePart

TPtrC8

iValuePart

[private]

Pointer to the format parameters