Class RMMFAudioPlayDeviceCustomCommands

class RMMFAudioPlayDeviceCustomCommands : public RMMFCustomCommandsBase;

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.

Derivation

• RMMFCustomCommandsBase - Base class for client-side custom command classes.

• RMMFAudioPlayDeviceCustomCommands - Client class to access Audio Play Device functionality.

Members

Defined in RMMFAudioPlayDeviceCustomCommands:

• GetBalance(TInt &)constGets the balance between the left and right stereo audio channels.
• GetMaxVolume(TInt &)constGets the maximum volume supported by the sound device.
• GetVolume(TInt &)constGets the current playback volume.
• RMMFAudioPlayDeviceCustomCommands(RMMFController &)Constructor.
• SetBalance(TInt)constSets the balance between the left and right stereo audio channels.
• SetVolume(TInt)constSets the volume of the sound device.
• SetVolumeRamp(const TTimeIntervalMicroSeconds &)constSets a volume ramp.

Inherited from RMMFCustomCommandsBase:

• RMMFCustomCommandsBase(RMMFController &,TUid)Constructor.
• iControllerThe controller.
• iDestinationPckgThe destination package.

IMPORT_C RMMFAudioPlayDeviceCustomCommands(RMMFController &aController);

Description

Constructor.

Parameters

RMMFController &aController The client side controller object to be used by this custom command interface.

IMPORT_C TInt SetVolume(TInt aVolume) const;

Description

Sets the volume of the sound device.

Parameters

TInt aVolume The new volume.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetMaxVolume(TInt &aMaxVolume) const;

Description

Gets the maximum volume supported by the sound device.

Parameters

TInt &aMaxVolume The maximum volume, filled in by the controller.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetVolume(TInt &aVolume) const;

Description

Gets the current playback volume.

Parameters

TInt &aVolume On return contains the current playback volume.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetVolumeRamp(const TTimeIntervalMicroSeconds &aRampDuration) const;

Description

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.

Parameters

const TTimeIntervalMicroSeconds &aRampDuration The duration over which the volume is to be increased, in microseconds.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetBalance(TInt aBalance) const;

Description

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

Parameters

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

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetBalance(TInt &aBalance) const;

Description

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

Parameters

TInt &aBalance The current balance, filled in by the controller.

Return value

TInt One of the system-wide error codes.