RMMFAudioPlayDeviceCustomCommands Class Reference

#include "mmfstandardcustomcommands.h"

Link against: mmfstandardcustomcommands.lib

class RMMFAudioPlayDeviceCustomCommands : public RMMFCustomCommandsBase

Inherits from

RMMFAudioPlayDeviceCustomCommands
- RMMFCustomCommandsBase

Public Member Functions
	RMMFAudioPlayDeviceCustomCommands(RMMFController &)
IMPORT_C TInt	GetBalance(TInt &)
IMPORT_C TInt	GetMaxVolume(TInt &)
IMPORT_C TInt	GetVolume(TInt &)
IMPORT_C TInt	SetBalance(TInt)
IMPORT_C TInt	SetVolume(TInt)
IMPORT_C TInt	SetVolumeRamp(const TTimeIntervalMicroSeconds &)

Inherited Attributes
	RMMFCustomCommandsBase::iController
	RMMFCustomCommandsBase::iDestinationPckg

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

Detailed Description

Client class to access Audio Play Device functionality.

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

RMMFAudioPlayDeviceCustomCommands ( RMMFController & )

IMPORT_C

RMMFAudioPlayDeviceCustomCommands

(

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

GetBalance ( TInt & )

IMPORT_C TInt

GetBalance

(

TInt &

aBalance

)

const

Gets the balance between the left and right stereo audio channels.

Since: 7.0s

Parameter	Description
aBalance	The current balance, filled in by the controller.

Returns: One of the system-wide error codes.

GetMaxVolume ( TInt & )

IMPORT_C TInt

GetMaxVolume

(

TInt &

aMaxVolume

)

const

Gets the maximum volume supported by the sound device.

Since: 7.0s

Parameter	Description
aMaxVolume	The maximum volume, filled in by the controller.

Returns: One of the system-wide error codes.

GetVolume ( TInt & )

IMPORT_C TInt

GetVolume

(

TInt &

aVolume

)

const

Gets the current playback volume.

Since: 7.0s

Parameter	Description
aVolume	On return contains the current playback volume.

Returns: One of the system-wide error codes.

SetBalance ( TInt )

IMPORT_C TInt

SetBalance

(

TInt

aBalance

)

const

Sets the balance between the left and right stereo audio channels.

Since: 7.0s

Parameter	Description
aBalance	Use a value between KMMFBalanceMaxLeft and KMMFBalanceMaxRight. Centre balance can be restored by using KMMFBalanceCenter.

Returns: One of the system-wide error codes.

SetVolume ( TInt )

IMPORT_C TInt

SetVolume

(

TInt

aVolume

)

const

Sets the volume of the sound device.

Since: 7.0s

Parameter	Description
aVolume	The new volume.

Returns: One of the system-wide error codes.

SetVolumeRamp ( const TTimeIntervalMicroSeconds & )

IMPORT_C TInt

SetVolumeRamp

(

const TTimeIntervalMicroSeconds &

aRampDuration

)

const

Sets a volume ramp.

This will cause the sound device to start playing with zero volume, increasing the volume over aRampDuration microseconds.

The volume ramp can be removed by setting the ramp duration to zero.

Since: 7.0s

Parameter	Description
aRampDuration	The duration over which the volume is to be increased, in microseconds.

Returns: One of the system-wide error codes.