MAudioVibraControl Class Reference

#include <mmf/server/devsoundstandardcustominterfaces.h>

class MAudioVibraControl
Public Member Functions
pure virtual TInt StartVibra()
pure virtual TInt StopVibra()

Detailed Description

This class provides an interface for controlling vibra. DevSound should interpret the instantiation of this interface as a vibra control request by the user. The default vibra behavior implemented by the DevSound for the associated stream will not be performed while the user has control, In other words whilst this interface is instantiated. DevSound default vibra behavior for the associated stream will return once this interface is deleted. Other instances of DevSound may be instantiated for other audio streams at the same time. When multiple instances of DevSound are instantiated, priority and preference values are used to determine which audio streams are rendered. Prioritization of vibra control is determined by adaptation. Due to resource conflicts, and prioritization by adaptation, it may be possible that an audio stream is played, but not the vibra that accompanies that audio. For instance, if audio is mixed and two audio streams are rendered, vibra playback might not be mixed. Vibra playback may be prioritized by adaptation to a single controller. The behavior in these cases would be based on adaptation implementation. The user is not notified if vibra is not played.

Member Function Documentation

StartVibra ( )

TInt StartVibra()[pure virtual]

Turns vibra on.

Returns: KErrNone if successful KErrNotSupported if this method is not implemented.

StopVibra ( )

TInt StopVibra()[pure virtual]

Turns vibra off.

Returns: KErrNone if successful. KErrNotSupported if this method is not implemented.