RMMFAudioPlayDeviceCustomCommands Class Reference

#include <mmf/common/mmfstandardcustomcommands.h>

Link against: mmfstandardcustomcommands.lib

class RMMFAudioPlayDeviceCustomCommands : public RMMFCustomCommandsBase, public RMMFCustomCommandsBase

Inherits from

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_CRMMFAudioPlayDeviceCustomCommands(RMMFController &aController)

Constructor.

Since
7.0s
Parameters
aControllerThe client side controller object to be used by this custom command interface.

Member Function Documentation

GetBalance ( TInt & )

IMPORT_C TIntGetBalance(TInt &aBalance)const

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

Since
7.0s
Parameters
aBalanceThe current balance, filled in by the controller.
Return Value
One of the system-wide error codes.

GetMaxVolume ( TInt & )

IMPORT_C TIntGetMaxVolume(TInt &aMaxVolume)const

Gets the maximum volume supported by the sound device.

Since
7.0s
Parameters
aMaxVolumeThe maximum volume, filled in by the controller.
Return Value
One of the system-wide error codes.

GetVolume ( TInt & )

IMPORT_C TIntGetVolume(TInt &aVolume)const

Gets the current playback volume.

Since
7.0s
Parameters
aVolumeOn return contains the current playback volume.
Return Value
One of the system-wide error codes.

SetBalance ( TInt )

IMPORT_C TIntSetBalance(TIntaBalance)const

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

restored by using KMMFBalanceCenter.

Since
7.0s
Parameters
aBalanceUse a value between KMMFBalanceMaxLeft and KMMFBalanceMaxRight. Centre balance can be
Return Value
One of the system-wide error codes.

SetVolume ( TInt )

IMPORT_C TIntSetVolume(TIntaVolume)const

Sets the volume of the sound device.

Since
7.0s
Parameters
aVolumeThe new volume.
Return Value
One of the system-wide error codes.

SetVolumeRamp ( const TTimeIntervalMicroSeconds & )

IMPORT_C TIntSetVolumeRamp(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
Parameters
aRampDurationThe duration over which the volume is to be increased, in microseconds.
Return Value
One of the system-wide error codes.