Class CMMFBuffer

class CMMFBuffer : public CBase;

Description

Abstract representation of a buffer to contain multimedia data.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CMMFBuffer - Abstract representation of a buffer to contain multimedia data.

Members

Defined in CMMFBuffer:

• BufferSize()constReturns the size of the data in the buffer.
• CMMFBuffer(TUid)
• FrameNumber()constReturns the frame number.
• IsFileServerSafe(TUid)Static method which returns ETrue if the buffer UID is a buffer that is safe to ...
• IsSupportedDataBuffer(TUid)Static method which returns ETrue if the buffer UID is a supported CMMFDataBuffe...
• LastBuffer()constTests whether the buffer is the last buffer.
• NextFrame()Sets the buffer as the next frame.
• Position()constReturns the current buffer read/write position. Used as read/write position on a...
• RequestSize()constReturns the size of data processed by sink or data needed by source.
• SetFrameNumber(TUint)Sets the frame number. This is used for repositioning.
• SetLastBuffer(TBool)Sets the buffer as the last buffer.
• SetPosition(TUint)Sets the current buffer read/write position. Used as read/write position on a bu...
• SetStatus(TBufferStatus)Sets the buffer's status.
• SetTimeToPlay(TTimeIntervalMicroSeconds)Sets the buffer timestamp, in microseconds.
• Status()Returns the buffer's status.
• TimeToPlay()constReturns the buffer timestamp, in microseconds.
• Type()constReturns the buffer type.
• iFrameNumberThe frame number.
• iLastBufferIndicates if this is the last buffer. ETrue if it is.
• iPositionUsed to store the current read/write position. Required when the codec and data ...
• iRequestSizeStores Request size, needed for dynamic buffer length.
• iStatusThe current buffer status.
• iTimeToPlayThe buffer timestamp, in microseconds.
• iTypeThe buffer type.
• ~CMMFBuffer()Destructor.

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...

inline virtual ~CMMFBuffer();

Description

Destructor.

protected: inline CMMFBuffer(TUid aType);

Description

Parameters

IMPORT_C static TBool IsSupportedDataBuffer(TUid aUid);

Description

Static method which returns ETrue if the buffer UID is a supported CMMFDataBuffer type.

Note: If the buffer is not a CMMFDataBuffer this method should return EFalse.

Parameters

Return value

IMPORT_C static TBool IsFileServerSafe(TUid aUid);

Description

Static method which returns ETrue if the buffer UID is a buffer that is safe to be used with the file server. If the buffer type is not safe to be used with the file server, then the client would need to copy the contents of the buffer, prior to passing it onto the file server.

This implementation assumes the CMMFPtrBuffer is safe for file server copy. If this is not the case then remove the PtrBuffer set to ETrue.

Parameters

Return value

inline TUid Type() const;

Description

Returns the buffer type.

Return value

inline virtual void SetStatus(TBufferStatus aStatus);

Description

Sets the buffer's status.

Parameters

inline TBufferStatus Status();

Description

Returns the buffer's status.

Return value

virtual TUint BufferSize() const=0;

Description

Returns the size of the data in the buffer.

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

Return value

inline TTimeIntervalMicroSeconds TimeToPlay() const;

Description

Returns the buffer timestamp, in microseconds.

Return value

inline void SetTimeToPlay(TTimeIntervalMicroSeconds aTime);

Description

Sets the buffer timestamp, in microseconds.

Parameters

inline TUint FrameNumber() const;

Description

Returns the frame number.

Return value

inline void SetFrameNumber(TUint aFrame);

Description

Sets the frame number. This is used for repositioning.

Parameters

inline void NextFrame();

Description

Sets the buffer as the next frame.

inline virtual void SetPosition(TUint aPosition);

Description

Sets the current buffer read/write position. Used as read/write position on a buffer where a codec may need several passes on the same buffer.

Parameters

inline virtual TUint Position() const;

Description

Returns the current buffer read/write position. Used as read/write position on a buffer where a codec may need several passes on the same buffer.

Return value

inline virtual TInt RequestSize() const;

Description

Returns the size of data processed by sink or data needed by source.

Return value

inline void SetLastBuffer(TBool aLastBuffer);

Description

Sets the buffer as the last buffer.

Parameters

inline TBool LastBuffer() const;

Description

Tests whether the buffer is the last buffer.

Return value

protected: TUid iType;

Description

The buffer type.

protected: TBufferStatus iStatus;

Description

The current buffer status.

protected: TTimeIntervalMicroSeconds iTimeToPlay;

Description

The buffer timestamp, in microseconds.

protected: TUint iPosition;

Description

Used to store the current read/write position. Required when the codec and data path may have to read and write the buffer in more than one pass.

protected: TUint iFrameNumber;

Description

The frame number.

protected: TInt iRequestSize;

Description

Stores Request size, needed for dynamic buffer length.

protected: TBool iLastBuffer;

Description

Indicates if this is the last buffer. ETrue if it is.