Symbian^3 Application Developer Library >

CStereoWidening Class Reference

class CStereoWidening : public CAudioEffect

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

StereoWidening.lib
Since
3.0

Inherits from

Public Member Functions
~CStereoWidening ()
IMPORT_C TBool IsContinuousLevelSupported ()
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 void SetStereoWideningLevelL ( TUint8 )
IMPORT_C TUint8 StereoWideningLevel ()
IMPORT_C TUid Uid ()
Protected Member Functions
CStereoWidening ()
IMPORT_C const TDesC8 & DoEffectData ()
IMPORT_C void SetEffectData (const TDesC8 &)
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()
Protected Attributes
TEfStereoWideningDataPckg iDataPckgFrom
TEfStereoWideningDataPckg iDataPckgTo
TEfStereoWidening iStereoWideningData
Inherited Attributes
CAudioEffect::iEnabled
CAudioEffect::iEnforced
CAudioEffect::iHaveUpdateRights
CAudioEffect::iObservers

Constructor & Destructor Documentation

CStereoWidening()

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

~CStereoWidening()

IMPORT_C ~CStereoWidening ( ) [virtual]

Destructor

Member Functions Documentation

DoEffectData()

IMPORT_C const TDesC8 & DoEffectData ( ) [protected, virtual]
From CAudioEffect Create a package of the effect data
Since
3.0

IsContinuousLevelSupported()

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

NewL()

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

NewL(CMdaAudioConvertUtility &, TBool, TInt8)

IMPORT_C CStereoWidening * NewL ( CMdaAudioConvertUtility & aUtility,
TBool aEnable = EFalse,
TInt8 aInitialLevel = 0
) [static]
Factory function for creating the stereo widening object.
Since
3.0

Parameters

CMdaAudioConvertUtility & aUtility A reference to a convert utility
TBool aEnable = EFalse Indicate whether the effect will be automatically enabled after creation.
TInt8 aInitialLevel = 0 Initial value of stereo widening to be used when aEnable = ETrue

NewL(CMdaAudioInputStream &, TBool, TInt8)

IMPORT_C CStereoWidening * NewL ( CMdaAudioInputStream & aUtility,
TBool aEnable = EFalse,
TInt8 aInitialLevel = 0
) [static]
Factory function for creating the stereo widening object.
Since
3.0

Parameters

CMdaAudioInputStream & aUtility A reference to an audio input stream utility
TBool aEnable = EFalse Indicate whether the effect will be automatically enabled after creation.
TInt8 aInitialLevel = 0 Initial value of stereo widening to be used when aEnable = ETrue

NewL(CMdaAudioOutputStream &, TBool, TInt8)

IMPORT_C CStereoWidening * NewL ( CMdaAudioOutputStream & aUtility,
TBool aEnable = EFalse,
TInt8 aInitialLevel = 0
) [static]
Factory function for creating the stereo widening object.
Since
3.0

Parameters

CMdaAudioOutputStream & aUtility A reference to an audio output stream utility
TBool aEnable = EFalse Indicate whether the effect will be automatically enabled after creation.
TInt8 aInitialLevel = 0 Initial value of stereo widening to be used when aEnable = ETrue

NewL(CMdaAudioPlayerUtility &, TBool, TInt8)

IMPORT_C CStereoWidening * NewL ( CMdaAudioPlayerUtility & aUtility,
TBool aEnable = EFalse,
TInt8 aInitialLevel = 0
) [static]
Factory function for creating the stereo widening object.
Since
3.0

Parameters

CMdaAudioPlayerUtility & aUtility A reference to an audio player utility
TBool aEnable = EFalse Indicate whether the effect will be automatically enabled after creation.
TInt8 aInitialLevel = 0 Initial value of stereo widening to be used when aEnable = ETrue

NewL(CMdaAudioRecorderUtility &, TBool, TBool, TInt8)

IMPORT_C CStereoWidening * NewL ( CMdaAudioRecorderUtility & aUtility,
TBool aRecordStream,
TBool aEnable = EFalse,
TInt8 aInitialLevel = 0
) [static]
Factory function for creating the stereo widening object.
Since
3.0

Parameters

CMdaAudioRecorderUtility & aUtility A reference to an audio record utility
TBool aRecordStream ETrue if the effect is to be applied to the recording, EFalse if the effect is to be applied only to the playback
TBool aEnable = EFalse Indicate whether the effect will be automatically enabled after creation.
TInt8 aInitialLevel = 0 Initial value of stereo widening to be used when aEnable = ETrue

NewL(CMdaAudioToneUtility &, TBool, TInt8)

IMPORT_C CStereoWidening * NewL ( CMdaAudioToneUtility & aUtility,
TBool aEnable = EFalse,
TInt8 aInitialLevel = 0
) [static]
Factory function for creating the stereo widening object.
Since
3.0

Parameters

CMdaAudioToneUtility & aUtility A reference to an audio tone utility
TBool aEnable = EFalse Indicate whether the effect will be automatically enabled after creation.
TInt8 aInitialLevel = 0 Initial value of stereo widening to be used when aEnable = ETrue

NewL(CMMFDevSound &, TBool, TInt8)

IMPORT_C CStereoWidening * NewL ( CMMFDevSound & aDevSound,
TBool aEnable = EFalse,
TInt8 aInitialLevel = 0
) [static]
Factory function for creating the stereo widening object.
Since
3.0

Parameters

CMMFDevSound & aDevSound A reference to a DevSound instance
TBool aEnable = EFalse Indicate whether the effect will be automatically enabled after creation.
TInt8 aInitialLevel = 0 Initial value of stereo widening to be used when aEnable = ETrue

NewL(CCustomCommandUtility *, TBool, TInt8)

IMPORT_C CStereoWidening * NewL ( CCustomCommandUtility * aUtility,
TBool aEnable = EFalse,
TInt8 aInitialLevel = 0
) [static]
Factory function for creating the stereo widening object.
Since
3.0

Parameters

CCustomCommandUtility * aUtility A reference to a custom command utility
TBool aEnable = EFalse Indicate whether the effect will be automatically enabled after creation.
TInt8 aInitialLevel = 0 Initial value of stereo widening to be used when aEnable = ETrue

NewL(MCustomInterface &, TBool, TInt8)

IMPORT_C CStereoWidening * NewL ( MCustomInterface & aCustomInterface,
TBool aEnable = EFalse,
TInt8 aInitialLevel = 0
) [static]
Factory function for creating the stereo widening object.
Since
3.0

Parameters

MCustomInterface & aCustomInterface A reference to a custom interface
TBool aEnable = EFalse Indicate whether the effect will be automatically enabled after creation.
TInt8 aInitialLevel = 0 Initial value of stereo widening to be used when aEnable = ETrue

NewL(CMidiClientUtility &, TBool, TInt8)

IMPORT_C CStereoWidening * NewL ( CMidiClientUtility & aUtility,
TBool aEnable = EFalse,
TInt8 aInitialLevel = 0
) [static]
Factory function for creating the stereo widening object.
Since
3.0

Parameters

CMidiClientUtility & aUtility A reference to a CMidiClientUtility
TBool aEnable = EFalse Indicate whether the effect will be automatically enabled after creation.
TInt8 aInitialLevel = 0 Initial value of stereo widening to be used when aEnable = ETrue

NewL(CDrmPlayerUtility &, TBool, TInt8)

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

Parameters

CDrmPlayerUtility & aUtility
TBool aEnable = EFalse
TInt8 aInitialLevel = 0

NewL(CVideoPlayerUtility &, TBool, TInt8)

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

Parameters

CVideoPlayerUtility & aUtility
TBool aEnable = EFalse
TInt8 aInitialLevel = 0

SetEffectData(const TDesC8 &)

IMPORT_C void SetEffectData ( const TDesC8 & aEffectDataBuffer ) [protected, virtual]
From CAudioEffect Internal function to unpack effect data
Since
3.0

Parameters

const TDesC8 & aEffectDataBuffer Descriptor containing packed effect data

SetStereoWideningLevelL(TUint8)

IMPORT_C void SetStereoWideningLevelL ( TUint8 aLevel )
Set stereo widening level.
Since
3.0

Parameters

TUint8 aLevel Stereo widening level ranges from 0-100, where 0 is None and 100 is Maximum widening.

StereoWideningLevel()

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

Uid()

IMPORT_C TUid Uid ( ) const [virtual]

Member Data Documentation

TEfStereoWideningDataPckg iDataPckgFrom

TEfStereoWideningDataPckg iDataPckgFrom [protected]

TEfStereoWideningDataPckg iDataPckgTo

TEfStereoWideningDataPckg iDataPckgTo [protected]

TEfStereoWidening iStereoWideningData

TEfStereoWidening iStereoWideningData [protected]

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.