S60 3rd Edition API Reference: TSdpRtpmapValue Class Reference

TSdpRtpmapValue Class Reference

API published in: S60 2nd Ed

Link against: sdpcodec.lib

Capability Information

Required Capabilities

None

Exceptions


#include <sdprtpmapvalue.h>

Detailed Description

PublishedAll
Released
Utility class for manipulating the value of an rtpmap-attribute.

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.


Public Member Functions

IMPORT_C TSdpRtpmapValue (const TPtrC8 &aEncodingName, const TPtrC8 &aClockrate, const TPtrC8 &aEncodingParameters)
 Initializes the instance to refer to the given rtpmap components.
IMPORT_C HBufC8 * EncodeL () const
 Outputs the attribute value formatted according to SDP syntax.

Static Public Member Functions

static IMPORT_C TSdpRtpmapValue DecodeL (const TDesC8 &aText)
 Tries to parse a string as an rtpmap attribute value up to the end of the string or CRLF, whichever comes first, and set pointers to the components found.

Data Fields

TPtrC8 iEncName
 Encoding name part of an rtpmap value.
TPtrC8 iClockrate
 Clockrate part of an rtpmap value.
TPtrC8 iEncParams
 Encoding parameters part of an rtpmap value.

Constructor & Destructor Documentation

IMPORT_C TSdpRtpmapValue::TSdpRtpmapValue const TPtrC8 &  aEncodingName,
const TPtrC8 &  aClockrate,
const TPtrC8 &  aEncodingParameters
 

Initializes the instance to refer to the given rtpmap components.

The parameters must stay in scope as long as this instance exists. Otherwise, the member variables of this class will point to a released memory.

Parameters:
aEncodingName Valid rtpmap encoding name value.
aClockrate Valid rtpmap clockrate value.
aEncodingParameters Valid rtpmap encoding parameter list.

Member Function Documentation

static IMPORT_C TSdpRtpmapValue TSdpRtpmapValue::DecodeL const TDesC8 &  aText  )  [static]
 

Tries to parse a string as an rtpmap attribute value up to the end of the string or CRLF, whichever comes first, and set pointers to the components found.

The parameter must stay in scope as long as this instance exists. Otherwise, the member variables of this class will point to a released memory.

Parameters:
aText String containing the value of an rtpmap attribute.
Returns:
a new instance
Leave:
KErrArgument if parsing fails.
IMPORT_C HBufC8* TSdpRtpmapValue::EncodeL  )  const
 

Outputs the attribute value formatted according to SDP syntax.

The field terminating CRLF is not included in the output. When constructing CSdpFmtAttributeField, return value of this function can be used as aValue in CSdpFmtAttributeField::NewL (RStringF aAttribute, const TDesC8& aFormat, const TDesC8& aValue) function.

Returns:
Encoded value. Ovnership of buffer is changed to caller.

Field Documentation

TPtrC8 TSdpRtpmapValue::iClockrate
 

Clockrate part of an rtpmap value.

TPtrC8 TSdpRtpmapValue::iEncName
 

Encoding name part of an rtpmap value.

TPtrC8 TSdpRtpmapValue::iEncParams
 

Encoding parameters part of an rtpmap value.


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

Copyright © Nokia Corporation 2001-2007
Back to top