Class VivoxConfig
Used during initialization to set up the SDK with a custom configuration.
Inherited Members
Namespace: VivoxUnity
Assembly: VivoxUnity.dll
Syntax
public class VivoxConfigProperties
CaptureDeviceBufferSizeIntervals
The number of 20 millisecond buffers for the capture device.
Declaration
public int CaptureDeviceBufferSizeIntervals { get; set; }Property Value
| Type | Description |
|---|---|
| int |
CodecThreads
The number of threads used for encoding/decoding audio. Must be 1 for client SDKs.
Declaration
public int CodecThreads { get; set; }Property Value
| Type | Description |
|---|---|
| int |
DefaultCodecsMask
The default codec mask that is used to initialize a connector's configured_codecs. Codec type Codec
Declaration
public MediaCodecType DefaultCodecsMask { get; set; }Property Value
| Type | Description |
|---|---|
| MediaCodecType |
DisableAudioDucking
Disable audio ducking.
Declaration
public bool DisableAudioDucking { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
DisableDevicePolling
Disable audio device polling by using a timer.
Declaration
public bool DisableDevicePolling { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
DynamicVoiceProcessingSwitching
Enable dynamic voice processing switching. The default value is true. If enabled, the SDK automatically switches between hardware and software AECs. To disable this, set the value to 0.
Declaration
public bool DynamicVoiceProcessingSwitching { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
EnableAdvancedAutoLevels
Enable advanced automatic settings for audio levels.
Declaration
public bool EnableAdvancedAutoLevels { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
EnableDtx
Default of 1 for most platforms. Caution: Changes to this value must be coordinated with Vivox.
Declaration
public bool EnableDtx { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
EnableFastNetworkChangeDetection
Enable fast network change detection. By default, this is disabled.
Declaration
public bool EnableFastNetworkChangeDetection { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
ForceCaptureSilence
Used for diagnostic purposes only.
Declaration
public bool ForceCaptureSilence { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
InitialLogLevel
The initial log level. Severity level of logs: -1 = no logging, 0 = errors only, 1 = warnings, 2 = info, 3 = debug, 4 = trace, 5 = log all
Declaration
public vx_log_level InitialLogLevel { get; set; }Property Value
| Type | Description |
|---|---|
| vx_log_level |
LostRtpTimeoutMs
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 (this is not recommended).
Declaration
public int LostRtpTimeoutMs { get; set; }Property Value
| Type | Description |
|---|---|
| int |
MaxLoginsPerUser
The maximum number of logins per user.
Declaration
public int MaxLoginsPerUser { get; set; }Property Value
| Type | Description |
|---|---|
| int |
NeverRtpTimeoutMs
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 (this is not recommended).
Declaration
public int NeverRtpTimeoutMs { get; set; }Property Value
| Type | Description |
|---|---|
| int |
RenderDeviceBufferSizeIntervals
The number of 20 millisecond buffers for the render device.
Declaration
public int RenderDeviceBufferSizeIntervals { get; set; }Property Value
| Type | Description |
|---|---|
| int |
RenderSourceInitialBufferCount
The render source initial buffer count.
Declaration
public int RenderSourceInitialBufferCount { get; set; }Property Value
| Type | Description |
|---|---|
| int |
RenderSourceQueueDepthMax
The render source maximum queue depth.
Declaration
public int RenderSourceQueueDepthMax { get; set; }Property Value
| Type | Description |
|---|---|
| int |
SkipPrepareForVivox
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.
Declaration
public bool SkipPrepareForVivox { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
UpstreamJitterFrameCount
The upstream jitter frame count.
Declaration
public int UpstreamJitterFrameCount { get; set; }Property Value
| Type | Description |
|---|---|
| int |
UseOsProxySettings
Use operating system-configured proxy settings (Windows only). The default is 0. If the environment variable "VIVOX_USE_OS_PROXY_SETTINGS" is set, then this defaults to 1.
Declaration
public int UseOsProxySettings { get; set; }Property Value
| Type | Description |
|---|---|
| int |
VoiceThreads
The number of threads used for voice processing. Must be 1 for client SDKs.
Declaration
public int VoiceThreads { get; set; }Property Value
| Type | Description |
|---|---|
| int |
WebThreads
The number of threads used for web requests. Must be 1 for client SDKs.
Declaration
public int WebThreads { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Methods
ToVx_Sdk_Config()
Internally used for mapping to the Core SDK type.
Declaration
public vx_sdk_config_t ToVx_Sdk_Config()Returns
| Type | Description |
|---|---|
| vx_sdk_config_t |