CSdpRepeatField Class Reference

API published in: S60 2nd Ed

Link against: sdpcodec.lib

Capability Information

Required Capabilities

None

Exceptions

#include <sdprepeatfield.h>

Detailed Description

PublishedAll

Released

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.


Public Member Functions
IMPORT_C�	~CSdpRepeatField ()
�	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 CSdpRepeatField *�	CloneL () const
�	Creates a new instance that is equal to the target.
IMPORT_C TBool�	operator== (const CSdpRepeatField &aObj) const
�	Compares this instance to another for equality.
IMPORT_C const TSdpTypedTime�	RepeatInterval () const
�	Gets the repeat interval.
IMPORT_C void�	SetRepeatIntervalL (const TSdpTypedTime aValue)
�	Sets the repeat interval.
IMPORT_C const TSdpTypedTime�	ActiveDuration () const
�	Gets the active duration.
IMPORT_C void�	SetActiveDuration (const TSdpTypedTime aValue)
�	Sets the active duration.
IMPORT_C const RArray< TSdpTypedTime > &�	TimeOffsets () const
�	Gets the array of time offsets.
IMPORT_C void�	SetTimeOffsetsL (const RArray< TSdpTypedTime > &aValue)
�	Sets the time offsets.
void�	ExternalizeL (RWriteStream &aStream) const
�	Externalizes the object to stream.
Static Public Member Functions
static IMPORT_C CSdpRepeatField *�	DecodeL (const TDesC8 &aText)
�	Constructs a new repeat times field.
static IMPORT_C CSdpRepeatField *�	DecodeLC (const TDesC8 &aText)
�	Constructs a new repeat times field and adds the pointer to the cleanup stack.
static IMPORT_C CSdpRepeatField *�	NewL (const TSdpTypedTime aRepeatInterval, const TSdpTypedTime aActiveDuration, const RArray< TSdpTypedTime > &aOffsets)
�	Constructs a new repeat times field.
static IMPORT_C CSdpRepeatField *�	NewLC (const TSdpTypedTime aRepeatInterval, const TSdpTypedTime aActiveDuration, const RArray< TSdpTypedTime > &aOffsets)
�	Constructs a new repeat times field and adds the pointer to the cleanup stack.
static CSdpRepeatField *�	InternalizeL (RReadStream &aStream)
�	Creates object from the stream data.

Constructor & Destructor Documentation

IMPORT_C CSdpRepeatField::~CSdpRepeatField

�	Deletes the resources held by the instance.

Member Function Documentation

IMPORT_C const TSdpTypedTime CSdpRepeatField::ActiveDuration

�	Gets the active duration. Returns: The active duration.

IMPORT_C CSdpRepeatField* CSdpRepeatField::CloneL

�	Creates a new instance that is equal to the target. Returns: a new instance.

static IMPORT_C CSdpRepeatField* CSdpRepeatField::DecodeL (� const TDesC8 &� aText �)� [static]

Constructs a new repeat times field.

Parameters:

A string containing a correctly formatted field value terminated by a CRLF.

Returns:: a new instance.

static IMPORT_C CSdpRepeatField* CSdpRepeatField::DecodeLC (� const TDesC8 &� aText �)� [static]

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

Parameters:

A string containing a correctly formatted field value terminated by a CRLF.

Returns:: a new instance.

IMPORT_C void CSdpRepeatField::EncodeL

RWriteStream &�

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

Parameters:

Stream used for output. On return the stream includes correctly formatted repeat field.

void CSdpRepeatField::ExternalizeL

RWriteStream &�

Externalizes the object to stream.

Parameters:

Stream where the object's state will be stored

static CSdpRepeatField* CSdpRepeatField::InternalizeL (� RReadStream &� aStream �)� [static]

Creates object from the stream data.

Parameters:

Stream where the object's state will be read

Returns:: Initialized object

static IMPORT_C CSdpRepeatField* CSdpRepeatField::NewL	(�	const TSdpTypedTime�	aRepeatInterval,
		const TSdpTypedTime�	aActiveDuration,
		const RArray< TSdpTypedTime > &�	aOffsets
	)�	`[static]`

Constructs a new repeat times field.

Parameters:

	aRepeatInterval�	Repeat interval value greater than zero.
	aActiveDuration�	Active duration.
	aOffsets�	At least one time offset.

Returns:: a new instance.

static IMPORT_C CSdpRepeatField* CSdpRepeatField::NewLC	(�	const TSdpTypedTime�	aRepeatInterval,
		const TSdpTypedTime�	aActiveDuration,
		const RArray< TSdpTypedTime > &�	aOffsets
	)�	`[static]`

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

Parameters:

	aRepeatInterval�	Repeat interval value greater than zero.
	aActiveDuration�	Active duration.
	aOffsets�	At least one time offset.

Returns:: a new instance.

IMPORT_C TBool CSdpRepeatField::operator==

const CSdpRepeatField &�

Compares this instance to another for equality.

Parameters:

The instance to compare to.

Returns:: ETrue if equal, EFalse if not.

IMPORT_C const TSdpTypedTime CSdpRepeatField::RepeatInterval

�	Gets the repeat interval. Returns: The repeat interval.

IMPORT_C void CSdpRepeatField::SetActiveDuration

const TSdpTypedTime�

Sets the active duration.

Parameters:

IMPORT_C void CSdpRepeatField::SetRepeatIntervalL

const TSdpTypedTime�

Sets the repeat interval.

Parameters:

Repeat interval value greater than zero.

Leave:: KErrSdpCodecRepeatField if aValue is not positive integer value.

IMPORT_C void CSdpRepeatField::SetTimeOffsetsL

const RArray< TSdpTypedTime > &�

Sets the time offsets.

Parameters:

At least one time offset.

IMPORT_C const RArray<TSdpTypedTime>& CSdpRepeatField::TimeOffsets

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

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

sdprepeatfield.h

Copyright � Nokia Corporation 2001-2007