CMMFDescriptor Class Reference

#include <mmf/server/mmfdes.h>

class CMMFDescriptor : public CMMFClip

Inherits from

CMMFDescriptor
- CMMFClip

Public Member Functions
virtual	~CMMFDescriptor()
virtual void	BufferEmptiedL(CMMFBuffer *)
virtual void	BufferFilledL(CMMFBuffer *)
virtual TInt64	BytesFree()
virtual TBool	CanCreateSinkBuffer()
virtual TBool	CanCreateSourceBuffer()
TBool	CanUseTransferBuffer()
virtual CMMFBuffer *	CreateSinkBufferL(TMediaId, TBool &)
virtual CMMFBuffer *	CreateSourceBufferL(TMediaId, TBool &)
virtual void	EmptyBufferL(CMMFBuffer , MDataSource , TMediaId)
virtual void	FillBufferL(CMMFBuffer , MDataSink , TMediaId)
MDataSink *	NewSinkL()
MDataSource *	NewSourceL()
virtual void	ReadBufferL(TInt, CMMFBuffer , TInt, MDataSink )
virtual void	ReadBufferL(CMMFBuffer , TInt, MDataSink )
virtual void	ReadBufferL(CMMFBuffer *, TInt)
virtual TInt	SetSize(TInt)
void	SetTransferBuffer(TBool)
virtual TFourCC	SinkDataTypeCode(TMediaId)
virtual TInt	Size()
virtual TFourCC	SourceDataTypeCode(TMediaId)
virtual void	WriteBufferL(TInt, CMMFBuffer , TInt, MDataSource )
virtual void	WriteBufferL(CMMFBuffer , TInt, MDataSource )
virtual void	WriteBufferL(CMMFBuffer *, TInt)

Protected Member Functions
	CMMFDescriptor()
void	ConstructL(const TDesC8 &)
virtual void	ConstructSinkL(const TDesC8 &)
virtual void	ConstructSourceL(const TDesC8 &)

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()
	CMMFClip::CMMFClip(TUid,TUid)
	CMMFClip::Delete()

Detailed Description

MultiMedia framework class. Represents a client side descriptor. May be source descriptor from which data is read or destination to which data is written

Constructor & Destructor Documentation

CMMFDescriptor ( )

CMMFDescriptor

(

)

[protected]

~CMMFDescriptor ( )

~CMMFDescriptor

(

)

[virtual]

Member Function Documentation

BufferEmptiedL ( CMMFBuffer * )

void

BufferEmptiedL

(

CMMFBuffer *

aBuffer

)

[virtual]

BufferFilledL ( CMMFBuffer * )

void

BufferFilledL

(

CMMFBuffer *

aBuffer

)

[virtual]

BytesFree ( )

TInt64

BytesFree

(

)

[virtual]

Reimplemented from CMMFClip::BytesFree()

Returns the amount of space available for the clip.

This is a virtual function that each derived class must implement.

Returns: The amount of space available.

CanCreateSinkBuffer ( )

TBool

CanCreateSinkBuffer

(

)

[virtual]

CanCreateSourceBuffer ( )

TBool

CanCreateSourceBuffer

(

)

[virtual]

CanUseTransferBuffer ( )

TBool

CanUseTransferBuffer

(

)

ConstructL ( const TDesC8 & )

void

ConstructL

(

const TDesC8 &

aInitData

)

[protected]

ConstructSinkL ( const TDesC8 & )

void

ConstructSinkL

(

const TDesC8 &

aInitData

)

[protected, virtual]

ConstructSourceL ( const TDesC8 & )

void

ConstructSourceL

(

const TDesC8 &

aInitData

)

[protected, virtual]

CreateSinkBufferL ( TMediaId, TBool & )

CMMFBuffer *	CreateSinkBufferL	(	TMediaId	aMediaId,
			TBool &	aReference
		)	[virtual]

CreateSourceBufferL ( TMediaId, TBool & )

CMMFBuffer *	CreateSourceBufferL	(	TMediaId	aMediaId,
			TBool &	aReference
		)	[virtual]

EmptyBufferL ( CMMFBuffer , MDataSource , TMediaId )

void	EmptyBufferL	(	CMMFBuffer *	aBuffer,
			MDataSource *	aSupplier,
			TMediaId	aMediaId
		)	[virtual]

FillBufferL ( CMMFBuffer , MDataSink , TMediaId )

void	FillBufferL	(	CMMFBuffer *	aBuffer,
			MDataSink *	aConsumer,
			TMediaId	aMediaId
		)	[virtual]

NewSinkL ( )

MDataSink *

NewSinkL

(

)

[static]

NewSourceL ( )

MDataSource *

NewSourceL

(

)

[static]

ReadBufferL ( TInt, CMMFBuffer , TInt, MDataSink )

void	ReadBufferL	(	TInt	aLength,
			CMMFBuffer *	aBuffer,
			TInt	aPosition,
			MDataSink *	aConsumer
		)	[virtual]

Reimplemented from CMMFClip::ReadBufferL(TInt,CMMFBuffer *,TInt,MDataSink *)

Reads aLength number of bytes of data from the offset, aPosition into the buffer, aBuffer. Intended for asynchronous usage.

This is a virtual function that each derived class must implement.

Parameter	Description
aLength	The number of bytes to read.
aBuffer	The buffer to read the data into.
aPosition	The offset from which to start reading.
aConsumer	The sink of tha data read from the clip. Will be informed of read if not NULL.

ReadBufferL ( CMMFBuffer , TInt, MDataSink )

void	ReadBufferL	(	CMMFBuffer *	aBuffer,
			TInt	aPosition,
			MDataSink *	aConsumer
		)	[virtual]

Reimplemented from CMMFClip::ReadBufferL(CMMFBuffer *,TInt,MDataSink *)

Reads the maximum number of bytes of data from the offset, aPosition into the buffer, aBuffer. Intended for asynchronous usage.

This is a virtual function that each derived class must implement.

Parameter	Description
aBuffer	The buffer to read the data into.
aPosition	The offset from which to start reading.
aConsumer	The sink of tha data read from the clip. Will be informed of read if not NULL.

ReadBufferL ( CMMFBuffer *, TInt )

void	ReadBufferL	(	CMMFBuffer *	aBuffer,
			TInt	aPosition
		)	[virtual]

Reimplemented from CMMFClip::ReadBufferL(CMMFBuffer *,TInt)

Reads the maximum number of bytes of data from the offset, aPosition into the buffer, aBuffer. Intended for synchronous usage.

This is a virtual function that each derived class must implement.

Parameter	Description
aBuffer	The buffer to read the data into.
aPosition	The offset from which to start reading.

SetSize ( TInt )

TInt

SetSize

(

TInt

aSize

)

[virtual]

Reimplemented from CMMFClip::SetSize(TInt)

Sets the size of the clip. This should be overriden in the derived classes, the default version returns KErrNotSupported.

Parameter	Description
aSize	The size of the clip.

Returns: An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

SetTransferBuffer ( TBool )

void

SetTransferBuffer

(

TBool

aTBuffer

)

SinkDataTypeCode ( TMediaId )

TFourCC

SinkDataTypeCode

(

TMediaId

aMediaId

)

[virtual]

Size ( )

TInt

Size

(

)

[virtual]

Reimplemented from CMMFClip::Size()

Returns the size of the clip in bytes.

This is a virtual function that each derived class must implement.

Returns: The size of the clip.

SourceDataTypeCode ( TMediaId )

TFourCC

SourceDataTypeCode

(

TMediaId

aMediaId

)

[virtual]

WriteBufferL ( TInt, CMMFBuffer , TInt, MDataSource )

void	WriteBufferL	(	TInt	aLength,
			CMMFBuffer *	aBuffer,
			TInt	aPosition,
			MDataSource *	aSupplier
		)	[virtual]

Reimplemented from CMMFClip::WriteBufferL(TInt,CMMFBuffer *,TInt,MDataSource *)

Writes aLength number of bytes of data from the offset, aPosition from the buffer, aBuffer. Intended for asynchronous usage.

This is a virtual function that each derived class must implement.

Parameter	Description
aLength	The number of bytes to write.
aBuffer	The buffer to write the data into.
aPosition	The offset from which to start writing.
aSupplier	The source of the data writen to the clip. Will be informed of write if not NULL.

WriteBufferL ( CMMFBuffer , TInt, MDataSource )

void	WriteBufferL	(	CMMFBuffer *	aBuffer,
			TInt	aPosition,
			MDataSource *	aSupplier
		)	[virtual]

Reimplemented from CMMFClip::WriteBufferL(CMMFBuffer *,TInt,MDataSource *)

Writes the maximum number of bytes of data from the offset, aPosition from the buffer, aBuffer. Intended for asynchronous usage.

This is a virtual function that each derived class must implement.

Parameter	Description
aBuffer	The buffer to write the data into.
aPosition	The offset from which to start writing.
aSupplier	The source of the data writen to the clip. Will be informed of write if not NULL.

WriteBufferL ( CMMFBuffer *, TInt )

void	WriteBufferL	(	CMMFBuffer *	aBuffer,
			TInt	aPosition
		)	[virtual]

Reimplemented from CMMFClip::WriteBufferL(CMMFBuffer *,TInt)

Writes the maximum number of bytes of data from the offset, aPosition from the buffer, aBuffer. Intended for synchronous usage.

This is a virtual function that each derived class must implement.

Parameter	Description
aBuffer	The buffer to write the data into.
aPosition	The offset from which to start writing.

CMMFDescriptor Class Reference

Inherits from

Detailed Description

Constructor & Destructor Documentation

CMMFDescriptor ( )

~CMMFDescriptor ( )

Member Function Documentation

BufferEmptiedL ( CMMFBuffer * )

BufferFilledL ( CMMFBuffer * )

BytesFree ( )

CanCreateSinkBuffer ( )

CanCreateSourceBuffer ( )

CanUseTransferBuffer ( )

ConstructL ( const TDesC8 & )

ConstructSinkL ( const TDesC8 & )

ConstructSourceL ( const TDesC8 & )

CreateSinkBufferL ( TMediaId, TBool & )

CreateSourceBufferL ( TMediaId, TBool & )

EmptyBufferL ( CMMFBuffer *, MDataSource *, TMediaId )

FillBufferL ( CMMFBuffer *, MDataSink *, TMediaId )

NewSinkL ( )

NewSourceL ( )

ReadBufferL ( TInt, CMMFBuffer *, TInt, MDataSink * )

ReadBufferL ( CMMFBuffer *, TInt, MDataSink * )

ReadBufferL ( CMMFBuffer *, TInt )

SetSize ( TInt )

SetTransferBuffer ( TBool )

SinkDataTypeCode ( TMediaId )

Size ( )

SourceDataTypeCode ( TMediaId )

WriteBufferL ( TInt, CMMFBuffer *, TInt, MDataSource * )

WriteBufferL ( CMMFBuffer *, TInt, MDataSource * )

WriteBufferL ( CMMFBuffer *, TInt )

EmptyBufferL ( CMMFBuffer , MDataSource , TMediaId )

FillBufferL ( CMMFBuffer , MDataSink , TMediaId )

ReadBufferL ( TInt, CMMFBuffer , TInt, MDataSink )

ReadBufferL ( CMMFBuffer , TInt, MDataSink )

WriteBufferL ( TInt, CMMFBuffer , TInt, MDataSource )

WriteBufferL ( CMMFBuffer , TInt, MDataSource )