CMMFDescriptor Class Reference

#include <mmf/server/mmfdes.h>

class CMMFDescriptor : public CMMFClip

Inherits from

Public Member Functions
virtual ~CMMFDescriptor()
virtual voidBufferEmptiedL(CMMFBuffer *)
virtual voidBufferFilledL(CMMFBuffer *)
virtual TInt64 BytesFree()
virtual TBool CanCreateSinkBuffer()
virtual TBool CanCreateSourceBuffer()
TBool CanUseTransferBuffer()
virtual CMMFBuffer *CreateSinkBufferL(TMediaId, TBool &)
virtual CMMFBuffer *CreateSourceBufferL(TMediaId, TBool &)
virtual voidEmptyBufferL(CMMFBuffer *, MDataSource *, TMediaId)
virtual voidFillBufferL(CMMFBuffer *, MDataSink *, TMediaId)
MDataSink *NewSinkL()
MDataSource *NewSourceL()
virtual voidReadBufferL(TInt, CMMFBuffer *, TInt, MDataSink *)
virtual voidReadBufferL(CMMFBuffer *, TInt, MDataSink *)
virtual voidReadBufferL(CMMFBuffer *, TInt)
virtual TInt SetSize(TInt)
voidSetTransferBuffer(TBool)
virtual TFourCC SinkDataTypeCode(TMediaId)
virtual TInt Size()
virtual TFourCC SourceDataTypeCode(TMediaId)
virtual voidWriteBufferL(TInt, CMMFBuffer *, TInt, MDataSource *)
virtual voidWriteBufferL(CMMFBuffer *, TInt, MDataSource *)
virtual voidWriteBufferL(CMMFBuffer *, TInt)
Protected Member Functions
CMMFDescriptor()
voidConstructL(const TDesC8 &)
virtual voidConstructSinkL(const TDesC8 &)
virtual voidConstructSourceL(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 * )

voidBufferEmptiedL(CMMFBuffer *aBuffer)[virtual]

BufferFilledL ( CMMFBuffer * )

voidBufferFilledL(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 & )

voidConstructL(const TDesC8 &aInitData)[protected]

ConstructSinkL ( const TDesC8 & )

voidConstructSinkL(const TDesC8 &aInitData)[protected, virtual]

ConstructSourceL ( const TDesC8 & )

voidConstructSourceL(const TDesC8 &aInitData)[protected, virtual]

CreateSinkBufferL ( TMediaId, TBool & )

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

CreateSourceBufferL ( TMediaId, TBool & )

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

EmptyBufferL ( CMMFBuffer *, MDataSource *, TMediaId )

voidEmptyBufferL(CMMFBuffer *aBuffer,
MDataSource *aSupplier,
TMediaIdaMediaId
)[virtual]

FillBufferL ( CMMFBuffer *, MDataSink *, TMediaId )

voidFillBufferL(CMMFBuffer *aBuffer,
MDataSink *aConsumer,
TMediaIdaMediaId
)[virtual]

NewSinkL ( )

MDataSink *NewSinkL()[static]

NewSourceL ( )

MDataSource *NewSourceL()[static]

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

voidReadBufferL(TIntaLength,
CMMFBuffer *aBuffer,
TIntaPosition,
MDataSink *aConsumer
)[virtual]

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.

ParameterDescription
aLengthThe number of bytes to read.
aBufferThe buffer to read the data into.
aPositionThe offset from which to start reading.
aConsumerThe sink of tha data read from the clip. Will be informed of read if not NULL.

ReadBufferL ( CMMFBuffer *, TInt, MDataSink * )

voidReadBufferL(CMMFBuffer *aBuffer,
TIntaPosition,
MDataSink *aConsumer
)[virtual]

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.

ParameterDescription
aBufferThe buffer to read the data into.
aPositionThe offset from which to start reading.
aConsumerThe sink of tha data read from the clip. Will be informed of read if not NULL.

ReadBufferL ( CMMFBuffer *, TInt )

voidReadBufferL(CMMFBuffer *aBuffer,
TIntaPosition
)[virtual]

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.

ParameterDescription
aBufferThe buffer to read the data into.
aPositionThe offset from which to start reading.

SetSize ( TInt )

TInt SetSize(TIntaSize)[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.

ParameterDescription
aSizeThe 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 )

voidSetTransferBuffer(TBoolaTBuffer)

SinkDataTypeCode ( TMediaId )

TFourCC SinkDataTypeCode(TMediaIdaMediaId)[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(TMediaIdaMediaId)[virtual]

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

voidWriteBufferL(TIntaLength,
CMMFBuffer *aBuffer,
TIntaPosition,
MDataSource *aSupplier
)[virtual]

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.

ParameterDescription
aLengthThe number of bytes to write.
aBufferThe buffer to write the data into.
aPositionThe offset from which to start writing.
aSupplierThe source of the data writen to the clip. Will be informed of write if not NULL.

WriteBufferL ( CMMFBuffer *, TInt, MDataSource * )

voidWriteBufferL(CMMFBuffer *aBuffer,
TIntaPosition,
MDataSource *aSupplier
)[virtual]

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.

ParameterDescription
aBufferThe buffer to write the data into.
aPositionThe offset from which to start writing.
aSupplierThe source of the data writen to the clip. Will be informed of write if not NULL.

WriteBufferL ( CMMFBuffer *, TInt )

voidWriteBufferL(CMMFBuffer *aBuffer,
TIntaPosition
)[virtual]

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.

ParameterDescription
aBufferThe buffer to write the data into.
aPositionThe offset from which to start writing.