CStereoWidening Class Reference

API published in: S60 3rd Ed

Link against: stereowideningeffect.lib

Capability Information

Required Capabilities

None

#include <stereowideningbase.h>

Inherits CAudioEffect.

Detailed Description

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

Public Member Functions

virtual IMPORT_C ~CStereoWidening ()
 Destructor.
IMPORT_C TBool IsContinuousLevelSupported () const
 Check if continuous level is supported for stereo widening.
IMPORT_C void SetStereoWideningLevelL (TUint8 aLevel)
 Set stereo widening level.
IMPORT_C TUint8 StereoWideningLevel () const
 Get the stereo widening settings.
IMPORT_C TUid Uid () const

Static Public Member Functions

static IMPORT_C CStereoWidening * NewL ()
 Factory function for creating the stereo widening object.
static IMPORT_C CStereoWidening * NewL (CMdaAudioConvertUtility &aUtility, TBool aEnable=EFalse, TInt8 aInitialLevel=0)
 Factory function for creating the stereo widening object.
static IMPORT_C CStereoWidening * NewL (CMdaAudioInputStream &aUtility, TBool aEnable=EFalse, TInt8 aInitialLevel=0)
 Factory function for creating the stereo widening object.
static IMPORT_C CStereoWidening * NewL (CMdaAudioOutputStream &aUtility, TBool aEnable=EFalse, TInt8 aInitialLevel=0)
 Factory function for creating the stereo widening object.
static IMPORT_C CStereoWidening * NewL (CMdaAudioPlayerUtility &aUtility, TBool aEnable=EFalse, TInt8 aInitialLevel=0)
 Factory function for creating the stereo widening object.
static IMPORT_C CStereoWidening * NewL (CMdaAudioRecorderUtility &aUtility, TBool aRecordStream, TBool aEnable=EFalse, TInt8 aInitialLevel=0)
 Factory function for creating the stereo widening object.
static IMPORT_C CStereoWidening * NewL (CMdaAudioToneUtility &aUtility, TBool aEnable=EFalse, TInt8 aInitialLevel=0)
 Factory function for creating the stereo widening object.
static IMPORT_C CStereoWidening * NewL (CMMFDevSound &aDevSound, TBool aEnable=EFalse, TInt8 aInitialLevel=0)
 Factory function for creating the stereo widening object.
static IMPORT_C CStereoWidening * NewL (CCustomCommandUtility *aUtility, TBool aEnable=EFalse, TInt8 aInitialLevel=0)
 Factory function for creating the stereo widening object.
static IMPORT_C CStereoWidening * NewL (MCustomInterface &aCustomInterface, TBool aEnable=EFalse, TInt8 aInitialLevel=0)
 Factory function for creating the stereo widening object.
static IMPORT_C CStereoWidening * NewL (CMidiClientUtility &aUtility, TBool aEnable=EFalse, TInt8 aInitialLevel=0)
 Factory function for creating the stereo widening object.
static IMPORT_C CStereoWidening * NewL (CDrmPlayerUtility &aUtility, TBool aEnable=EFalse, TInt8 aInitialLevel=0)
 Factory function for creating the stereo widening object.
static IMPORT_C CStereoWidening * NewL (CVideoPlayerUtility &aUtility, TBool aEnable=EFalse, TInt8 aInitialLevel=0)
 Factory function for creating the stereo widening object.

Protected Member Functions

IMPORT_C const TDesC8 & DoEffectData ()
 From CAudioEffect Create a package of the effect data.
IMPORT_C void SetEffectData (const TDesC8 &aEffectDataBuffer)
 From CAudioEffect Internal function to unpack effect data.
IMPORT_C CStereoWidening ()
 Private C++ constructor for this class.

Protected Attributes

TEfStereoWidening iStereoWideningData
TEfStereoWideningDataPckg iDataPckgTo
TEfStereoWideningDataPckg iDataPckgFrom

Friends

class CStereoWideningMessageHandler

Constructor & Destructor Documentation

virtual IMPORT_C CStereoWidening::~CStereoWidening (   )  [virtual]
 

Destructor.

IMPORT_C CStereoWidening::CStereoWidening (   )  [protected]
 

Private C++ constructor for this class.

Parameters:
aEffectObserver reference to event observer object
Returns:
-

Member Function Documentation

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

From CAudioEffect Create a package of the effect data.

Returns:
A descriptor containing the effect data.

Implements CAudioEffect.

IMPORT_C TBool CStereoWidening::IsContinuousLevelSupported (   )  const
 

Check if continuous level is supported for stereo widening.

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.
static IMPORT_C CStereoWidening* CStereoWidening::NewL ( CVideoPlayerUtility &  aUtility,
TBool  aEnable = EFalse,
TInt8  aInitialLevel = 0
)  [static]
 

Factory function for creating the stereo widening object.

Parameters:
CVideoPlayerUtility A reference to a CVideoPlayerUtility object
Returns:
pointer to CStereoWidening object
static IMPORT_C CStereoWidening* CStereoWidening::NewL ( CDrmPlayerUtility &  aUtility,
TBool  aEnable = EFalse,
TInt8  aInitialLevel = 0
)  [static]
 

Factory function for creating the stereo widening object.

Parameters:
CDrmPlayerUtility A reference to a CDrmPlayerUtility object
Returns:
pointer to CStereoWidening object
static IMPORT_C CStereoWidening* CStereoWidening::NewL ( CMidiClientUtility &  aUtility,
TBool  aEnable = EFalse,
TInt8  aInitialLevel = 0
)  [static]
 

Factory function for creating the stereo widening object.

Parameters:
aUtility A reference to a CMidiClientUtility
aEnable Indicate whether the effect will be automatically enabled after creation.
aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue
Returns:
pointer to CStereoWidening object
static IMPORT_C CStereoWidening* CStereoWidening::NewL ( MCustomInterface &  aCustomInterface,
TBool  aEnable = EFalse,
TInt8  aInitialLevel = 0
)  [static]
 

Factory function for creating the stereo widening object.

Parameters:
aCustomInterface A reference to a custom interface
aEnable Indicate whether the effect will be automatically enabled after creation.
aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue
Returns:
pointer to CStereoWidening object
static IMPORT_C CStereoWidening* CStereoWidening::NewL ( CCustomCommandUtility *  aUtility,
TBool  aEnable = EFalse,
TInt8  aInitialLevel = 0
)  [static]
 

Factory function for creating the stereo widening object.

Parameters:
aUtility A reference to a custom command utility
aEnable Indicate whether the effect will be automatically enabled after creation.
aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue
Returns:
pointer to CStereoWidening object
static IMPORT_C CStereoWidening* CStereoWidening::NewL ( CMMFDevSound &  aDevSound,
TBool  aEnable = EFalse,
TInt8  aInitialLevel = 0
)  [static]
 

Factory function for creating the stereo widening object.

Parameters:
aDevSound A reference to a DevSound instance
aEnable Indicate whether the effect will be automatically enabled after creation.
aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue
Returns:
pointer to CStereoWidening object
static IMPORT_C CStereoWidening* CStereoWidening::NewL ( CMdaAudioToneUtility &  aUtility,
TBool  aEnable = EFalse,
TInt8  aInitialLevel = 0
)  [static]
 

Factory function for creating the stereo widening object.

Parameters:
aUtility A reference to an audio tone utility
aEnable Indicate whether the effect will be automatically enabled after creation.
aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue
Returns:
pointer to CStereoWidening object
static IMPORT_C CStereoWidening* CStereoWidening::NewL ( CMdaAudioRecorderUtility &  aUtility,
TBool  aRecordStream,
TBool  aEnable = EFalse,
TInt8  aInitialLevel = 0
)  [static]
 

Factory function for creating the stereo widening object.

Parameters:
aUtility A reference to an audio record utility
aRecordStream ETrue if the effect is to be applied to the recording, EFalse if the effect is to be applied only to the playback
aEnable Indicate whether the effect will be automatically enabled after creation.
aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue
Returns:
pointer to CStereoWidening object
static IMPORT_C CStereoWidening* CStereoWidening::NewL ( CMdaAudioPlayerUtility &  aUtility,
TBool  aEnable = EFalse,
TInt8  aInitialLevel = 0
)  [static]
 

Factory function for creating the stereo widening object.

Parameters:
aUtility A reference to an audio player utility
aEnable Indicate whether the effect will be automatically enabled after creation.
aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue
Returns:
pointer to CStereoWidening object
static IMPORT_C CStereoWidening* CStereoWidening::NewL ( CMdaAudioOutputStream &  aUtility,
TBool  aEnable = EFalse,
TInt8  aInitialLevel = 0
)  [static]
 

Factory function for creating the stereo widening object.

Parameters:
aUtility A reference to an audio output stream utility
aEnable Indicate whether the effect will be automatically enabled after creation.
aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue
Returns:
pointer to CStereoWidening object
static IMPORT_C CStereoWidening* CStereoWidening::NewL ( CMdaAudioInputStream &  aUtility,
TBool  aEnable = EFalse,
TInt8  aInitialLevel = 0
)  [static]
 

Factory function for creating the stereo widening object.

Parameters:
aUtility A reference to an audio input stream utility
aEnable Indicate whether the effect will be automatically enabled after creation.
aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue
Returns:
pointer to CStereoWidening object
static IMPORT_C CStereoWidening* CStereoWidening::NewL ( CMdaAudioConvertUtility &  aUtility,
TBool  aEnable = EFalse,
TInt8  aInitialLevel = 0
)  [static]
 

Factory function for creating the stereo widening object.

Parameters:
aUtility A reference to a convert utility
aEnable Indicate whether the effect will be automatically enabled after creation.
aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue
Returns:
pointer to CStereoWidening object
static IMPORT_C CStereoWidening* CStereoWidening::NewL (   )  [static]
 

Factory function for creating the stereo widening object.

Returns:
pointer to CStereoWidening object
IMPORT_C void CStereoWidening::SetEffectData ( const TDesC8 &  aEffectDataBuffer  )  [protected, virtual]
 

From CAudioEffect Internal function to unpack effect data.

Parameters:
aEffectDataBuffer Descriptor containing packed effect data
Returns:
-

Implements CAudioEffect.

IMPORT_C void CStereoWidening::SetStereoWideningLevelL ( TUint8  aLevel  ) 
 

Set stereo widening level.

Parameters:
aLevel Stereo widening level ranges from 0-100, where 0 is None and 100 is Maximum widening.
IMPORT_C TUint8 CStereoWidening::StereoWideningLevel (   )  const
 

Get the stereo widening settings.

Returns:
Level of widening
IMPORT_C TUid CStereoWidening::Uid (   )  const [virtual]
 

Implements CAudioEffect.

Friends And Related Function Documentation

friend class CStereoWideningMessageHandler [friend]
 

Field Documentation

TEfStereoWideningDataPckg CStereoWidening::iDataPckgFrom [protected]
 
TEfStereoWideningDataPckg CStereoWidening::iDataPckgTo [protected]
 
TEfStereoWidening CStereoWidening::iStereoWideningData [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top