Class CMMFClip

class CMMFClip : public CBase, public MDataSource, public MDataSink;

Description

Abstract class to represent a source or sink that contains a multimedia clip (i.e. not a stream or hardware device).

Typical examples are a file or an area of memory (descriptor).

Derivation

• MDataSink - Abstract class representing a data sink.
• MDataSource - Abstract class representing a data source.
• CBase - Base class for all classes to be instantiated on the heap.

• CMMFClip - ...

Members

Defined in CMMFClip:

• BytesFree()Returns the amount of space available for the clip.
• CMMFClip(TUid,TUid)Protected constructor.
• Delete()Deletes the clip.
• ReadBufferL(CMMFBuffer *,TInt)Reads the maximum number of bytes of data from the offset, aPosition into the bu...
• ReadBufferL(CMMFBuffer *,TInt,MDataSink *)Reads the maximum number of bytes of data from the offset, aPosition into the bu...
• ReadBufferL(TInt,CMMFBuffer *,TInt,MDataSink *)Reads aLength number of bytes of data from the offset, aPosition into the buffer...
• SetSize(TInt)Sets the size of the clip. This should be overriden in the derived classes, the ...
• Size()Returns the size of the clip in bytes.
• WriteBufferL(CMMFBuffer *,TInt)Writes the maximum number of bytes of data from the offset, aPosition from the b...
• WriteBufferL(CMMFBuffer *,TInt,MDataSource *)Writes the maximum number of bytes of data from the offset, aPosition from the b...
• WriteBufferL(TInt,CMMFBuffer *,TInt,MDataSource *)Writes aLength number of bytes of data from the offset, aPosition from the buffe...

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from MDataSink:

• BufferFilledL(CMMFBuffer *)Function called by a data source to pass back a filled buffer to the sink.
• CanCreateSinkBuffer()Function to indicate whether the data sink can create a buffer.
• ConstructSinkL(const TDesC8 &)Performs any sink construction dependant on the sink construction initialisation...
• CreateSinkBufferL(TMediaId,TBool &)Returns a buffer created by the data sink.
• DataSinkType()constReturns the UID identifying the type of data sink.
• EmptyBufferL(CMMFBuffer *,MDataSource *,TMediaId)Method called by a MDataSource to request the data sink to empty aBuffer of data...
• MDataSink(TUid)Protected constructor.
• NegotiateL(MDataSource &)Allows the data sink to negotiate with a data source.
• NewSinkL(TUid,const TDesC8 &)Instantiates a new data sink.
• SetSinkDataTypeCode(TFourCC,TMediaId)Sets the data type as a fourCC code for the data sink.
• SetSinkPrioritySettings(const TMMFPrioritySettings &)Sets the sink priority settings.
• SinkCustomCommand(TMMFMessage &)Calls a sink specific custom command.
• SinkDataTypeCode(TMediaId)Returns the data type as a fourCC code of the data sink.
• SinkPauseL()Function to 'pause' the data sink.
• SinkPlayL()Function 'play' the data sink.
• SinkPrimeL()Function to 'prime' the data sink.
• SinkStopL()Function to 'stop' the data sink.
• SinkThreadLogoff()Function to 'logoff' the data sink from the same thread that sink consumes data ...
• SinkThreadLogon(MAsyncEventHandler &)Function to 'logon' the data sink to the same thread that sink will be consuming...

Inherited from MDataSource:

• BufferEmptiedL(CMMFBuffer *)Function called by a data sink to pass back an emptied buffer to the source.
• CanCreateSourceBuffer()Function to indicate whether the data source can create a buffer.
• ConstructSourceL(const TDesC8 &)Performs any source construction dependant on the source construction initialisa...
• CreateSourceBufferL(TMediaId,CMMFBuffer &,TBool &)Returns a buffer created by the data source.
• CreateSourceBufferL(TMediaId,TBool &)Returns a buffer created by the data source
• DataSourceType()constReturns the UID identifying the type of data source.
• FillBufferL(CMMFBuffer *,MDataSink *,TMediaId)Function called by a MDataSink to request the data source to fill aBuffer with d...
• MDataSource(TUid)Protected constructor.
• NegotiateSourceL(MDataSink &)Function to allow the data source to negotiate with a data sink
• NewSourceL(TUid,const TDesC8 &)Instantiates a data source.
• SetSourceDataTypeCode(TFourCC,TMediaId)Sets the data type as a fourCC code for the data source.
• SetSourcePrioritySettings(const TMMFPrioritySettings &)Function to set the source priority settings.
• SourceCustomCommand(TMMFMessage &)Function to call a source specific custom command.
• SourceDataTypeCode(TMediaId)Returns the data type as a fourCC code of the data source.
• SourcePauseL()Function to 'pause' the data source.
• SourcePlayL()Function to 'play' the data source.
• SourcePrimeL()Function to 'prime' the data source.
• SourceSampleConvert()Indicates whether the data source supports sample rate conversion.
• SourceStopL()Function to 'stop' the data source.
• SourceThreadLogoff()Function to 'logoff' the data source from the same thread that source supplies d...
• SourceThreadLogon(MAsyncEventHandler &)Function to 'logon' the data source to the same thread that source will be suppl...

protected: inline CMMFClip(TUid aSourceType, TUid aSinkType);

Description

Protected constructor.

Parameters

TUid aSourceType The source type. TUid aSinkType The sink type.

virtual void ReadBufferL(TInt aLength, CMMFBuffer *aBuffer, TInt aPosition, MDataSink *aConsumer)=0;

Description

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.

Parameters

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

virtual void WriteBufferL(TInt aLength, CMMFBuffer *aBuffer, TInt aPosition, MDataSource *aSupplier)=0;

Description

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.

Parameters

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

virtual void ReadBufferL(CMMFBuffer *aBuffer, TInt aPosition, MDataSink *aConsumer)=0;

Description

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.

Parameters

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

virtual void WriteBufferL(CMMFBuffer *aBuffer, TInt aPosition, MDataSource *aSupplier)=0;

Description

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.

Parameters

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

virtual void ReadBufferL(CMMFBuffer *aBuffer, TInt aPosition)=0;

Description

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.

Parameters

CMMFBuffer *aBuffer The buffer to read the data into. TInt aPosition The offset from which to start reading.

virtual void WriteBufferL(CMMFBuffer *aBuffer, TInt aPosition)=0;

Description

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.

Parameters

CMMFBuffer *aBuffer The buffer to write the data into. TInt aPosition The offset from which to start writing.

virtual TInt64 BytesFree()=0;

Description

Returns the amount of space available for the clip.

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

Return value

TInt64 The amount of space available.

virtual TInt Size()=0;

Description

Returns the size of the clip in bytes.

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

Return value

TInt The size of the clip.

inline virtual TInt Delete();

Description

Deletes the clip.

This should be overriden in the derived classes, the default version returns KErrNotSupported.

Return value

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

inline virtual TInt SetSize(TInt aSize);

Description

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

Parameters

TInt aSize The size of the clip.

Return value

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