multimedia::MRoomLevelControl Class Reference

class multimedia::MRoomLevelControl : public multimedia::MAudioEffectControl

Member Functions Documentation

AttachReverb(MReverbControl &)

TInt AttachReverb ( MReverbControl & aReverb ) [pure virtual]

Links Room Level Control to Reverb Control object. Room Level control cannot be used independently, A reverb control has to be attached to it always. Reverb Control object should be added to MStreamControl before adding Room Level Control to MStreamControl .

Usage: CREATION SEQUENCE // 1. Create MReverbControl and MRoomLevelControl from factory // 2. Attach room level to reverb MRoomLevelControl::AttachReverb(MReverbControl); // 3. Add effects in the following order MStreamControl::AddEffect(MReverbControl); MStreamControl::AddEffect(MRoomLevelControl);

DELETION SEQUENCE MRoomLevelControl->DetachReverb(*iEnvRev); MStreamControl->RemoveEffect( MRoomLevelControl ); MStreamControl->RemoveEffect( MReverbControl );

Since
5.0

Parameters

MReverbControl & aReverb

DetachReverb(MReverbControl &)

TInt DetachReverb ( MReverbControl & aReverb ) [pure virtual]
Delinks Room Level Control to Reverb Control object.
Since
5.0

Parameters

MReverbControl & aReverb

Level(TInt &)

TInt Level ( TInt & aLevel ) [pure virtual]
Gets the RoomLevel current level in mB
Since
5.0

Parameters

TInt & aLevel

LevelRange(TInt &, TInt &)

TInt LevelRange ( TInt & aMin,
TInt & aMax
) [pure virtual]
Gets the RoomLevel current level maximum and minimum in mB
Since
5.0

Parameters

TInt & aMin Minimum current level
TInt & aMax Maximum current level

SetRoomLevel(TInt)

TInt SetRoomLevel ( TInt aRoomLevel ) [pure virtual]
Sets the RoomLevel level, it will leave if aRoomLevel is not within range of Min and Max
Since
5.0

Parameters

TInt aRoomLevel

Member Data Documentation

const TUint KRoomLevelChanged

const TUint KRoomLevelChanged [static]