Class MMMFAudioPlayDeviceCustomCommandImplementor

class MMMFAudioPlayDeviceCustomCommandImplementor;

Description

Mixin class to be derived from by controller plugins wishing to support the audio play device custom commands.

Members

Defined in MMMFAudioPlayDeviceCustomCommandImplementor:
MapdGetBalanceL(), MapdGetMaxVolumeL(), MapdGetVolumeL(), MapdSetBalanceL(), MapdSetVolumeL(), MapdSetVolumeRampL()

virtual void MapdSetVolumeL(TInt aVolume)=0;

Description

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.

Parameters

TInt aVolume The new volume.

virtual void MapdGetMaxVolumeL(TInt &aMaxVolume)=0;

Description

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.

Parameters

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

virtual void MapdGetVolumeL(TInt &aVolume)=0;

Description

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.

Parameters

TInt &aVolume The volume, to be filled in by the controller.

virtual void MapdSetVolumeRampL(const TTimeIntervalMicroSeconds &aRampDuration)=0;

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.

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

Parameters

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

virtual void MapdSetBalanceL(TInt aBalance)=0;

Description

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.

Parameters

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

virtual void MapdGetBalanceL(TInt &aBalance)=0;

Description

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.

Parameters

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