RMMFAudioPlayControllerCustomCommands Class Reference

#include "mmfstandardcustomcommands.h"

Link against: mmfstandardcustomcommands.lib

class RMMFAudioPlayControllerCustomCommands : public RMMFCustomCommandsBase

Inherits from

RMMFAudioPlayControllerCustomCommands
- RMMFCustomCommandsBase

Public Member Functions
	RMMFAudioPlayControllerCustomCommands(RMMFController &)
IMPORT_C TInt	DeletePlaybackWindow()
IMPORT_C TInt	GetLoadingProgress(TInt &)
IMPORT_C TInt	SetPlaybackWindow(const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)

Inherited Attributes
	RMMFCustomCommandsBase::iController
	RMMFCustomCommandsBase::iDestinationPckg

Inherited Functions
	RMMFCustomCommandsBase::RMMFCustomCommandsBase(RMMFController &,TUid)

Detailed Description

Client class to access functionality specific to an audio play controller.

The class uses the custom command function of the controller plugin, and removes the necessity for the client to formulate the custom commands.

Since: 7.0s

Constructor & Destructor Documentation

RMMFAudioPlayControllerCustomCommands ( RMMFController & )

IMPORT_C

RMMFAudioPlayControllerCustomCommands

(

RMMFController &

aController

)

Constructor.

Since: 7.0s

Parameter	Description
aController	The client side controller object to be used by this custom command interface.

Member Function Documentation

DeletePlaybackWindow ( )

IMPORT_C TInt

DeletePlaybackWindow

(

)

Removes a previously defined playback window.

Since: 7.0s

Returns: One of the system-wide error codes.

GetLoadingProgress ( TInt & )

IMPORT_C TInt

GetLoadingProgress

(

TInt &

aPercentageProgress

)

const

Gets the audio loading progress as a percentage.

Since: 7.0s

Parameter	Description
aPercentageProgress	The progress loading the clip, as a percentage.

Returns: One of the system-wide error codes.

SetPlaybackWindow ( const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds & )

IMPORT_C TInt	SetPlaybackWindow	(	const TTimeIntervalMicroSeconds &	aStart,
			const TTimeIntervalMicroSeconds &	aEnd
		)	const

Sets a playback window. The controller will start playing from the start of the window, and finish playing at the end of the window.

Since: 7.0s

Parameter	Description
aStart	The start of the window, in microseconds.
aEnd	The end of the window, in microseconds.

Returns: One of the system-wide error codes.