Photon C++ Client API  5.0.7.3
Public Member Functions | List of all members
ILocalVoiceAudio Class Referenceabstract

Interface for an outgoing audio stream. More...

Inheritance diagram for ILocalVoiceAudio:
Inheritance graph
[legend]

Public Member Functions

virtual AudioUtil::IVoiceDetectorgetVoiceDetector (void) const =0
 The VoiceDetector in use. More...
 
virtual AudioUtil::ILevelMetergetLevelMeter (void) const =0
 The LevelMeter utility in use. More...
 
virtual bool getIsVoiceDetectorCalibrating (void) const =0
 If true, voice detector calibration is in progress. More...
 
virtual void voiceDetectorCalibrate (int durationMs)=0
 Trigger voice detector calibration process. More...
 

Detailed Description

Interface for an outgoing audio stream.

A LocalVoice always brings a LevelMeter and a VoiceDetector, which you can access using this interface.

Member Function Documentation

◆ getVoiceDetector()

virtual AudioUtil::IVoiceDetector* getVoiceDetector ( void  ) const
pure virtual

The VoiceDetector in use.

Use it to enable or disable voice detector and set its parameters.

Implemented in LocalVoiceAudioDummy, and LocalVoiceAudio< T >.

◆ getLevelMeter()

virtual AudioUtil::ILevelMeter* getLevelMeter ( void  ) const
pure virtual

The LevelMeter utility in use.

Implemented in LocalVoiceAudioDummy, and LocalVoiceAudio< T >.

◆ getIsVoiceDetectorCalibrating()

virtual bool getIsVoiceDetectorCalibrating ( void  ) const
pure virtual

If true, voice detector calibration is in progress.

Implemented in LocalVoiceAudioDummy, and LocalVoiceAudio< T >.

◆ voiceDetectorCalibrate()

virtual void voiceDetectorCalibrate ( int  durationMs)
pure virtual

Trigger voice detector calibration process.

While calibrating, keep silence. Voice detector sets threshold based on measured background noise level.

Parameters
durationMsDuration of calibration (in milliseconds).

Implemented in LocalVoiceAudioDummy, and LocalVoiceAudio< T >.