Photon Voice: LocalVoiceAudioDummy Class Reference

Photon Voice

Dummy LocalVoiceAudio More...

Inherits LocalVoice, and ILocalVoiceAudio.

Public Member Functions

void VoiceDetectorCalibrate (int durationMs)
 Trigger voice detector calibration process. More...
 
- Public Member Functions inherited from LocalVoice
virtual IEncoder CreateDefaultEncoder (VoiceInfo info)
 
void RemoveSelf ()
 Remove this voice from it's VoiceClient (using VoiceClient.RemoveLocalVoice More...
 
virtual void Dispose ()
 

Static Public Attributes

static LocalVoiceAudioDummy Dummy = new LocalVoiceAudioDummy()
 A Dummy LocalVoiceAudio instance. More...
 

Properties

AudioUtil.IVoiceDetector VoiceDetector [get]
 
AudioUtil.ILevelMeter LevelMeter [get]
 
bool VoiceDetectorCalibrating [get]
 
- Properties inherited from LocalVoice
byte Group [get, set]
 
byte InterestGroup [get, set]
 If InterestGroup != 0, voice's data is sent only to clients listening to this group (if supported by transport). More...
 
VoiceInfo Info [get]
 Returns Info structure assigned on local voice cration. More...
 
bool TransmitEnabled [get, set]
 If true, stream data broadcasted. More...
 
bool IsCurrentlyTransmitting [get, protected set]
 Returns true if stream broadcasts. More...
 
int FramesSent [get]
 Sent frames counter. More...
 
int FramesSentBytes [get]
 Sent frames bytes counter. More...
 
bool Reliable [get, set]
 Send data reliable. More...
 
bool Encrypt [get, set]
 Send data encrypted. More...
 
IServiceable LocalUserServiceable [get, set]
 Optional user object attached to LocalVoice. its Service() will be called at each VoiceClient.Service() call. More...
 
bool DebugEchoMode [get, set]
 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...
 
- Properties inherited from ILocalVoiceAudio
AudioUtil.IVoiceDetector VoiceDetector [get]
 The VoiceDetector in use. More...
 
AudioUtil.ILevelMeter LevelMeter [get]
 The LevelMeter utility in use. More...
 
bool VoiceDetectorCalibrating [get]
 If true, voice detector calibration is in progress. More...
 

Additional Inherited Members

- Public Attributes inherited from LocalVoice
const int DATA_POOL_CAPACITY = 50
 
- Protected Member Functions inherited from LocalVoice
void resetNoTransmitCnt ()
 
- Protected Attributes inherited from LocalVoice
IEncoder encoder
 
VoiceClient voiceClient
 
volatile bool disposed
 
object disposeLock = new object()
 

Detailed Description

Dummy LocalVoiceAudio

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

Member Function Documentation

void VoiceDetectorCalibrate ( int  durationMs)

Trigger voice detector calibration process.

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

Parameters
durationMsDuration of calibration (in milliseconds).

Implements ILocalVoiceAudio.

Member Data Documentation

A Dummy LocalVoiceAudio instance.

Online Documentation  -  Dashboard  -  Support Forum Exit Games GmbH