Voice client interact with other clients on network via IVoiceTransport.
More...
Inherits IDisposable.
|
| delegate void | RemoteVoiceInfoDelegate (int channelId, int playerId, byte voiceId, VoiceInfo voiceInfo, ref RemoteVoiceOptions options) |
| | Remote voice info event delegate. More...
|
| |
| IEnumerable< LocalVoice > | LocalVoicesInChannel (int channelId) |
| | Iterates through copy of all local voices list of given channel. More...
|
| |
| void | Service () |
| | This method dispatches all available incoming commands and then sends this client's outgoing commands. Call this method regularly (2..20 times a second). More...
|
| |
| LocalVoice | CreateLocalVoice (VoiceInfo voiceInfo, int channelId=0, IEncoder encoder=null) |
| | Creates basic outgoing stream w/o data processing support. Provided encoder should generate output data stream. More...
|
| |
| LocalVoiceFramed< T > | CreateLocalVoiceFramed< T > (VoiceInfo voiceInfo, int frameSize, int channelId=0, IEncoder encoder=null) |
| | Creates outgoing stream consuming sequence of values passed in array buffers of arbitrary length which repacked in frames of constant length for further processing and encoding. More...
|
| |
| LocalVoiceAudio< T > | CreateLocalVoiceAudio< T > (VoiceInfo voiceInfo, IAudioDesc audioSourceDesc, int channelId=0, IEncoder encoder=null) |
| | Creates outgoing audio stream. Adds audio specific features (e.g. resampling, level meter) to processing pipeline and to returning stream handler. More...
|
| |
| LocalVoice | CreateLocalVoiceAudioFromSource (VoiceInfo voiceInfo, IAudioDesc source, bool forceShort=false, int channelId=0, IEncoder encoder=null) |
| | Creates outgoing audio stream of type automatically assigned and adds procedures (callback or serviceable) for consuming given audio source data. Adds audio specific features (e.g. resampling, level meter) to processing pipeline and to returning stream handler. More...
|
| |
| void | RemoveLocalVoice (LocalVoice voice) |
| | Removes local voice (outgoing data stream). - Parameters
-
| voice | Handler of outgoing stream to be removed. |
More...
|
| |
|
void | Dispose () |
| |
Creates basic outgoing stream w/o data processing support. Provided encoder should generate output data stream.
- Parameters
-
| voiceInfo | Outgoing stream parameters. Set applicable fields to read them by encoder and by receiving client when voice created. |
| channelId | Transport channel specific to transport. |
| encoder | Encoder producing the stream. |
- Returns
- Outgoing stream handler.
Creates outgoing audio stream. Adds audio specific features (e.g. resampling, level meter) to processing pipeline and to returning stream handler.
- Template Parameters
-
| T | Element type of audio array buffers. |
- Parameters
-
| voiceInfo | Outgoing audio stream parameters. Set applicable fields to read them by encoder and by receiving client when voice created. |
| channelId | Transport channel specific to transport. |
| encoder | Audio encoder. Set to null to use default Opus encoder. |
- Returns
- Outgoing stream handler.
audioSourceDesc.SamplingRate and voiceInfo.SamplingRate may do not match. Automatic resampling will occur in this case.
Creates outgoing audio stream of type automatically assigned and adds procedures (callback or serviceable) for consuming given audio source data. Adds audio specific features (e.g. resampling, level meter) to processing pipeline and to returning stream handler.
- Parameters
-
| voiceInfo | Outgoing audio stream parameters. Set applicable fields to read them by encoder and by receiving client when voice created. |
| source | Streaming audio source. |
| forceShort | For audio sources producing buffers of 'float' type, creates stream of 'short' type and adds converter. |
| channelId | Transport channel specific to transport. |
| encoder | Audio encoder. Set to null to use default Opus encoder. |
- Returns
- Outgoing stream handler.
audioSourceDesc.SamplingRate and voiceInfo.SamplingRate may do not match. Automatic resampling will occur in this case.
Creates outgoing stream consuming sequence of values passed in array buffers of arbitrary length which repacked in frames of constant length for further processing and encoding.
- Template Parameters
-
| T | Type of data consumed by outgoing stream (element type of array buffers). |
- Parameters
-
| voiceInfo | Outgoing stream parameters. Set applicable fields to read them by encoder and by receiving client when voice created. |
| frameSize | Size of buffer LocalVoiceFramed repacks input data stream to. |
| channelId | Transport channel specific to transport. |
| encoder | Encoder compressing data stream in pipeline. |
- Returns
- Outgoing stream handler.
| IEnumerable<LocalVoice> LocalVoicesInChannel |
( |
int |
channelId | ) |
|
Iterates through copy of all local voices list of given channel.
| delegate void RemoteVoiceInfoDelegate |
( |
int |
channelId, |
|
|
int |
playerId, |
|
|
byte |
voiceId, |
|
|
VoiceInfo |
voiceInfo, |
|
|
ref RemoteVoiceOptions |
options |
|
) |
| |
Remote voice info event delegate.
Removes local voice (outgoing data stream).
- Parameters
-
| voice | Handler of outgoing stream to be removed. |
This method dispatches all available incoming commands and then sends this client's outgoing commands. Call this method regularly (2..20 times a second).
Lost frames simulation ratio.
Sent frames bytes counter.
Iterates through copy of all local voices list.
Register a method to be called when remote voice info arrived (after join or new new remote voice creation). Metod parameters: (int channelId, int playerId, byte voiceId, VoiceInfo voiceInfo, ref RemoteVoiceOptions options);
Iterates through all remote voices infos.
Average time required voice packet to return to sender.
| int RoundTripTimeVariance |
|
get |
Average round trip time variation.
| bool SuppressInfoDuplicateWarning |
|
getset |
Do not log warning when duplicate info received.
