CBassBoost Class Reference

API published in: S60 3rd Ed

Link against: bassboosteffect.lib

Capability Information

Required Capabilities

None

#include <bassboostbase.h>

Inherits CAudioEffect.

Detailed Description

This is the bass boost effect class for managing audio bass boost settings.

Public Member Functions
virtual IMPORT_C  ~CBassBoost ()
  Destructor.
IMPORT_C TUid  Uid () const

Static Public Member Functions
static IMPORT_C CBassBoost *  NewL (CMMFDevSound &aDevSound, TBool aEnable=EFalse)
  Factory function for creating the bass boost object.
static IMPORT_C CBassBoost *  NewL (CMdaAudioConvertUtility &aUtility, TBool aEnable=EFalse)
  Factory function for creating the bass boost object.
static IMPORT_C CBassBoost *  NewL (CMdaAudioInputStream &aUtility, TBool aEnable=EFalse)
  Factory function for creating the bass boost object.
static IMPORT_C CBassBoost *  NewL (CMdaAudioOutputStream &aUtility, TBool aEnable=EFalse)
  Factory function for creating the bass boost object.
static IMPORT_C CBassBoost *  NewL (CMdaAudioPlayerUtility &aUtility, TBool aEnable=EFalse)
  Factory function for creating the bass boost object.
static IMPORT_C CBassBoost *  NewL (CMdaAudioRecorderUtility &aUtility, TBool aRecordStream, TBool aEnable=EFalse)
  Factory function for creating the bass boost object.
static IMPORT_C CBassBoost *  NewL (CMdaAudioToneUtility &aUtility, TBool aEnable=EFalse)
  Factory function for creating the bass boost object.
static IMPORT_C CBassBoost *  NewL (CCustomCommandUtility *aUtility, TBool aEnable=EFalse)
  Factory function for creating the bass boost object.
static IMPORT_C CBassBoost *  NewL (MCustomInterface &aCustomInterface, TBool aEnable=EFalse)
  Factory function for creating the bass boost object.
static IMPORT_C CBassBoost *  NewL (CMidiClientUtility &aUtility, TBool aEnable=EFalse)
  Factory function for creating the bass boost object.
static IMPORT_C CBassBoost *  NewL (CDrmPlayerUtility &aUtility, TBool aEnable=EFalse)
  Factory function for creating the bass boost object.
static IMPORT_C CBassBoost *  NewL (CVideoPlayerUtility &aUtility, TBool aEnable=EFalse)
  Factory function for creating the bass boost 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  CBassBoost ()
  Private C++ constructor for this class.

Protected Attributes
TEfBassBoostData  iBassBoostData
TEfBassBoostDataPckg  iDataPckgTo
TEfBassBoostDataPckg  iDataPckgFrom

Friends
class  CBassBoostMessageHandler

Constructor & Destructor Documentation

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

Destructor.

IMPORT_C CBassBoost::CBassBoost (   )  [protected]
 

Private C++ constructor for this class.

Parameters:
aEffectObserver  reference to event observer object
Returns:
-

Member Function Documentation

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

From CAudioEffect Create a package of the effect data.

Returns:
A descriptor containing the effect data.

Implements CAudioEffect.

static IMPORT_C CBassBoost* CBassBoost::NewL (  CVideoPlayerUtility &  aUtility,
TBool  aEnable = EFalse
)  [static]
 

Factory function for creating the bass boost object.

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

Factory function for creating the bass boost object.

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

Factory function for creating the bass boost object.

Parameters:
aUtility  A reference to a CMidiClientUtility
aEnable  Indicate whether the effect will be automatically enabled after creation.
Returns:
pointer to CBassBoost object
static IMPORT_C CBassBoost* CBassBoost::NewL (  MCustomInterface &  aCustomInterface,
TBool  aEnable = EFalse
)  [static]
 

Factory function for creating the bass boost object.

Parameters:
aCustomInterface  A reference to a custom interface
aEnable  Indicate whether the effect will be automatically enabled after creation.
Returns:
pointer to CBassBoost object
static IMPORT_C CBassBoost* CBassBoost::NewL (  CCustomCommandUtility *  aUtility,
TBool  aEnable = EFalse
)  [static]
 

Factory function for creating the bass boost object.

Parameters:
aUtility  A reference to a custom command utility
aEnable  Indicate whether the effect will be automatically enabled after creation.
Returns:
pointer to CBassBoost object
static IMPORT_C CBassBoost* CBassBoost::NewL (  CMdaAudioToneUtility &  aUtility,
TBool  aEnable = EFalse
)  [static]
 

Factory function for creating the bass boost object.

Parameters:
aUtility  A reference to an audio tone utility
aEnable  Indicate whether the effect will be automatically enabled after creation.
Returns:
pointer to CBassBoost object
static IMPORT_C CBassBoost* CBassBoost::NewL (  CMdaAudioRecorderUtility &  aUtility,
TBool  aRecordStream,
TBool  aEnable = EFalse
)  [static]
 

Factory function for creating the bass boost 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.
Returns:
pointer to CBassBoost object
static IMPORT_C CBassBoost* CBassBoost::NewL (  CMdaAudioPlayerUtility &  aUtility,
TBool  aEnable = EFalse
)  [static]
 

Factory function for creating the bass boost object.

Parameters:
aUtility  A reference to an audio player utility
aEnable  Indicate whether the effect will be automatically enabled after creation.
Returns:
pointer to CBassBoost object
static IMPORT_C CBassBoost* CBassBoost::NewL (  CMdaAudioOutputStream &  aUtility,
TBool  aEnable = EFalse
)  [static]
 

Factory function for creating the bass boost object.

Parameters:
aUtility  A reference to an audio output stream utility
aEnable  Indicate whether the effect will be automatically enabled after creation.
Returns:
pointer to CBassBoost object
static IMPORT_C CBassBoost* CBassBoost::NewL (  CMdaAudioInputStream &  aUtility,
TBool  aEnable = EFalse
)  [static]
 

Factory function for creating the bass boost object.

Parameters:
aUtility  A reference to an audio input stream utility
aEnable  Indicate whether the effect will be automatically enabled after creation.
Returns:
pointer to CBassBoost object
static IMPORT_C CBassBoost* CBassBoost::NewL (  CMdaAudioConvertUtility &  aUtility,
TBool  aEnable = EFalse
)  [static]
 

Factory function for creating the bass boost object.

Parameters:
aUtility  A reference to an audio convert utility
aEnable  Indicate whether the effect will be automatically enabled after creation.
Returns:
pointer to CBassBoost object
static IMPORT_C CBassBoost* CBassBoost::NewL (  CMMFDevSound &  aDevSound,
TBool  aEnable = EFalse
)  [static]
 

Factory function for creating the bass boost object.

Parameters:
aDevSound  A reference to a DevSound instance
aEnable  Indicate whether the effect will be automatically enabled after creation.
Returns:
pointer to CBassBoost object
IMPORT_C void CBassBoost::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 TUid CBassBoost::Uid (   )  const [virtual]
 

Implements CAudioEffect.

Friends And Related Function Documentation

friend class CBassBoostMessageHandler [friend]
 

Field Documentation

TEfBassBoostData CBassBoost::iBassBoostData [protected]
 
TEfBassBoostDataPckg CBassBoost::iDataPckgFrom [protected]
 
TEfBassBoostDataPckg CBassBoost::iDataPckgTo [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top