Class CSdpFmtAttributeField

class CSdpFmtAttributeField : public CBase;

Description

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

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSdpFmtAttributeField - This class encapsulates the attribute field of the Session Description Protocol for media format/payload type level attributes

Members

Defined in CSdpFmtAttributeField:
Attribute(), CloneL(), DecodeL(), DecodeLC(), EncodeL(), Format(), NewL(), NewLC(), SetL(), Value(), operator==(), ~CSdpFmtAttributeField()

Inherited from CBase:
Delete(), Extension_(), operator new()

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

Description

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.

Return value

CSdpFmtAttributeField * a new instance.

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

Description

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.

Return value

CSdpFmtAttributeField * a new instance.

IMPORT_C ~CSdpFmtAttributeField();

Description

Deletes the resources held by the instance.

static IMPORT_C CSdpFmtAttributeField *DecodeL(const TDesC8 &aText);

Description

Constructs a new media format level attribute field.

Parameters

const TDesC8 &aText A string containing a correctly formatted field value terminated by a CRLF.

Return value

CSdpFmtAttributeField * a new instance.

static IMPORT_C CSdpFmtAttributeField *DecodeLC(const TDesC8 &aText);

Description

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.

Return value

CSdpFmtAttributeField * a new instance.

IMPORT_C void EncodeL(RWriteStream &aStream) const;

Description

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.

IMPORT_C CSdpFmtAttributeField *CloneL() const;

Description

Creates a new instance that is equal to the target.

Return value

CSdpFmtAttributeField * a new instance.

IMPORT_C TBool operator==(const CSdpFmtAttributeField &aObj) const;

Description

Compares this instance to another for equality.

Parameters

const CSdpFmtAttributeField &aObj The instance to compare to.

Return value

TBool ETrue if equal, EFalse if not.

IMPORT_C RStringF Attribute() const;

Description

Gets the attribute.

Return value

RStringF The attribute name. The name can be pre-defined name in the SDP string table or defined by the client.

IMPORT_C const TDesC8 &Format() const;

Description

Gets the format.

Return value

const TDesC8 & The format.

IMPORT_C const TDesC8 &Value() const;

Description

Gets the attribute value.

Return value

const TDesC8 & The value or an empty descriptor if there is no value part.

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

Description

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

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.

Leave codes

KErrSdpCodecMediaAttributeField if aAttribute is not rtpmap or fmtp attribute.