Symbian^3 Application Developer Library >

multimedia::MAudioEffectControl Class Reference

class multimedia::MAudioEffectControl : public multimedia::MEffectControl

Inherits from

Public Member Functions
TInt Disable ()
TInt Enable ()
TInt Enforce ( TBool &)
TInt HaveUpdateRights ( TBool &)
TInt IsEnabled ( TBool &)
TInt IsEnforced ( TBool &)
TInt Uid ( TUid &)
Inherited Functions
multimedia::MControl::AddObserver(MControlObserver &)
multimedia::MControl::ControlType()
multimedia::MControl::RemoveObserver(MControlObserver &)
multimedia::MControl::Type()
multimedia::MEffectControl::Apply()
Public Attributes
const TUint KDisabled
const TUint KEnabled
const TUint KEnforced
const TUint KGainedUpdateRights
const TUint KLostUpdateRights
const TUint KNotEnforced
const TUint KSpecificEffectBase

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 & aEnforced Indicate 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 TUint KDisabled [static]

const TUint KEnabled

const TUint KEnabled [static]

const TUint KEnforced

const TUint KEnforced [static]

const TUint KGainedUpdateRights

const TUint KGainedUpdateRights [static]

const TUint KLostUpdateRights

const TUint KLostUpdateRights [static]

const TUint KNotEnforced

const TUint KNotEnforced [static]

const TUint KSpecificEffectBase

const TUint KSpecificEffectBase [static]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.