CStereoWidening Class Reference

#include <StereoWideningBase.h>

Link against: StereoWidening.lib

class CStereoWidening : public CAudioEffect

Inherits from

Protected Attributes
TEfStereoWideningDataPckg iDataPckgFrom
TEfStereoWideningDataPckg iDataPckgTo
TEfStereoWidening iStereoWideningData
Public Member Functions
virtual ~CStereoWidening()
IMPORT_C TBoolIsContinuousLevelSupported()
IMPORT_C CStereoWidening *NewL()
IMPORT_C CStereoWidening *NewL(CMdaAudioConvertUtility &, TBool, TInt8)
IMPORT_C CStereoWidening *NewL(CMdaAudioInputStream &, TBool, TInt8)
IMPORT_C CStereoWidening *NewL(CMdaAudioOutputStream &, TBool, TInt8)
IMPORT_C CStereoWidening *NewL(CMdaAudioPlayerUtility &, TBool, TInt8)
IMPORT_C CStereoWidening *NewL(CMdaAudioRecorderUtility &, TBool, TBool, TInt8)
IMPORT_C CStereoWidening *NewL(CMdaAudioToneUtility &, TBool, TInt8)
IMPORT_C CStereoWidening *NewL(CMMFDevSound &, TBool, TInt8)
IMPORT_C CStereoWidening *NewL(CCustomCommandUtility *, TBool, TInt8)
IMPORT_C CStereoWidening *NewL(MCustomInterface &, TBool, TInt8)
IMPORT_C CStereoWidening *NewL(CMidiClientUtility &, TBool, TInt8)
IMPORT_C CStereoWidening *NewL(CDrmPlayerUtility &, TBool, TInt8)
IMPORT_C CStereoWidening *NewL(CVideoPlayerUtility &, TBool, TInt8)
IMPORT_C voidSetStereoWideningLevelL(TUint8)
IMPORT_C TUint8StereoWideningLevel()
virtual IMPORT_C TUidUid()
Protected Member Functions
CStereoWidening()
virtual IMPORT_C const TDesC8 &DoEffectData()
virtual IMPORT_C voidSetEffectData(const TDesC8 &)
Inherited Attributes
CAudioEffect::iEnabled
CAudioEffect::iEnforced
CAudioEffect::iHaveUpdateRights
CAudioEffect::iObservers
Inherited Functions
CAudioEffect::ApplyL()
CAudioEffect::CAudioEffect()
CAudioEffect::DisableL()
CAudioEffect::EnableL()
CAudioEffect::EnforceL(TBool)
CAudioEffect::HaveUpdateRights()const
CAudioEffect::IsEnabled()const
CAudioEffect::IsEnforced()const
CAudioEffect::RegisterObserverL(MAudioEffectObserver &)
CAudioEffect::UnRegisterObserver(MAudioEffectObserver &)
CAudioEffect::~CAudioEffect()
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()

Detailed Description

This is the Stereo Widening effect class for managing audio Stereo Widening settings.

Since
3.0

Member Attribute Documentation

iDataPckgFrom

TEfStereoWideningDataPckg iDataPckgFrom[protected]

iDataPckgTo

TEfStereoWideningDataPckg iDataPckgTo[protected]

iStereoWideningData

TEfStereoWidening iStereoWideningData[protected]

Constructor & Destructor Documentation

CStereoWidening ( )

IMPORT_CCStereoWidening()[protected]
Private C++ constructor for this class.
Since
3.0

Returns: -

~CStereoWidening ( )

IMPORT_C~CStereoWidening()[virtual]

Destructor

Member Function Documentation

DoEffectData ( )

IMPORT_C const TDesC8 &DoEffectData()[protected, virtual]

Reimplemented from CAudioEffect::DoEffectData()

From CAudioEffect Create a package of the effect data
Since
3.0

Returns: A descriptor containing the effect data.

IsContinuousLevelSupported ( )

IMPORT_C TBoolIsContinuousLevelSupported()const
Check if continuous level is supported for stereo widening.
Since
3.0

Returns: ETrue if continuous level is supported for stereo widening. If this returns EFalse, then the adaptation is actually setting the level to the nearest supported discrete value, when SetStereoWidenlingLevelL is called.

NewL ( )

IMPORT_C CStereoWidening *NewL()[static]
Factory function for creating the stereo widening object.
Since
3.0

Returns: pointer to CStereoWidening object

NewL ( CMdaAudioConvertUtility &, TBool, TInt8 )

IMPORT_C CStereoWidening *NewL(CMdaAudioConvertUtility &aUtility,
TBoolaEnable = EFalse,
TInt8aInitialLevel = 0
)[static]
Factory function for creating the stereo widening object.
Since
3.0
ParameterDescription
aUtilityA reference to a convert utility
aEnableIndicate whether the effect will be automatically enabled after creation.
aInitialLevelInitial value of stereo widening to be used when aEnable = ETrue

Returns: pointer to CStereoWidening object

NewL ( CMdaAudioInputStream &, TBool, TInt8 )

IMPORT_C CStereoWidening *NewL(CMdaAudioInputStream &aUtility,
TBoolaEnable = EFalse,
TInt8aInitialLevel = 0
)[static]
Factory function for creating the stereo widening object.
Since
3.0
ParameterDescription
aUtilityA reference to an audio input stream utility
aEnableIndicate whether the effect will be automatically enabled after creation.
aInitialLevelInitial value of stereo widening to be used when aEnable = ETrue

Returns: pointer to CStereoWidening object

NewL ( CMdaAudioOutputStream &, TBool, TInt8 )

IMPORT_C CStereoWidening *NewL(CMdaAudioOutputStream &aUtility,
TBoolaEnable = EFalse,
TInt8aInitialLevel = 0
)[static]
Factory function for creating the stereo widening object.
Since
3.0
ParameterDescription
aUtilityA reference to an audio output stream utility
aEnableIndicate whether the effect will be automatically enabled after creation.
aInitialLevelInitial value of stereo widening to be used when aEnable = ETrue

Returns: pointer to CStereoWidening object

NewL ( CMdaAudioPlayerUtility &, TBool, TInt8 )

IMPORT_C CStereoWidening *NewL(CMdaAudioPlayerUtility &aUtility,
TBoolaEnable = EFalse,
TInt8aInitialLevel = 0
)[static]
Factory function for creating the stereo widening object.
Since
3.0
ParameterDescription
aUtilityA reference to an audio player utility
aEnableIndicate whether the effect will be automatically enabled after creation.
aInitialLevelInitial value of stereo widening to be used when aEnable = ETrue

Returns: pointer to CStereoWidening object

NewL ( CMdaAudioRecorderUtility &, TBool, TBool, TInt8 )

IMPORT_C CStereoWidening *NewL(CMdaAudioRecorderUtility &aUtility,
TBoolaRecordStream,
TBoolaEnable = EFalse,
TInt8aInitialLevel = 0
)[static]
Factory function for creating the stereo widening object.
Since
3.0
ParameterDescription
aUtilityA reference to an audio record utility
aRecordStreamETrue if the effect is to be applied to the recording, EFalse if the effect is to be applied only to the playback
aEnableIndicate whether the effect will be automatically enabled after creation.
aInitialLevelInitial value of stereo widening to be used when aEnable = ETrue

Returns: pointer to CStereoWidening object

NewL ( CMdaAudioToneUtility &, TBool, TInt8 )

IMPORT_C CStereoWidening *NewL(CMdaAudioToneUtility &aUtility,
TBoolaEnable = EFalse,
TInt8aInitialLevel = 0
)[static]
Factory function for creating the stereo widening object.
Since
3.0
ParameterDescription
aUtilityA reference to an audio tone utility
aEnableIndicate whether the effect will be automatically enabled after creation.
aInitialLevelInitial value of stereo widening to be used when aEnable = ETrue

Returns: pointer to CStereoWidening object

NewL ( CMMFDevSound &, TBool, TInt8 )

IMPORT_C CStereoWidening *NewL(CMMFDevSound &aDevSound,
TBoolaEnable = EFalse,
TInt8aInitialLevel = 0
)[static]
Factory function for creating the stereo widening object.
Since
3.0
ParameterDescription
aDevSoundA reference to a DevSound instance
aEnableIndicate whether the effect will be automatically enabled after creation.
aInitialLevelInitial value of stereo widening to be used when aEnable = ETrue

Returns: pointer to CStereoWidening object

NewL ( CCustomCommandUtility *, TBool, TInt8 )

IMPORT_C CStereoWidening *NewL(CCustomCommandUtility *aUtility,
TBoolaEnable = EFalse,
TInt8aInitialLevel = 0
)[static]
Factory function for creating the stereo widening object.
Since
3.0
ParameterDescription
aUtilityA reference to a custom command utility
aEnableIndicate whether the effect will be automatically enabled after creation.
aInitialLevelInitial value of stereo widening to be used when aEnable = ETrue

Returns: pointer to CStereoWidening object

NewL ( MCustomInterface &, TBool, TInt8 )

IMPORT_C CStereoWidening *NewL(MCustomInterface &aCustomInterface,
TBoolaEnable = EFalse,
TInt8aInitialLevel = 0
)[static]
Factory function for creating the stereo widening object.
Since
3.0
ParameterDescription
aCustomInterfaceA reference to a custom interface
aEnableIndicate whether the effect will be automatically enabled after creation.
aInitialLevelInitial value of stereo widening to be used when aEnable = ETrue

Returns: pointer to CStereoWidening object

NewL ( CMidiClientUtility &, TBool, TInt8 )

IMPORT_C CStereoWidening *NewL(CMidiClientUtility &aUtility,
TBoolaEnable = EFalse,
TInt8aInitialLevel = 0
)[static]
Factory function for creating the stereo widening object.
Since
3.0
ParameterDescription
aUtilityA reference to a CMidiClientUtility
aEnableIndicate whether the effect will be automatically enabled after creation.
aInitialLevelInitial value of stereo widening to be used when aEnable = ETrue

Returns: pointer to CStereoWidening object

NewL ( CDrmPlayerUtility &, TBool, TInt8 )

IMPORT_C CStereoWidening *NewL(CDrmPlayerUtility &aUtility,
TBoolaEnable = EFalse,
TInt8aInitialLevel = 0
)[static]
Factory function for creating the stereo widening object.
Since
3.0

Returns: pointer to CStereoWidening object

NewL ( CVideoPlayerUtility &, TBool, TInt8 )

IMPORT_C CStereoWidening *NewL(CVideoPlayerUtility &aUtility,
TBoolaEnable = EFalse,
TInt8aInitialLevel = 0
)[static]
Factory function for creating the stereo widening object.
Since
3.2

Returns: pointer to CStereoWidening object

SetEffectData ( const TDesC8 & )

IMPORT_C voidSetEffectData(const TDesC8 &aEffectDataBuffer)[protected, virtual]
From CAudioEffect Internal function to unpack effect data
Since
3.0
ParameterDescription
aEffectDataBufferDescriptor containing packed effect data

Returns: -

SetStereoWideningLevelL ( TUint8 )

IMPORT_C voidSetStereoWideningLevelL(TUint8aLevel)
Set stereo widening level.
Since
3.0
ParameterDescription
aLevelStereo widening level ranges from 0-100, where 0 is None and 100 is Maximum widening.

StereoWideningLevel ( )

IMPORT_C TUint8StereoWideningLevel()const
Get the stereo widening settings.
Since
3.0

Returns: Level of widening

Uid ( )

IMPORT_C TUidUid()const [virtual]

Reimplemented from CAudioEffect::Uid()const

© Nokia 2011.