S60 3rd Edition API Reference: CSdpFmtAttributeField Class Reference

CSdpFmtAttributeField Class Reference

API published in: S60 2nd Ed

Link against: sdpcodec.lib

Capability Information

Required Capabilities

None

Exceptions

#include <sdpfmtattributefield.h>

Detailed Description

PublishedAll
Released
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.


Public Member Functions

IMPORT_C ~CSdpFmtAttributeField ()
 Deletes the resources held by the instance.
IMPORT_C void EncodeL (RWriteStream &aStream) const
 Outputs the field formatted according to SDP syntax and including the terminating CRLF.
IMPORT_C CSdpFmtAttributeField * CloneL () const
 Creates a new instance that is equal to the target.
IMPORT_C TBool operator== (const CSdpFmtAttributeField &aObj) const
 Compares this instance to another for equality.
IMPORT_C RStringF Attribute () const
 Gets the attribute.
IMPORT_C const TDesC8 & Format () const
 Gets the format.
IMPORT_C const TDesC8 & Value () const
 Gets the attribute value.
IMPORT_C void SetL (RStringF aAttribute, const TDesC8 &aFormat, const TDesC8 &aValue)
 Sets the attribute, format/payload type and attribute value.
void ExternalizeL (RWriteStream &aStream) const
 Externalizes the object to stream.
const CSdpAttributeField * AttributeField () const
 Returns attribute field.

Static Public Member Functions

static IMPORT_C CSdpFmtAttributeField * DecodeL (const TDesC8 &aText)
 Constructs a new media format level attribute field.
static IMPORT_C CSdpFmtAttributeField * DecodeLC (const TDesC8 &aText)
 Constructs a new media format level attribute field and adds the pointer to the cleanup stack.
static IMPORT_C CSdpFmtAttributeField * NewL (RStringF aAttribute, const TDesC8 &aFormat, const TDesC8 &aValue)
 Constructs a new media level format attribute field.
static IMPORT_C CSdpFmtAttributeField * NewLC (RStringF aAttribute, const TDesC8 &aFormat, const TDesC8 &aValue)
 Constructs a new media format level attribute field and adds the pointer to the cleanup stack.
static CSdpFmtAttributeField * InternalizeL (RReadStream &aStream)
 Creates object from the stream data.

Constructor & Destructor Documentation

IMPORT_C CSdpFmtAttributeField::~CSdpFmtAttributeField (   ) 
 

Deletes the resources held by the instance.

Member Function Documentation

IMPORT_C RStringF CSdpFmtAttributeField::Attribute (   )  const
 

Gets the attribute.

Returns:
The attribute name. The name can be pre-defined name in the SDP string table or defined by the client.
const CSdpAttributeField* CSdpFmtAttributeField::AttributeField (   )  const
 

Returns attribute field.

Returns:
Attribute field
IMPORT_C CSdpFmtAttributeField* CSdpFmtAttributeField::CloneL (   )  const
 

Creates a new instance that is equal to the target.

Returns:
a new instance.
static IMPORT_C CSdpFmtAttributeField* CSdpFmtAttributeField::DecodeL ( const TDesC8 &  aText  )  [static]
 

Constructs a new media format level attribute field.

Parameters:
aText A string containing a correctly formatted field value terminated by a CRLF.
Returns:
a new instance.
static IMPORT_C CSdpFmtAttributeField* CSdpFmtAttributeField::DecodeLC ( const TDesC8 &  aText  )  [static]
 

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

Parameters:
aText A string containing a correctly formatted field value terminated by a CRLF.
Returns:
a new instance.
IMPORT_C void CSdpFmtAttributeField::EncodeL ( RWriteStream &  aStream  )  const
 

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

Parameters:
aStream Stream used for output. On return the stream includes correctly formatted attribute field.
void CSdpFmtAttributeField::ExternalizeL ( RWriteStream &  aStream  )  const
 

Externalizes the object to stream.

Parameters:
aStream Stream where the object's state will be stored
IMPORT_C const TDesC8& CSdpFmtAttributeField::Format (   )  const
 

Gets the format.

Returns:
The format.
static CSdpFmtAttributeField* CSdpFmtAttributeField::InternalizeL ( RReadStream &  aStream  )  [static]
 

Creates object from the stream data.

Parameters:
aStream Stream where the object's state will be read
Returns:
Initialized object
static IMPORT_C CSdpFmtAttributeField* CSdpFmtAttributeField::NewL ( RStringF  aAttribute,
const TDesC8 &  aFormat,
const TDesC8 &  aValue
)  [static]
 

Constructs a new media level format attribute field.

Parameters:
aAttribute The attribute name. It can be a pre-defined name in the SDP string pool or defined by the client.
aFormat A valid format/payload identifier used in the format list of the media description.
aValue A valid attribute value or an empty descriptor to omit the value part.
Returns:
a new instance.
static IMPORT_C CSdpFmtAttributeField* 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:
aAttribute The attribute name. It can be a pre-defined name in the SDP string pool or defined by the client.
aFormat A valid format/payload identifier used in the format list of the media description.
aValue A valid attribute value or an empty descriptor to omit the value part.
Returns:
a new instance.
IMPORT_C TBool CSdpFmtAttributeField::operator== ( const CSdpFmtAttributeField &  aObj  )  const
 

Compares this instance to another for equality.

Parameters:
aObj The instance to compare to.
Returns:
ETrue if equal, EFalse if not.
IMPORT_C void CSdpFmtAttributeField::SetL ( RStringF  aAttribute,
const TDesC8 &  aFormat,
const TDesC8 &  aValue
) 
 

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

Parameters:
aAttribute A valid attribute name. It can be a pre-defined name in the SDP string pool or defined by the client.
aFormat A valid format/payload identifier used in the formatlist of the media description.
aValue A valid attribute value or an empty descriptor to omit the value part.
Leave:
KErrSdpCodecMediaAttributeField if aAttribute is not rtpmap or fmtp attribute.
IMPORT_C const TDesC8& CSdpFmtAttributeField::Value (   )  const
 

Gets the attribute value.

Returns:
The value or an empty descriptor if there is no value part.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top