Photon C++ Client API  5.0.7.3
Public Member Functions | List of all members
LocalVoiceAudio< T > Class Template Reference

Outgoing audio stream. More...

Inheritance diagram for LocalVoiceAudio< T >:
Inheritance graph
[legend]
Collaboration diagram for LocalVoiceAudio< T >:
Collaboration graph
[legend]

Public Member Functions

virtual AudioUtil::IVoiceDetectorgetVoiceDetector (void) const
 The VoiceDetector in use. More...
 
virtual AudioUtil::ILevelMetergetLevelMeter (void) const
 The LevelMeter utility in use. More...
 
virtual bool getIsVoiceDetectorCalibrating (void) const
 True if the VoiceDetector is currently calibrating. More...
 
virtual void voiceDetectorCalibrate (int durationMs)
 Trigger voice detector calibration process. More...
 
- Public Member Functions inherited from LocalVoiceFramed< T >
int getFrameSize (void) const
 
void addPostProcessor (Common::Helpers::SharedPointer< IProcessor< T > > processor)
 Adds the processor that is provided as a parameter after any built-in processors and everything added with addPreProcessor(). More...
 
void addPreProcessor (Common::Helpers::SharedPointer< IProcessor< T > > processor)
 Adds the processor that is provided as a parameter before the built-in processors and everything added with addPostProcessor(). More...
 
void clearProcessors (void)
 Clears all processors in pipeline including built-in resampling. User should add at least resampler processor after call. More...
 
bool isPushDataAsyncReady (void)
 Wether this LocalVoiceFramed has capacity for more data buffers to be pushed asynchronously. More...
 
void pushDataAsync (const Buffer< T > &buf)
 Asynchronously push data into this stream. More...
 
void pushData (const Buffer< T > &buf)
 Synchronously push data into this stream. More...
 

Detailed Description

template<typename T>
class ExitGames::Voice::LocalVoiceAudio< T >

Outgoing audio stream.

Member Function Documentation

◆ getVoiceDetector()

AudioUtil::IVoiceDetector * getVoiceDetector ( void  ) const
virtual

The VoiceDetector in use.

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

Implements ILocalVoiceAudio.

◆ getLevelMeter()

AudioUtil::ILevelMeter * getLevelMeter ( void  ) const
virtual

The LevelMeter utility in use.

Implements ILocalVoiceAudio.

◆ getIsVoiceDetectorCalibrating()

bool getIsVoiceDetectorCalibrating ( void  ) const
virtual

True if the VoiceDetector is currently calibrating.

Implements ILocalVoiceAudio.

◆ voiceDetectorCalibrate()

void voiceDetectorCalibrate ( int  durationMs)
virtual

Trigger voice detector calibration process.

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

Parameters
durationMsDuration of calibration in milliseconds.

Implements ILocalVoiceAudio.