Symbian^3 Application Developer Library >

MMmfGlobalAudioImpl Class Reference

class MMmfGlobalAudioImpl

Implementation of CMmfGlobalAudioEffect . This is the base interface for plugins that provide for global effects. It is intended to be exclusively called from CMmfGlobalAudioEffect itself.

Public Member Functions
void Release ()
Protected Member Functions
TUint Capability ( TBool )
void CompleteConstructL ( CMmfGlobalAudioEffect *, MMmfGlobalAudioEffectObserver *)
TInt CreateCustomInterface ( TUid )
TAny * CustomInterface ( TUid )
void ExtractValuesL ( TDes8 &)
TBool IsActive ()
TBool IsEnabled ()
MMmfGlobalAudioPresetList * KnownPresetsL ()
void PassDestructorKey ( TUid )
void RequestNotificationL ( TUid )
void SetByValuesL (const TDesC8 &)
void SetEnabledL ( TBool )
void SetSettingsByDesL (const TDesC8 &)
void SetSettingsByUidL ( TUid )
HBufC8 * SettingsByDesL ()
TUid SettingsByUidL ()
Private Member Functions
MMmfGlobalAudioImpl * NewL ( TUid , CMmfGlobalAudioEffect *, MMmfGlobalAudioEffectObserver *)

Member Functions Documentation

Capability(TBool)

TUint Capability ( TBool aCurrentOnly ) [protected, pure virtual]

Parameters

TBool aCurrentOnly

CompleteConstructL(CMmfGlobalAudioEffect *, MMmfGlobalAudioEffectObserver *)

void CompleteConstructL ( CMmfGlobalAudioEffect * aParent,
MMmfGlobalAudioEffectObserver * aObserver
) [protected, pure virtual]

Complete construction. Pass additional values from the construction phase, used subsequently by the plugin. CMmfGlobalAudioEffect::BaseConstructL()

Parameters

CMmfGlobalAudioEffect * aParent The CMmfGlobalAudioEffect that created this object
MMmfGlobalAudioEffectObserver * aObserver Observer as passed to CMmfGlobalAudioEffect::BaseConstructL()

CreateCustomInterface(TUid)

TInt CreateCustomInterface ( TUid aInterfaceUid ) [protected, pure virtual]

Request extension feature. This is intended to provide additional features, should a particular global effect need it. In typical use, the global effect will make a call to this interface on construction. Repeatedly calling this interface will have no additional effect - if the interface has already been setup internally, then no further activity will take place.

Parameters

TUid aInterfaceUid Used to indicate which interface is required.

CustomInterface(TUid)

TAny * CustomInterface ( TUid aInterfaceUid ) [protected, pure virtual]

Return previously created extension. This returns a custom interface, used to provide additional features for a certain global effect. This should only be used if CreateCustomInterface() has already been called for the same UID value. This means that any construction for that interface has already been called, and thus this call cannot fail. Typically the returned class will be another Mixin.No transfer of ownership is implied.

CreateCustomInterface()

Parameters

TUid aInterfaceUid Used to indicate which interface is required.

ExtractValuesL(TDes8 &)

void ExtractValuesL ( TDes8 & aPackageBuf ) [protected, pure virtual]
Provide implementation of CMmfGlobalAudioEffect::ExtractValuesL() Extract the settings into a struct Note that the implementation should check the size of the supplied package buffer, to check it is as expected.
leave
KErrNotSupported This will only be supported by some child classes, and even then will not be supported by all implementations.
leave
KErrArgument Passed package buffer is not the expected size.
CMmfGlobalAudioEffect::ExtractValuesL()

Parameters

TDes8 & aPackageBuf This should be a package buffer wrapping the appropriate class/struct, and will be specific to a particular CMmfGlobalAudioEffect derivitive.

IsActive()

TBool IsActive ( ) const [protected, pure virtual]

Provide implementation of CMmfGlobalAudioEffect::IsActive() CMmfGlobalAudioEffect::IsActive()

IsEnabled()

TBool IsEnabled ( ) const [protected, pure virtual]

Provide implementation of CMmfGlobalAudioEffect::IsEnabled() CMmfGlobalAudioEffect::IsEnabled()

KnownPresetsL()

MMmfGlobalAudioPresetList * KnownPresetsL ( ) [protected, pure virtual]
Provide implementation of CMmfGlobalAudioEffect::KnownPresetsL() CMmfGlobalAudioEffect::KnownPresetsL()
leave
KErrNotSupported This feature may not be supported in some circumstances

NewL(TUid, CMmfGlobalAudioEffect *, MMmfGlobalAudioEffectObserver *)

MMmfGlobalAudioImpl * NewL ( TUid aImplementationUid,
CMmfGlobalAudioEffect * aParent,
MMmfGlobalAudioEffectObserver * aObserver
) [private, static]

Parameters

TUid aImplementationUid
CMmfGlobalAudioEffect * aParent
MMmfGlobalAudioEffectObserver * aObserver

PassDestructorKey(TUid)

void PassDestructorKey ( TUid aDestructorKey ) [protected, pure virtual]

Pass destructor key. Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()

Parameters

TUid aDestructorKey The Uid returned by REComSession::CreateImplementationL() or similar

Release()

void Release ( ) [pure virtual]

Release object. Equivalent of destructor - called to request data to be deleted.

RequestNotificationL(TUid)

void RequestNotificationL ( TUid aEventUid ) [protected, pure virtual]
Provide implementation of CMmfGlobalAudioEffect::RequestNotificationL()
leave
KErrNotSupported If Observer passed during construction was NULL. The Uid is not recognised. The feature is simply not supported in this implementation.
CMmfGlobalAudioEffect::RequestNotificationL()

Parameters

TUid aEventUid Uid specifying event for which notification is requested

SetByValuesL(const TDesC8 &)

void SetByValuesL ( const TDesC8 & aPackageBuf ) [protected, pure virtual]
Provide implementation of CMmfGlobalAudioEffect::SetByValuesL() . Note that the implementation should check the size of the supplied package buffer, to check it is as expected.
leave
KErrNotSupported This will only be supported by some child classes, and even then will not be supported by all implementations.
leave
KErrArgument Passed package buffer is not the expected size, or individual values are out of range
CMmfGlobalAudioEffect::SetByValuesL()

Parameters

const TDesC8 & aPackageBuf This should be a package buffer wrapping the appropriate class/struct, and will be specific to a particular CMmfGlobalAudioEffect derivitive.

SetEnabledL(TBool)

void SetEnabledL ( TBool aValue ) [protected, pure virtual]

Provide implementation of CMmfGlobalAudioEffect::SetEnabledL() CMmfGlobalAudioEffect::SetEnabledL()

Parameters

TBool aValue If true, enables this specific effect. If false, disables it.

SetSettingsByDesL(const TDesC8 &)

void SetSettingsByDesL ( const TDesC8 & aParam ) [protected, pure virtual]
Provide implementation of CMmfGlobalAudioEffect::SetSettingsByDesL()
leave
KErrNotSupported This implementation does not support expressing settings in descriptor form
leave
KErrCorrupt Value in descriptor does not correspond to known format
CMmfGlobalAudioEffect::SetSettingsByDesL()

Parameters

const TDesC8 & aParam Descriptor value to use

SetSettingsByUidL(TUid)

void SetSettingsByUidL ( TUid aPresetUid ) [protected, pure virtual]
Provide implementation of CMmfGlobalAudioEffect::SetSettingsByUidL()
leave
KErrNotSupported This implementation does not support presets for this effect
leave
KErrUnknown The value of aUid does not correspond to a known preset
CMmfGlobalAudioEffect::SetSettingsByUidL()

Parameters

TUid aPresetUid Uid representing the preset in question

SettingsByDesL()

HBufC8 * SettingsByDesL ( ) const [protected, pure virtual]
Provide implementation of CMmfGlobalAudioEffect::SettingsByDesL()
leave
KErrNotSupported This implementation does not support expressing settings in descriptor form
CMmfGlobalAudioEffect::SettingsByDesL()

SettingsByUidL()

TUid SettingsByUidL ( ) const [protected, pure virtual]
Provide implementation of CMmfGlobalAudioEffect::SettingsByUidL()
leave
KErrNotSupported The settings cannot be expressed as a Uid (usually means SetSettingsByUidL() was not the last thing to change them).
CMmfGlobalAudioEffect::SettingsByUidL()

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.