Class VivoxConfigurationOptions
Used during initialization to set up the SDK with a custom configuration.
Inherited Members
Namespace: Unity.Services.Vivox
Assembly: solution.dll
Syntax
public sealed class VivoxConfigurationOptions
Properties
Name | Description |
---|---|
Capture |
The number of 20 millisecond buffers for the capture device. |
Disable |
Disable audio ducking. |
Disable |
Disable audio device polling by using a timer. |
Dynamic |
Enable dynamic voice processing switching. The default value is true. If enabled, the SDK automatically switches between hardware and software AECs. The default value is 1. To disable this capability, set the value to 0. |
Enable |
Enable advanced automatic settings for audio levels. |
Enable |
Default of 1 for most platforms. Caution: Changes to this value must be coordinated with Vivox. |
Enable |
Enable fast network change detection. By default, this is disabled. |
Force |
Used for diagnostic purposes only. |
Log |
The log verbosity of the Vivox SDK. Log level order from least to most verbose: None -> Error -> Warning -> Info -> Debug -> Trace -> All |
Lost |
The number of millseconds to wait before disconnecting audio due to RTP timeout after the call has been established. A zero or negative value turns off the guard, which is not recommended. |
Max |
The maximum number of logins per user. |
Never |
The number of millseconds to wait before disconnecting audio due to RTP timeout at the initial call time. A zero or negative value turns off the guard, which is not recommended. |
Render |
The number of 20 millisecond buffers for the render device. |
Render |
The render source initial buffer count. |
Render |
The render source maximum queue depth. |
Skip |
For iOS, set this to true to control the iOS PlayAndRecord category. If set to false, Vivox sets the proper iOS PlayAndRecord category. Note: You must set the PlayAndRecord category for simultaneous input/output. An improper PlayAndRecord category can result in loss of voice communication. Defaulting to a speaker plays from speaker hardware instead of the receiver (ear speaker) when headphones are not used. |
Upstream |
The upstream jitter frame count. |
Use |
Use the operating system-configured proxy settings. The default value is 0. The value is 1 if the environment variable "VIVOX_USE_OS_PROXY_SETTINGS" is set. Note: Only applicable to the Windows platform. |