S60 3rd Edition API Reference: CLoudness Class Reference

CLoudness Class Reference

API published in: S60 3rd Ed

Link against: loudnesseffect.lib

#include <loudnessbase.h>

Inherits CAudioEffect.

Detailed Description

This is the Loudness effect class for managing audio Loudness settings.

Public Member Functions

virtual IMPORT_C ~CLoudness ()
 Destructor.
IMPORT_C TUid Uid () const

Static Public Member Functions

static IMPORT_C CLoudness * NewL (CMdaAudioConvertUtility &aUtility)
 Factory function for creating the audio Loudness object.
static IMPORT_C CLoudness * NewL (CMdaAudioInputStream &aUtility, TBool aEnable=EFalse)
 Factory function for creating the Loudness object.
static IMPORT_C CLoudness * NewL (CMdaAudioOutputStream &aUtility, TBool aEnable=EFalse)
 Factory function for creating the Loudness object.
static IMPORT_C CLoudness * NewL (CMdaAudioPlayerUtility &aUtility, TBool aEnable=EFalse)
 Factory function for creating the Loudness object.
static IMPORT_C CLoudness * NewL (CMdaAudioRecorderUtility &aUtility, TBool aRecordStream, TBool aEnable=EFalse)
 Factory function for creating the Loudness object.
static IMPORT_C CLoudness * NewL (CMdaAudioToneUtility &aUtility, TBool aEnable=EFalse)
 Factory function for creating the Loudness object.
static IMPORT_C CLoudness * NewL (CMMFDevSound &aDevSound, TBool aEnable=EFalse)
 Factory function for creating the Loudness object.
static IMPORT_C CLoudness * NewL (CCustomCommandUtility *aUtility, TBool aEnable=EFalse)
 Factory function for creating the Loudness object.
static IMPORT_C CLoudness * NewL (MCustomInterface &aCustomInterface, TBool aEnable=EFalse)
 Factory function for creating the Loudness object.
static IMPORT_C CLoudness * NewL (CMidiClientUtility &aUtility, TBool aEnable=EFalse)
 Factory function for creating the Loudness 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 CLoudness ()
 Private C++ constructor for this class.

Protected Attributes

TEfLoudnessData iLoudnessData
TEfLoudnessDataPckg iDataPckgTo
TEfLoudnessDataPckg iDataPckgFrom

Friends

class CLoudnessMessageHandler

Constructor & Destructor Documentation

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

Destructor.

IMPORT_C CLoudness::CLoudness (   )  [protected]
 

Private C++ constructor for this class.

Parameters:
aEffectObserver reference to event observer object
Returns:
-

Member Function Documentation

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

From CAudioEffect Create a package of the effect data.

Returns:
A descriptor containing the effect data.

Implements CAudioEffect.

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

Factory function for creating the Loudness object.

Public since 3rd Ed FP1

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

Factory function for creating the Loudness object.

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

Factory function for creating the Loudness object.

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

Factory function for creating the Loudness object.

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

Factory function for creating the Loudness object.

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

Factory function for creating the Loudness 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 CLoudness object
static IMPORT_C CLoudness* CLoudness::NewL ( CMdaAudioPlayerUtility &  aUtility,
TBool  aEnable = EFalse
)  [static]
 

Factory function for creating the Loudness object.

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

Factory function for creating the Loudness 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 CLoudness object
static IMPORT_C CLoudness* CLoudness::NewL ( CMdaAudioInputStream &  aUtility,
TBool  aEnable = EFalse
)  [static]
 

Factory function for creating the Loudness 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 CLoudness object
static IMPORT_C CLoudness* CLoudness::NewL ( CMdaAudioConvertUtility &  aUtility  )  [static]
 

Factory function for creating the audio Loudness object.

Parameters:
aUtility A reference to a convert utility
Returns:
pointer to CLoudness object
IMPORT_C void CLoudness::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 CLoudness::Uid (   )  const [virtual]
 

Implements CAudioEffect.

Friends And Related Function Documentation

friend class CLoudnessMessageHandler [friend]
 

Field Documentation

TEfLoudnessDataPckg CLoudness::iDataPckgFrom [protected]
 
TEfLoudnessDataPckg CLoudness::iDataPckgTo [protected]
 
TEfLoudnessData CLoudness::iLoudnessData [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top