CMMFFile Class Reference

#include <mmf/server/mmffile.h>

Link against: AdvancedAudioController.lib

class CMMFFile : public CMMFClip

Inherits from

CMMFFile
- CMMFClip

Protected Member Enumerations
enum	TMMFileMode { ESourceMode, ESinkMode }

Public Member Functions
virtual	~CMMFFile()
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 TInt	Data(ContentAccess::CData *&)
virtual TInt	Delete()
virtual void	EmptyBufferL(CMMFBuffer , MDataSource , TMediaId)
virtual TInt	EvaluateIntent(ContentAccess::TIntent)
virtual TInt	ExecuteIntent(ContentAccess::TIntent)
virtual const TDesC &	Extension()
virtual const TDesC &	FileDrive()
virtual RFile &	FileL()
virtual const TDesC &	FileName()
virtual const TDesC &	FilePath()
virtual void	FillBufferL(CMMFBuffer , MDataSink , TMediaId)
virtual const TFileName	FullName()
virtual TBool	IsProtectedL()
MDataSink *	NewSinkL()
MDataSource *	NewSourceL()
virtual void	ReadBufferL(TInt, CMMFBuffer , TInt, MDataSink )
virtual void	ReadBufferL(CMMFBuffer , TInt, MDataSink )
virtual void	ReadBufferL(CMMFBuffer *, TInt)
virtual TInt	SetAgentProperty(ContentAccess::TAgentProperty, TInt)
virtual TInt	SetSize(TInt)
void	SetTransferBuffer(TBool)
virtual TFourCC	SinkDataTypeCode(TMediaId)
virtual void	SinkPrimeL()
virtual void	SinkStopL()
virtual TBool	SinkStopped()
virtual void	SinkThreadLogoff()
virtual TInt	SinkThreadLogon(MAsyncEventHandler &)
virtual TInt	Size()
virtual TFourCC	SourceDataTypeCode(TMediaId)
virtual void	SourcePauseL()
virtual void	SourcePrimeL()
virtual void	SourceStopL()
virtual void	SourceThreadLogoff()
virtual TInt	SourceThreadLogon(MAsyncEventHandler &)
virtual const TDesC &	UniqueId()
virtual void	WriteBufferL(TInt, CMMFBuffer , TInt, MDataSource )
virtual void	WriteBufferL(CMMFBuffer , TInt, MDataSource )
virtual void	WriteBufferL(CMMFBuffer *, TInt)

Protected Member Functions
	CMMFFile()
void	CancelRequests()
void	ConstructL(const TDesC8 &, TMMFileMode)
virtual void	ConstructSinkL(const TDesC8 &)
virtual void	ConstructSourceL(const TDesC8 &)
CTransferBufferCopy *	ObtainCopyOfTransferBufferL(TInt)
void	StoreRequestL(CReadWriteRequest *)

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)

Detailed Description

MultiMedia framework class. Represents a physical file.

This may be source file from which data is read or destination to which data is written.

Intended to be used by controller plugin developers for source and sink plugins.

Member Enumeration Documentation

Enum TMMFileMode

Indicates for which purpose the object instance is being created

Enumerator	Value	Description
ESourceMode		The object is created for being a source
ESinkMode		The object is created for being a sink

Constructor & Destructor Documentation

CMMFFile ( )

CMMFFile

(

)

[protected]

~CMMFFile ( )

~CMMFFile

(

)

[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

(

)

CancelRequests ( )

void

CancelRequests

(

)

[protected]

ConstructL ( const TDesC8 &, TMMFileMode )

void	ConstructL	(	const TDesC8 &	aInitData,
			TMMFileMode	aFileMode
		)	[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]

Data ( ContentAccess::CData *& )

TInt

Data

(

ContentAccess::CData *&

aData

)

[virtual]

Delete ( )

TInt

Delete

(

)

[virtual]

Reimplemented from CMMFClip::Delete()

Deletes the clip.

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

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

EmptyBufferL ( CMMFBuffer , MDataSource , TMediaId )

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

EvaluateIntent ( ContentAccess::TIntent )

TInt

EvaluateIntent

(

ContentAccess::TIntent

aIntent

)

const [virtual]

ExecuteIntent ( ContentAccess::TIntent )

TInt

ExecuteIntent

(

ContentAccess::TIntent

aIntent

)

[virtual]

Extension ( )

const TDesC &

Extension

(

)

const [virtual]

FileDrive ( )

const TDesC &

FileDrive

(

)

const [virtual]

FileL ( )

RFile &

FileL

(

)

[virtual]

FileName ( )

const TDesC &

FileName

(

)

const [virtual]

FilePath ( )

const TDesC &

FilePath

(

)

const [virtual]

FillBufferL ( CMMFBuffer , MDataSink , TMediaId )

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

FullName ( )

const TFileName

FullName

(

)

const [virtual]

IsProtectedL ( )

TBool

IsProtectedL

(

)

const [virtual]

NewSinkL ( )

MDataSink *

NewSinkL

(

)

[static]

NewSourceL ( )

MDataSource *

NewSourceL

(

)

[static]

ObtainCopyOfTransferBufferL ( TInt )

CTransferBufferCopy *

ObtainCopyOfTransferBufferL

(

TInt

aMaxLength

)

[protected]

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.

SetAgentProperty ( ContentAccess::TAgentProperty, TInt )

TInt	SetAgentProperty	(	ContentAccess::TAgentProperty	aProperty,
			TInt	aValue
		)	[virtual]

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]

SinkPrimeL ( )

void

SinkPrimeL

(

)

[virtual]

SinkStopL ( )

void

SinkStopL

(

)

[virtual]

SinkStopped ( )

TBool

SinkStopped

(

)

[virtual]

SinkThreadLogoff ( )

void

SinkThreadLogoff

(

)

[virtual]

SinkThreadLogon ( MAsyncEventHandler & )

TInt

SinkThreadLogon

(

MAsyncEventHandler &

aEventHandler

)

[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]

SourcePauseL ( )

void

SourcePauseL

(

)

[virtual]

SourcePrimeL ( )

void

SourcePrimeL

(

)

[virtual]

SourceStopL ( )

void

SourceStopL

(

)

[virtual]

SourceThreadLogoff ( )

void

SourceThreadLogoff

(

)

[virtual]

SourceThreadLogon ( MAsyncEventHandler & )

TInt

SourceThreadLogon

(

MAsyncEventHandler &

aEventHandler

)

[virtual]

StoreRequestL ( CReadWriteRequest * )

void

StoreRequestL

(

CReadWriteRequest *

aRequest

)

[protected]

UniqueId ( )

const TDesC &

UniqueId

(

)

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

CMMFFile Class Reference

Inherits from

Detailed Description

Member Enumeration Documentation

Enum TMMFileMode

Constructor & Destructor Documentation

CMMFFile ( )

~CMMFFile ( )

Member Function Documentation

BufferEmptiedL ( CMMFBuffer * )

BufferFilledL ( CMMFBuffer * )

BytesFree ( )

CanCreateSinkBuffer ( )

CanCreateSourceBuffer ( )

CanUseTransferBuffer ( )

CancelRequests ( )

ConstructL ( const TDesC8 &, TMMFileMode )

ConstructSinkL ( const TDesC8 & )

ConstructSourceL ( const TDesC8 & )

CreateSinkBufferL ( TMediaId, TBool & )

CreateSourceBufferL ( TMediaId, TBool & )

Data ( ContentAccess::CData *& )

Delete ( )

EmptyBufferL ( CMMFBuffer *, MDataSource *, TMediaId )

EvaluateIntent ( ContentAccess::TIntent )

ExecuteIntent ( ContentAccess::TIntent )

Extension ( )

FileDrive ( )

FileL ( )

FileName ( )

FilePath ( )

FillBufferL ( CMMFBuffer *, MDataSink *, TMediaId )

FullName ( )

IsProtectedL ( )

NewSinkL ( )

NewSourceL ( )

ObtainCopyOfTransferBufferL ( TInt )

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

ReadBufferL ( CMMFBuffer *, TInt, MDataSink * )

ReadBufferL ( CMMFBuffer *, TInt )

SetAgentProperty ( ContentAccess::TAgentProperty, TInt )

SetSize ( TInt )

SetTransferBuffer ( TBool )

SinkDataTypeCode ( TMediaId )

SinkPrimeL ( )

SinkStopL ( )

SinkStopped ( )

SinkThreadLogoff ( )

SinkThreadLogon ( MAsyncEventHandler & )

Size ( )

SourceDataTypeCode ( TMediaId )

SourcePauseL ( )

SourcePrimeL ( )

SourceStopL ( )

SourceThreadLogoff ( )

SourceThreadLogon ( MAsyncEventHandler & )

StoreRequestL ( CReadWriteRequest * )

UniqueId ( )

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 )