Class VivoxConfigurationOptions

Used during initialization to set up the SDK with a custom configuration.

Inheritance

object

VivoxConfigurationOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Vivox

Assembly: Unity.Services.Vivox.dll

Syntax

public sealed class VivoxConfigurationOptions

Properties

BluetoothProfile

Allows for the configuration of which Bluetooth profile Vivox will use. Note: This setting currently only affects mobile devices.

Declaration

public BluetoothProfile BluetoothProfile { get; set; }

Property Value

Type	Description
BluetoothProfile

CaptureDeviceBufferSizeIntervals

The number of 20 millisecond buffers for the capture device.

Declaration

public int CaptureDeviceBufferSizeIntervals { get; set; }

Property Value

Type	Description
int

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. The default value is 1. To disable this capability, 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

IosVoiceProcessingMode

Controls the behavior of which audio unit is used on different scenarios on iOS. 2 (default): Will always use the Voice Processing Audio Unit, no matter the audio setup. 1: Will only use the Voice Processing Audio Unit when the speaker phone is in use. 0: Will never use the Voice Processing Audio Unit.

Declaration

public IosVoiceProcessingIOModes IosVoiceProcessingMode { get; set; }

Property Value

Type	Description
IosVoiceProcessingIOModes

LogLevel

The log verbosity of the Vivox SDK. Log level order from least to most verbose: None -> Error -> Warning -> Info -> Debug -> Trace -> All

Declaration

public VivoxLogLevel LogLevel { get; set; }

Property Value

Type	Description
VivoxLogLevel

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, which 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

MobileRecordingConflictAvoidance

Enable mobile recording conflicts avoidance. If Vivox detects that there is more than one recorder, Vivox disables its recorder to allow for others to record. Real call dialer app, Voip apps, Voice recognition apps are all prioritized to use the recorder over Vivox if this field is set to true. The default value is true. To disable this capability, set the value to false. Note: This feature currently only affects Android mobile devices.

Declaration

public bool MobileRecordingConflictAvoidance { get; set; }

Property Value

Type	Description
bool

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, which 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 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.

Declaration

public int UseOsProxySettings { get; set; }

Property Value

Type	Description
int