Class CSdpBandwidthField

class CSdpBandwidthField : public CBase;

Description

This class encapsulates the bandwidth field of the Session Description Protocol.

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

• CSdpBandwidthField - This class encapsulates the bandwidth field of the Session Description Protocol

Members

Defined in CSdpBandwidthField:
CloneL(), DecodeL(), DecodeLC(), EncodeL(), Modifier(), NewL(), NewLC(), SetModifier(), SetValue(), Value(), operator==(), ~CSdpBandwidthField()

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

static IMPORT_C CSdpBandwidthField *NewL(RStringF aModifier, TUint32 aValue);

Description

Constructs a new bandwidth field.

Parameters

RStringF aModifier Bandwidth modifier. TUint32 aValue Bandwidth value.

Return value

CSdpBandwidthField * a new instance.

static IMPORT_C CSdpBandwidthField *NewLC(RStringF aModifier, TUint32 aValue);

Description

Constructs a new bandwidth field and adds the pointer to the cleanup stack.

Parameters

RStringF aModifier Bandwidth modifier. TUint32 aValue Bandwidth value.

Return value

CSdpBandwidthField * a new instance.

IMPORT_C ~CSdpBandwidthField();

Description

Deletes the resources held by the instance.

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

Description

Constructs a new bandwidth field.

Parameters

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

Return value

CSdpBandwidthField * a new instance.

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

Description

Constructs a new bandwidth 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

CSdpBandwidthField * 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 bandwidth field.

IMPORT_C CSdpBandwidthField *CloneL() const;

Description

Creates a new instance that is equal to the target.

Return value

CSdpBandwidthField * a new instance.

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

Description

Compares this instance to another for equality.

Parameters

const CSdpBandwidthField &aObj The instance to compare to.

Return value

TBool ETrue if equal, EFalse if not.

IMPORT_C RStringF Modifier() const;

Description

Gets the bandwidth modifier.

Return value

RStringF The modifier that can be pre-defined in the SDP string table or defined by the user.

IMPORT_C void SetModifier(RStringF aModifier);

Description

Sets the bandwidth modifier.

Parameters

RStringF aModifier A valid bandwidth modifier name.

IMPORT_C TUint32 Value() const;

Description

Gets the bandwidth value.

Return value

TUint32 The value.

IMPORT_C void SetValue(TUint32 aValue);

Description

Sets the bandwidth value.

Parameters

TUint32 aValue The Value.