docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class VivoxConfigurationOptions

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

    Inheritance
    object
    VivoxConfigurationOptions
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    Namespace: Unity.Services.Vivox
    Assembly: solution.dll
    Syntax
    public sealed class VivoxConfigurationOptions

    Properties

    Name Description
    CaptureDeviceBufferSizeIntervals

    The number of 20 millisecond buffers for the capture device.

    DisableAudioDucking

    Disable audio ducking.

    DisableDevicePolling

    Disable audio device polling by using a timer.

    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.

    EnableAdvancedAutoLevels

    Enable advanced automatic settings for audio levels.

    EnableDtx

    Default of 1 for most platforms. Caution: Changes to this value must be coordinated with Vivox.

    EnableFastNetworkChangeDetection

    Enable fast network change detection. By default, this is disabled.

    ForceCaptureSilence

    Used for diagnostic purposes only.

    LogLevel

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

    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.

    MaxLoginsPerUser

    The maximum number of logins per user.

    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.

    RenderDeviceBufferSizeIntervals

    The number of 20 millisecond buffers for the render device.

    RenderSourceInitialBufferCount

    The render source initial buffer count.

    RenderSourceQueueDepthMax

    The render source maximum queue depth.

    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.

    UpstreamJitterFrameCount

    The upstream jitter frame count.

    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.

    In This Article
    Back to top
    Copyright © 2023 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)