Photon Voice v2.53

Public Member Functions | Static Public Attributes | Properties | List of all members
LocalVoiceAudioDummy Class Reference

Dummy LocalVoiceAudio More...

Inherits LocalVoice, and ILocalVoiceAudio.

Public Member Functions

void VoiceDetectorCalibrate (int durationMs, Action< float > onCalibrated=null)
 Trigger voice detector calibration process. More...
 
- Public Member Functions inherited from LocalVoice
void SendSpacingProfileStart ()
 
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...
 
- Static Public Attributes inherited from LocalVoice
const int DATA_POOL_CAPACITY = 50
 

Properties

AudioUtil.IVoiceDetector VoiceDetector [get]
 
AudioUtil.ILevelMeter LevelMeter [get]
 
bool VoiceDetectorCalibrating [get]
 
- Properties inherited from LocalVoice
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]
 Returns true if stream broadcasts. More...
 
int FramesSent [get]
 Sent frames counter. More...
 
int FramesSentFragmented [get]
 Sent fragmented frames counter. More...
 
int FramesSentFragments [get]
 Sent frames fragments counter. More...
 
int FramesSentBytes [get]
 Sent frames bytes counter. More...
 
bool Reliable [get, set]
 Send data reliable. See also VoiceCreateOptions.Reliable. More...
 
bool Encrypt [get, set]
 Send data encrypted. See also VoiceCreateOptions.Encrypt. More...
 
bool Fragment [get, set]
 Split frames into fragments according to the size provided by the Transport. See also VoiceCreateOptions.Fragment. More...
 
int FEC [get, set]
 Forward Error Correction control. See also VoiceCreateOptions.FEC. More...
 
IServiceable LocalUserServiceable [get, set]
 Optional user object attached to LocalVoice. its Service() will be called at each VoiceClient.Service() call. More...
 
byte Group [get, set]
 
byte InterestGroup [get, set]
 If InterestGroup != 0, streaming only to the players subscribed to this group (if supported by the transport). See also VoiceCreateOptions.InterestGroup. More...
 
bool DebugEchoMode [get, set]
 If true, outgoing stream routed back to client via server same way as for remote client's streams. See also VoiceCreateOptions.DebugEchoMode. More...
 
int[]?? TargetPlayers [get, set]
 If TargetPlayers is not null, sending voice info and streaming only to clients having player numbers specified in the array (if supported by transport). See also VoiceCreateOptions.TargetPlayers. More...
 
string SendSpacingProfileDump [get]
 
int SendSpacingProfileMax [get]
 Logs input frames time spacing profiling results. Do not call frequently. More...
 
byte ID [get]
 
byte EvNumber [get]
 
string shortName [get]
 
string Name [get]
 
string LogPrefix [get]
 
- 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

- Protected Member Functions inherited from LocalVoice
bool targetExits (bool targetMe, int[] targetPlayers)
 
void sendVoiceInfoAndConfigFrame (bool targetMe, int[] targetPlayers)
 
void sendVoiceRemove (bool targetMe, int[] targetPlayers)
 
- Protected Attributes inherited from LocalVoice
int[] targetPlayers_
 
VoiceInfo info
 
IEncoder encoder
 
VoiceClient voiceClient
 
bool threadingEnabled
 
ArraySegment< byte > configFrame
 
volatile bool disposed
 
object disposeLock = new object()
 
bool isJoined => voiceClient != null && voiceClient.transport.IsChannelJoined(this.channelId)
 

Detailed Description

Dummy LocalVoiceAudio

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

Member Function Documentation

◆ VoiceDetectorCalibrate()

void VoiceDetectorCalibrate ( int  durationMs,
Action< float >  onCalibrated = null 
)

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).
onCalibratedCalled when calibration is complete. Parameter is new threshold value.

Implements ILocalVoiceAudio.

Member Data Documentation

◆ Dummy

A Dummy LocalVoiceAudio instance.