Photon C++ Client API  5.0.7.3
Public Member Functions | Static Public Member Functions | List of all members
LocalVoiceAudioDummy Class Reference

Dummy LocalVoiceAudio More...

Inheritance diagram for LocalVoiceAudioDummy:
Inheritance graph
[legend]
Collaboration diagram for LocalVoiceAudioDummy:
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
 If true, voice detector calibration is in progress. More...
 
virtual void voiceDetectorCalibrate (int durationMs)
 Trigger voice detector calibration process. More...
 
- Public Member Functions inherited from LocalVoice
void removeSelf (void)
 Remove this voice from it's VoiceClient (using VoiceClient.RemoveLocalVoice More...
 
nByte getId (void) const
 
int getChannelId (void) const
 
const VoiceInfogetInfo (void) const
 Returns Info structure assigned on local voice cration. More...
 
nByte getEvNumber (void) const
 
bool getReliable (void) const
 Send data reliable. More...
 
void setReliable (bool reliable)
 
bool getEncrypt (void) const
 Send data encrypted. More...
 
void setEncrypt (bool encrypt)
 
nByte getInterestGroup (void) const
 If InterestGroup != 0, voice's data is sent only to clients listening to this group. More...
 
void setInterestGroup (nByte group)
 
bool getTransmitEnabled (void) const
 
void setTransmitEnabled (bool transmitEnabled)
 
bool getIsCurrentlyTransmitting (void) const
 Returns true if stream broadcasts. More...
 
int getFramesSent (void) const
 Sent frames counter. More...
 
int getFramesSentBytes (void) const
 Sent frames bytes counter. More...
 
bool getDebugEchoMode (void) const
 If true, outgoing stream routed back to client via server same way as for remote client's streams. Can be swithed any time. OnRemoteVoiceInfoAction and OnRemoteVoiceRemoveAction are triggered if required. This functionality availability depends on transport. More...
 
void setDebugEchoMode (bool debugEchoMode)
 
const ILoggergetLogger (void) const
 
Common::JString getName (void) const
 
Common::JString getLogPrefix (void) const
 
virtual Common::JStringtoString (Common::JString &retStr, bool withTypes=false) const
 
virtual JStringtoString (JString &retStr, bool withTypes=false) const=0
 
JString toString (bool withTypes=false) const
 
- Public Member Functions inherited from ToString
virtual ~ToString (void)
 
virtual JString typeToString (void) const
 
JString toString (bool withTypes=false) const
 

Static Public Member Functions

static LocalVoiceAudioDummygetDummy (void)
 

Additional Inherited Members

- Static Public Attributes inherited from LocalVoice
static const int DATA_POOL_CAPACITY
 

Detailed Description

Dummy LocalVoiceAudio

For testing, this LocalVoiceAudio implementation features a AudioUtil::VoiceDetectorDummy and a AudioUtil.LevelMeterDummy

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

If true, voice detector calibration is in progress.

Implements ILocalVoiceAudio.

◆ voiceDetectorCalibrate()

void voiceDetectorCalibrate ( int  durationMs)
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).

Implements ILocalVoiceAudio.