multimedia::MAudioEffectControl Class Reference

class multimedia::MAudioEffectControl : public multimedia::MEffectControl

Inherits from

Member Functions Documentation

Disable()

TInt Disable()[pure virtual]
Disable the effect
Since
5.0

Enable()

TInt Enable()[pure virtual]
Enable the effect
Since
5.0

Enforce(TBool &)

TInt Enforce(TBool &aEnforced)[pure virtual]
Enforce the effect.
Since
5.0

Parameters

TBool & aEnforcedIndicate the effect is to be enforced or not. ETrue = Enforced.

HaveUpdateRights(TBool &)

TInt HaveUpdateRights(TBool &aHaveUpdateRights)[pure virtual]
Check if this effect object currently has update rights. A client can lose update rights in some hardware platforms where there are a limited number of instances of an effect that can exist at the same time. When an effect instance has lost update rights the user can still change settings, but any calls to Apply the settings will be deferred until update rights are regained.
Since
5.0

Parameters

TBool & aHaveUpdateRights

IsEnabled(TBool &)

TInt IsEnabled(TBool &aEnabled)[pure virtual]
Check if the effect is enabled
Since
5.0

Parameters

TBool & aEnabled

IsEnforced(TBool &)

TInt IsEnforced(TBool &aEnforced)[pure virtual]
Check if the effect is enforced.
Since
5.0

Parameters

TBool & aEnforced

Uid(TUid &)

TInt Uid(TUid &aUid)[pure virtual]

Parameters

TUid & aUid

Member Data Documentation

const TUint KDisabled

const TUintKDisabled[static]

const TUint KEnabled

const TUintKEnabled[static]

const TUint KEnforced

const TUintKEnforced[static]

const TUint KGainedUpdateRights

const TUintKGainedUpdateRights[static]

const TUint KLostUpdateRights

const TUintKLostUpdateRights[static]

const TUint KNotEnforced

const TUintKNotEnforced[static]

const TUint KSpecificEffectBase

const TUintKSpecificEffectBase[static]