MSpeechEncoderConfig Class Reference

#include <mmf/server/devsoundstandardcustominterfaces.h>

class MSpeechEncoderConfig
Public Member Functions
pure virtual TInt GetVadMode(TBool &)
pure virtual TInt SetVadMode(TBool)

Detailed Description

This class provides an interface to those CMMFHwDevices providing speech encoding. This interface is used for querying and configuring the operational modes of speech encoders as supported by those specific encoders. If a speech encoder does not support a mode provided by the interface, it will return KErrNotSupported.

Member Function Documentation

GetVadMode ( TBool & )

TInt GetVadMode(TBool &aVadModeOn)[pure virtual]

Gets the current state of the voice activity detection (VAD) mode. This method can be called at all times - while actively encoding or not.

ParameterDescription
aVadModeOnOn output ETrue = On, EFalse = Off

Returns: KErrNone if successful, KErrNotSupported if this method is not implemented or not supported by the encoder.

SetVadMode ( TBool )

TInt SetVadMode(TBoolaVadModeOn)[pure virtual]

Controls voice activity detection (VAD) mode. This method can be called at all times - while actively encoding or not. It should be noted that a VAD mode change could also instigate a change in the mode of encoding (fixed rate encoding versus variable rate) e.g. in cases where VAD requires variable rate encoding. The effects of activating VAD mode behaviour should be documented in the CMMFHwDevice specification implementing it.

ParameterDescription
aVadModeOnETrue=On, EFalse=Off

Returns: KErrNone if successful. KErrNotSupported if this method is not implemented or not supported by the encoder.