Class CSdpRepeatField

class CSdpRepeatField : public CBase;

Description

This class encapsulates the repeat times 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

• CSdpRepeatField - This class encapsulates the repeat times field of the Session Description Protocol

Members

Defined in CSdpRepeatField:
ActiveDuration(), CloneL(), DecodeL(), DecodeLC(), EncodeL(), NewL(), NewLC(), RepeatInterval(), SetActiveDuration(), SetRepeatIntervalL(), SetTimeOffsetsL(), TimeOffsets(), operator==(), ~CSdpRepeatField()

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

static IMPORT_C CSdpRepeatField *NewL(const TSdpTypedTime aRepeatInterval, const TSdpTypedTime aActiveDuration, const RArray< TSdpTypedTime > &aOffsets);

Description

Constructs a new repeat times field.

Parameters

const TSdpTypedTime aRepeatInterval Repeat interval value greater than zero. const TSdpTypedTime aActiveDuration Active duration. const RArray< TSdpTypedTime > &aOffsets At least one time offset.

Return value

CSdpRepeatField * a new instance.

static IMPORT_C CSdpRepeatField *NewLC(const TSdpTypedTime aRepeatInterval, const TSdpTypedTime aActiveDuration, const RArray< TSdpTypedTime > &aOffsets);

Description

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

Parameters

const TSdpTypedTime aRepeatInterval Repeat interval value greater than zero. const TSdpTypedTime aActiveDuration Active duration. const RArray< TSdpTypedTime > &aOffsets At least one time offset.

Return value

CSdpRepeatField * a new instance.

IMPORT_C ~CSdpRepeatField();

Description

Deletes the resources held by the instance.

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

Description

Constructs a new repeat times field.

Parameters

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

Return value

CSdpRepeatField * a new instance.

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

Description

Constructs a new repeat times 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

CSdpRepeatField * 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 repeat field.

IMPORT_C CSdpRepeatField *CloneL() const;

Description

Creates a new instance that is equal to the target.

Return value

CSdpRepeatField * a new instance.

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

Description

Compares this instance to another for equality.

Parameters

const CSdpRepeatField &aObj The instance to compare to.

Return value

TBool ETrue if equal, EFalse if not.

IMPORT_C const TSdpTypedTime RepeatInterval() const;

Description

Gets the repeat interval.

Return value

const TSdpTypedTime The repeat interval.

IMPORT_C void SetRepeatIntervalL(const TSdpTypedTime aValue);

Description

Sets the repeat interval.

Parameters

const TSdpTypedTime aValue Repeat interval value greater than zero.

Leave codes

KErrSdpCodecRepeatField if aValue is not positive integer value.

IMPORT_C const TSdpTypedTime ActiveDuration() const;

Description

Gets the active duration..

Return value

const TSdpTypedTime The active duration.

IMPORT_C void SetActiveDuration(const TSdpTypedTime aValue);

Description

Sets the active duration.

Parameters

const TSdpTypedTime aValue

IMPORT_C const RArray< TSdpTypedTime > &TimeOffsets() const;

Description

Gets the array of time offsets. This array is used directly for element insertion and removal.

Return value

const RArray< TSdpTypedTime > & The offsets.

IMPORT_C void SetTimeOffsetsL(const RArray< TSdpTypedTime > &aValue);

Description

Sets the time offsets.

Parameters

const RArray< TSdpTypedTime > &aValue