MMMFAudioPlayDeviceCustomCommandImplementor Class Reference

#include <mmf/common/mmfstandardcustomcommands.h>

class MMMFAudioPlayDeviceCustomCommandImplementor
Public Member Functions
pure virtual voidMapdGetBalanceL(TInt &)
pure virtual voidMapdGetMaxVolumeL(TInt &)
pure virtual voidMapdGetVolumeL(TInt &)
pure virtual voidMapdSetBalanceL(TInt)
pure virtual voidMapdSetVolumeL(TInt)
pure virtual voidMapdSetVolumeRampL(const TTimeIntervalMicroSeconds &)

Detailed Description

Mixin class to be derived from controller plugins that could support the audio play device

custom commands.

Member Function Documentation

MapdGetBalanceL ( TInt & )

voidMapdGetBalanceL(TInt &aBalance)[pure virtual]

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

This function can leave with one of the system-wide error codes. The request will be

completed with the leave code.

Since
7.0s
Parameters
aBalanceThe current balance, filled in by the controller.

MapdGetMaxVolumeL ( TInt & )

voidMapdGetMaxVolumeL(TInt &aMaxVolume)[pure virtual]

Gets the maximum volume supported by the sound device.

This function can leave with one of the system-wide error codes. The request will be

completed with the leave code.

Since
7.0s
Parameters
aMaxVolumeThe maximum volume, to be filled in by the controller plugin.

MapdGetVolumeL ( TInt & )

voidMapdGetVolumeL(TInt &aVolume)[pure virtual]

Gets the current playback volume.

This function can leave with one of the system-wide error codes. The request will be

completed with the leave code.

Since
7.0s
Parameters
aVolumeThe volume, to be filled in by the controller.

MapdSetBalanceL ( TInt )

voidMapdSetBalanceL(TIntaBalance)[pure virtual]

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

This function can leave with one of the system-wide error codes. The request will be

completed with the leave code.

restored by using KMMFBalanceCenter.

Since
7.0s
Parameters
aBalanceUse a value between KMMFBalanceMaxLeft and KMMFBalanceMaxRight. Centre balance can be

MapdSetVolumeL ( TInt )

voidMapdSetVolumeL(TIntaVolume)[pure virtual]

Sets the volume of the sound device.

This function can leave with one of the system-wide error codes. The request will be

completed with the leave code.

Since
7.0s
Parameters
aVolumeThe new volume.

MapdSetVolumeRampL ( const TTimeIntervalMicroSeconds & )

voidMapdSetVolumeRampL(const TTimeIntervalMicroSeconds &aRampDuration)[pure virtual]

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.

This function can leave with one of the system-wide error codes. The request will be

completed with the leave code.

Since
7.0s
Parameters
aRampDurationThe duration over which the volume is to be increased, in microseconds.