CMMFUrlSink Class Reference

#include <mmf/server/mmfurl.h>

class CMMFUrlSink : public CBase, public MDataSink

Inherits from

CMMFUrlSink
- CBase
- MDataSink

Public Member Functions
virtual	~CMMFUrlSink()
virtual void	BufferFilledL(CMMFBuffer *)
virtual TBool	CanCreateSinkBuffer()
virtual CMMFBuffer *	CreateSinkBufferL(TMediaId, TBool &)
virtual void	EmptyBufferL(CMMFBuffer , MDataSource , TMediaId)
TInt	IAPId()
virtual void	NegotiateL(MDataSource &)
MDataSink *	NewSinkL()
virtual TInt	SetSinkDataTypeCode(TFourCC, TMediaId)
virtual void	SetSinkPrioritySettings(const TMMFPrioritySettings &)
virtual void	SinkCustomCommand(TMMFMessage &)
virtual TFourCC	SinkDataTypeCode(TMediaId)
virtual void	SinkPauseL()
virtual void	SinkPlayL()
virtual void	SinkPrimeL()
virtual void	SinkStopL()
virtual void	SinkThreadLogoff()
virtual TInt	SinkThreadLogon(MAsyncEventHandler &)
const TDesC &	Url()
TBool	UseIAPId()

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()
	MDataSink::DataSinkType()const
	MDataSink::MDataSink(TUid)
	MDataSink::NewSinkL(TUid,const TDesC8 &)
	MDataSink::NewSinkLC(TUid,const TDesC8 &)
	MDataSink::~MDataSink()

Detailed Description

Concrete implementation of a URL data sink.

This class is used only to pass information regarding the URL and IAP into the controller plugin. IT CANNOT BE USED TO WRITE DATA TO A URL. Each of the MDataSink APIs are implemented as either returning or leaving with KErrNotSupported as appropriate.

The configuration data for this class is an externalized CMMFUrlParams object.

Constructor & Destructor Documentation

~CMMFUrlSink ( )

~CMMFUrlSink

(

)

[virtual]

Member Function Documentation

BufferFilledL ( CMMFBuffer * )

void

BufferFilledL

(

CMMFBuffer *

aBuffer

)

[virtual]

Reimplemented from MDataSink::BufferFilledL(CMMFBuffer *)

Function called by a data source to pass back a filled buffer to the sink.

This is a pure virtual function that each derived class must implement. This method is used as the callback when the data sink actively requests a supplier ie. a data source to fill a buffer by calling the data sources FillBufferL. When the data sink gets this callback it knows that the buffer has been filled and is ready to be emptied.

Parameters
aBuffer	The buffer that has been filled by a data source and is now available for processing.

CanCreateSinkBuffer ( )

TBool

CanCreateSinkBuffer

(

)

[virtual]

Reimplemented from MDataSink::CanCreateSinkBuffer()

Deprecated

Function to indicate whether the data sink can create a buffer.

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

Return Value: A boolean indicating if the data sink can create a buffer. ETrue if it can otherwise EFalse.

CreateSinkBufferL ( TMediaId, TBool & )

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

Reimplemented from MDataSink::CreateSinkBufferL(TMediaId,TBool &)

Returns a buffer created by the data sink.

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

Parameters
aMediaId	This identifies the type of media eg. audio or video and the stream ID. This parameter is required in cases where the source can supply data of more than one media type and/or multiple streams of data.
aReference	This must be written to by the method to indicate whether the created buffer is a 'reference' buffer. A 'reference' buffer is a buffer that is owned by the sink and should be used in preference to the source buffer provided the source buffer is also not a reference buffer.

Return Value: The created buffer.

EmptyBufferL ( CMMFBuffer , MDataSource , TMediaId )

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

Reimplemented from MDataSink::EmptyBufferL(CMMFBuffer *,MDataSource *,TMediaId)

Method called by a MDataSource to request the data sink to empty aBuffer of data.

This is a pure virtual function that each derived class must implement. This method is used when a data sink is passively waiting for requests from a supplier ie. a data source to empty a buffer. The data sink must call the BufferEmptiedL member on aSupplier when it has emptied the buffer of it's data. The data sink can either make this callback synchronously or asynchronously.

Parameters
aBuffer	The full buffer that needs emptying of it's data.
aSupplier	The data source that supplied the data. The data sink needs this to make the BufferEmptiedL callback on aSupplier to indicate to the data source that the data sink has finished with the buffer.
aMediaId	This identifies the type of media eg. audio or video and the stream ID. This parameter is required in cases where the source can supply data of more than one media type and/or multiple streams of data.

IAPId ( )

TInt

IAPId

(

)

const [inline]

Returns the Internet Access Point ID.

Since: 7.0s

Return Value: The IAP ID.

NegotiateL ( MDataSource & )

void

NegotiateL

(

MDataSource &

aDataSource

)

[virtual]

Reimplemented from MDataSink::NegotiateL(MDataSource &)

Deprecated

Allows the data sink to negotiate with a data source.

This method is required in cases where the settings of data sink are dependant on those of a data source. This is a virtual function that a derrived data sink can implement.

Parameters
aDataSource	The data source whose settings can affect the data sink.

NewSinkL ( )

MDataSink *

NewSinkL

(

)

[static]

SetSinkDataTypeCode ( TFourCC, TMediaId )

TInt	SetSinkDataTypeCode	(	TFourCC	aSinkFourCC,
			TMediaId	aMediaId
		)	[virtual]

Reimplemented from MDataSink::SetSinkDataTypeCode(TFourCC,TMediaId)

Sets the data type as a fourCC code for the data sink.

This is a virtual function that each derived class can implement if the data sink supports the ability to have its data type set.

Parameters
aSinkFourCC	This specifies the data type as a fourCC code to set the sink to.
aMediaId	This identifies the type of media eg. audio or video and the stream ID. This parameter is required in cases where the source can supply data of more than one media type and/or multiple streams of data.

Return Value: KErrNone if successful, KErrNotSupported if the sink does not support having it's data type set, otherwise a system wide error code.

SetSinkPrioritySettings ( const TMMFPrioritySettings & )

void

SetSinkPrioritySettings

(

const TMMFPrioritySettings &

aPrioritySettings

)

[virtual]

Reimplemented from MDataSink::SetSinkPrioritySettings(const TMMFPrioritySettings &)

Sets the sink priority settings.

This is a virtual function that a derrived data sink can implement if a priority mechanism is required to arbitrate between multiple clients trying to access the same resource.

Parameters
aPrioritySettings	The sink priority settings.

SinkCustomCommand ( TMMFMessage & )

void

SinkCustomCommand

(

TMMFMessage &

aMessage

)

[virtual]

Reimplemented from MDataSink::SinkCustomCommand(TMMFMessage &)

Calls a sink specific custom command.

This is a virtual function that a derrived data sink can implement if it implements any custom commands.

Parameters
aMessage	The message specifying the custom command.

SinkDataTypeCode ( TMediaId )

TFourCC

SinkDataTypeCode

(

TMediaId

aMediaId

)

[virtual]

Reimplemented from MDataSink::SinkDataTypeCode(TMediaId)

Returns the data type as a fourCC code of the data sink.

This is a pure virtual function that each derrived class must implement.

Parameters
aMediaId	This identifies the type of media eg. audio or video and the stream ID. This parameter is required in cases where the sink can accept data of more than one media type and/or multiple streams of data.

Return Value: The fourCC code identifying the sink datatype for the specified aMediaId.

SinkPauseL ( )

void

SinkPauseL

(

)

[virtual]

Reimplemented from MDataSink::SinkPauseL()

Function to 'pause' the data sink.

This is a virtual function that a derrived data sink can implement if any data sink specific action is required to 'pause'.

SinkPlayL ( )

void

SinkPlayL

(

)

[virtual]

Reimplemented from MDataSink::SinkPlayL()

Function 'play' the data sink.

This is a virtual function that a derrived data sink can implement if any data sink specific action is required prior to 'playing' ie. the start of data transfer.

SinkPrimeL ( )

void

SinkPrimeL

(

)

[virtual]

Reimplemented from MDataSink::SinkPrimeL()

Function to 'prime' the data sink.

This is a virtual function that a derrived data sink can implement if any data sink specific 'priming' is required.

SinkStopL ( )

void

SinkStopL

(

)

[virtual]

Reimplemented from MDataSink::SinkStopL()

Function to 'stop' the data sink.

This is a virtual function that a derrived data sink can implement if any data sink specific action is required to 'stop'

SinkThreadLogoff ( )

void

SinkThreadLogoff

(

)

[virtual]

Reimplemented from MDataSink::SinkThreadLogoff()

Function to 'logoff' the data sink from the same thread that sink consumes data in.

This method may be required as the thread that the data sink is deleted in may not be the same thread that the data transfer took place in. Therefore any thread specific releasing of resources needs to be performed in the SinkThreadLogoff rather than in the destructor.

This is a virtual function that a derrived data sink can implement if any thread specific releasing of resources is required.

SinkThreadLogon ( MAsyncEventHandler & )

TInt

SinkThreadLogon

(

MAsyncEventHandler &

aEventHandler

)

[virtual]

Reimplemented from MDataSink::SinkThreadLogon(MAsyncEventHandler &)

Function to 'logon' the data sink to the same thread that sink will be consuming data in.

This method may be required as the thread that the data sink was created in is not always the same thread that the data transfer will take place in. Therefore any thread specific initialisation needs to be performed in the SinkThreadLogon rather than in the creation of the data sink.

This is a virtual function that a derrived data sink can implement if any thread specific initialisation is required and/or the data sink can create any asynchronous events.

Parameters
aEventHandler	This is an MAsyncEventHandler to handle asynchronous events that occur during the transfer of multimedia data. The event handler must be in the same thread as the data transfer thread - hence the reason it is passed in the SinkThreadLogon as opposed to say the constructor.

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

Url ( )

const TDesC &

Url

(

)

const [inline]

Returns the URL string.

For example:

	http://www.symbian.com/clip/mpg

Since: 7.0s

Return Value: The URL string.

UseIAPId ( )

TBool

UseIAPId

(

)

const [inline]

Indicates whether the IAP ID should be used.

Since: 7.0s

Return Value: A boolean indicating if the supplied IAP ID should be used. ETrue if the supplied ID should be used, EFalse if the default IAP ID should be used.

CMMFUrlSink Class Reference

Inherits from

Detailed Description

Constructor & Destructor Documentation

~CMMFUrlSink ( )

Member Function Documentation

BufferFilledL ( CMMFBuffer * )

CanCreateSinkBuffer ( )

CreateSinkBufferL ( TMediaId, TBool & )

EmptyBufferL ( CMMFBuffer *, MDataSource *, TMediaId )

IAPId ( )

NegotiateL ( MDataSource & )

NewSinkL ( )

SetSinkDataTypeCode ( TFourCC, TMediaId )

SetSinkPrioritySettings ( const TMMFPrioritySettings & )

SinkCustomCommand ( TMMFMessage & )

SinkDataTypeCode ( TMediaId )

SinkPauseL ( )

SinkPlayL ( )

SinkPrimeL ( )

SinkStopL ( )

SinkThreadLogoff ( )

SinkThreadLogon ( MAsyncEventHandler & )

Url ( )

UseIAPId ( )

EmptyBufferL ( CMMFBuffer , MDataSource , TMediaId )