Collapse all Symbian^3 Application Developer Library

CMceAudioStream Class Reference

class CMceAudioStream : public CMceMediaStream

Class for representing unidirectional audio stream.

It defines the used audio codecs for the stream. In order to be complete structure, at least one codec is required.

mceclient.lib

Inherits from

CMceAudioStream
- CMceMediaStream
  - CBase

Public Member Functions
	~CMceAudioStream ()
IMPORT_C void	AddCodecL ( CMceAudioCodec *)
const RPointerArray < CMceCodec > &	BaseCodecs ()
IMPORT_C const RPointerArray < CMceAudioCodec > &	Codecs ()
TInt	EventReceivedL ( TMceEvent &)
void	ExternalizeL ( MMceComSerializationContext &)
CMceCodec *	FindCodec ( CMceCodec &)
void	FindDtmfRelatedComponents ( TBool &, TBool &, TBool &, TBool )
void	InitializeL ( CMceSession &, TBool )
void	InitializeL ( CMceManager *, CMceSession &)
void	InternalizeL ( MMceComSerializationContext &)
IMPORT_C CMceAudioStream *	NewL ()
IMPORT_C CMceAudioStream *	NewLC ()
IMPORT_C void	RemoveCodecL ( CMceAudioCodec &)
void	RemoveCodecL ( CMceAudioCodec &, TBool )
void	ReorderCodecsByPreferenceL ( TBool )
IMPORT_C void	ReplaceCodecsL ( RPointerArray < CMceAudioCodec > *)
void	SynchronizeWithFileL ( CMceFileSource &)

Private Member Functions
	CMceAudioStream ()
void	ConstructL ()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CMceMediaStream::AddSinkL(CMceMediaSink *)
	CMceMediaStream::AddSinkL(MMceComSerializationContext &)
	CMceMediaStream::AddedL()
	CMceMediaStream::BaseFactory()const
	CMceMediaStream::BindL(CMceMediaStream *)
	CMceMediaStream::Binder()const
	CMceMediaStream::Bound()const
	CMceMediaStream::BoundStream()const
	CMceMediaStream::BoundStreamL()const
	CMceMediaStream::CMceMediaStream()
	CMceMediaStream::ConstructL(CMceComMediaStream *)
	CMceMediaStream::DisableL()
	CMceMediaStream::EnableL()
	CMceMediaStream::ExternalizeFlatL(RWriteStream &)
	CMceMediaStream::Factory()
	CMceMediaStream::FindCodec(const RPointerArray< CMceCodec > &,CMceCodec &)
	CMceMediaStream::FlatData()
	CMceMediaStream::HandleMediaError(TState,TBool,TInt)
	CMceMediaStream::Id()const
	CMceMediaStream::InternalizeFlatL(RReadStream &)
	CMceMediaStream::IsEnabled()const
	CMceMediaStream::LocalMediaPort()const
	CMceMediaStream::MediaAttributeLinesL()
	CMceMediaStream::RemoveSinkL(CMceMediaSink &)
	CMceMediaStream::SerializationId()const
	CMceMediaStream::Session()const
	CMceMediaStream::SetLocalMediaPortL(TUint)
	CMceMediaStream::SetMediaAttributeLinesL(CDesC8Array *)
	CMceMediaStream::SetSourceL(CMceMediaSource *)
	CMceMediaStream::SetSourceL(MMceComSerializationContext &)
	CMceMediaStream::SetState(TState)
	CMceMediaStream::Sinks()const
	CMceMediaStream::Source()const
	CMceMediaStream::State()const
	CMceMediaStream::Type()const
	CMceMediaStream::Updated()
	CMceMediaStream::~CMceMediaStream()

Inherited Enumerations
	CMceMediaStream:TState

Private Attributes
RPointerArray < CMceAudioCodec >	iCodecs

Inherited Attributes
	CMceMediaStream::iFlatData
	CMceMediaStream::iLinkedStream
	CMceMediaStream::iSession
	CMceMediaStream::iSinks
	CMceMediaStream::iSource

Constructor & Destructor Documentation

CMceAudioStream()

CMceAudioStream

(

)

[private]

C++ default constructor.

~CMceAudioStream()

IMPORT_C

~CMceAudioStream

(

)

Destructor.

Member Functions Documentation

AddCodecL(CMceAudioCodec *)

IMPORT_C void

AddCodecL

(

CMceAudioCodec *

aCodec

)

Adds codec to the stream.

Parameters

CMceAudioCodec * aCodec

codec added to the stream; ownership is transferred

BaseCodecs()

const RPointerArray < CMceCodec > &

BaseCodecs

(

)

[virtual]

Return codecs of stream.

Codecs()

IMPORT_C const RPointerArray < CMceAudioCodec > &

Codecs

(

)

Returns the available codecs to the session. For CMEOutSession, array contains all codecs supported by terminal in default. For CMEInSession, array contains codecs that were offered by remote terminal, and supported by local terminal. Codecs are in preference order in the array. Codec in the first element of the array has highest preference.

ConstructL()

void

ConstructL

(

)

[private]

Second-phase constructor.

EventReceivedL(TMceEvent &)

TInt

EventReceivedL

(

TMceEvent &

aEvent

)

[virtual]

Traversal event handler

Parameters

TMceEvent & aEvent

the event

ExternalizeL(MMceComSerializationContext &)

void

ExternalizeL

(

MMceComSerializationContext &

aSerCtx

)

[virtual]

Externalizes

Parameters

MMceComSerializationContext & aSerCtx

FindCodec(CMceCodec &)

CMceCodec *

FindCodec

(

CMceCodec &

aCodec

)

[virtual]

Searches for codec matching with input codec instance or sdp name

Parameters

CMceCodec & aCodec

the search term

FindDtmfRelatedComponents(TBool &, TBool &, TBool &, TBool)

void	FindDtmfRelatedComponents	(	TBool &	aRtpSourceExists,
			TBool &	aRtpSinkExists,
			TBool &	aDtmfCodecExists,
			TBool	aBinderOriginated
		)

Serches for existence of components needed for dtmf usage.

Parameters

TBool & aRtpSourceExists
TBool & aRtpSinkExists
TBool & aDtmfCodecExists
TBool aBinderOriginated

InitializeL(CMceSession &, TBool)

void	InitializeL	(	CMceSession &	aParent,
			TBool	aDiscardUnusedCodecs
		)	[virtual]

Initializes

Parameters

CMceSession & aParent	the parent
TBool aDiscardUnusedCodecs

InitializeL(CMceManager *, CMceSession &)

void	InitializeL	(	CMceManager *	aManager,
			CMceSession &	aSession
		)	[virtual]

Initializes

Parameters

CMceManager * aManager	the manager. Ownership is NOT transferred
CMceSession & aSession	the Session.

InternalizeL(MMceComSerializationContext &)

void

InternalizeL

(

MMceComSerializationContext &

aSerCtx

)

[virtual]

Internalizes

Parameters

MMceComSerializationContext & aSerCtx

NewL()

IMPORT_C CMceAudioStream *

NewL

(

)

[static]

Two-phased constructor.

NewLC()

IMPORT_C CMceAudioStream *

NewLC

(

)

[static]

Two-phased constructor.

RemoveCodecL(CMceAudioCodec &)

IMPORT_C void

RemoveCodecL

(

CMceAudioCodec &

aCodec

)

Removes codec from the stream

Parameters

CMceAudioCodec & aCodec

codec removed from stream

RemoveCodecL(CMceAudioCodec &, TBool)

void	RemoveCodecL	(	CMceAudioCodec &	aCodec,
			TBool	aBinderOriginated
		)

Removes codec

Parameters

CMceAudioCodec & aCodec
TBool aBinderOriginated

ReorderCodecsByPreferenceL(TBool)

void

ReorderCodecsByPreferenceL

(

TBool

aDiscardUnusedCodecs

)

[virtual]

Arrange audio codecs according codec preferences.

Parameters

TBool aDiscardUnusedCodecs

ReplaceCodecsL(RPointerArray< CMceAudioCodec > *)

IMPORT_C void

ReplaceCodecsL

(

RPointerArray < CMceAudioCodec > *

aCodecs

)

Replaces codecs of the stream. Codecs should be in preference order in the passed array.

Parameters

RPointerArray < CMceAudioCodec > * aCodecs

array of codecs which will replace existing codecs; ownership is transferred

SynchronizeWithFileL(CMceFileSource &)

void

SynchronizeWithFileL

(

CMceFileSource &

aFile

)

[virtual]

Called file source wants to synchronized with stream

Parameters

CMceFileSource & aFile

the file source

Member Data Documentation

RPointerArray< CMceAudioCodec > iCodecs

RPointerArray < CMceAudioCodec >

iCodecs

[private]

codecs