VivoxConfig
Reference the VivoxConfig class for initializing the Vivox SDK.
阅读时间14 分钟最后更新于 23 天前
Public Functions
Name | |
|---|---|
| VivoxConfig() | |
| vx_sdk_config_t | ToVx_Sdk_Config() Retrieve the underlying Vivox config. |
| vx_log_level | LogLevel() const The log level of the SDK. Severity level of logs: -1 = no logging, 0 = errors only, 1 = warnings, 2 = info, 3 = debug, 4 = trace, 5 = log all. |
| media_codec_type | DefaultCodecsMask() const The default codec mask. Caution: Altering this value can result in unexpected behavior. Codec type none = 0, codec type siren14 = 1, codec type nm = 3, codec type speex = 4, codec type siren7 = 5, codec type opus = 6, codec type pcmu = 6 For more information, see the Vivox Developer Documentation. |
| int | RenderSourceQueueDepthMax() const The render source maximum queue depth. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| int | RenderSourceInitialBufferCount() const The render source initial buffer count. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| int | UpstreamJitterFrameCount() const The upstream jitter frame count. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| int | MaxLoginsPerUser() const The maximum number of logins allowed for a user. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| int | CaptureDeviceBufferSizeIntervals() const The number of 20 millisecond buffers for the capture device. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| int | RenderDeviceBufferSizeIntervals() const The number of 20 millisecond buffers for the render device. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| int | NeverRtpTimeoutMs() const The number of milliseconds to wait before disconnecting audio due to RTP timeout at initial call time. A zero or a negative value turns off the guard (this is not recommended). |
| int | LostRtpTimeoutMs() const The number of milliseconds to wait before disconnecting audio due to RTP timeout after the call has been established. A zero or a negative value turns off the guard (this is not recommended). |
| long long | ProcessorAffinityMask() const A processor affinity mask for SDK threads. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| bool | DisableDevicePolling() const The status of device polling. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| bool | ForceCaptureSilence() const The status of capturing silence. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| bool | EnableAdvancedAutoLevels() const The status of the advanced automatic settings of audio levels. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| bool | EnablePersistentHTTP() const Enable persistent connections (Windows only). The default is 0, or 1 if the environment variable "VIVOX_ENABLE_PERSISTENT_HTTP" is set. Note that the use of proxies could interfere with any behavior controlled by this setting. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| bool | DisableAudioDucking() const The status of audio ducking (iOS and XBOX One only). Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| bool | EnableFastNetworkChangeDetection() const The status of fast network change detection. This is disabled by default. |
| bool | UseOSProxySettings() const Use operating system-configured proxy settings (Windows only). The default is 0, or 1 if the environment variable "VIVOX_USE_OS_PROXY_SETTINGS" is set. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| bool | AllowSharedCaptureDevices() const Allow shared capture devices (shared in the Vivox context only). Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| bool | EnableDTX() const For most platforms, the default is true. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetLogLevel(vx_log_level logLevel) Set the log level of the Vivox SDK. Severity level of logs: -1 = no logging, 0 = errors only, 1 = warnings, 2 = info, 3 = debug, 4 = trace, 5 = log all. |
| void | SetDefaultCodecsMask(media_codec_type codecType) Set the codec mask that is used to initialize the connector's configured_codecs. Caution: Altering this value can change the quality of the voice experience. codec type none = 0, codec type siren14 = 1, codec type nm = 3, codec type speex = 4, codec type siren7 = 5, codec type opus = 6, codec type pcmu = 6, For more information, see the Vivox Developer Documentation. |
| void | SetRenderSourceQueueDepthMax(int queueDepthMax) Set the render source maximum queue depth. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetRenderSourceInitialBufferCount(int initialBufferCount) Set the render source initial buffer count. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetUpstreamJitterFrameCount(int upstreamJitterFrameCount) Set the upstream jitter frame count. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetMaxLoginsPerUser(int maxLoginsPerUser) Set the maximum number of logins that a user can have. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetCaptureDeviceBufferSizeIntervals(int captureDeviceBufferSizeIntervals) Set the number of 20 millisecond buffers for the capture device. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetRenderDeviceBufferSizeIntervals(int renderDeviceBufferSizeIntervals) Set the number of 20 millisecond buffers for the render device. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetNeverRtpTimeoutMs(int neverRtpTimeoutMs) Set the number of milliseconds to wait before disconnecting audio due to RTP timeout at initial call time. A zero or a negative value turns off the guard (this is not recommended). |
| void | SetLostRtpTimeoutMs(int lostRtpTimeoutMs) Set the number of milliseconds to wait before disconnecting audio due to RTP timeout after the call has been established. A zero or a negative value turns off the guard (this is not recommended). |
| void | SetProcessorAffinityMask(long long processorAffinityMask) A processor affinity mask for SDK threads. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetDisableDevicePolling(bool disableDevicePolling) Set whether to disable audio device polling by using a timer. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetForceCaptureSilence(bool forceCaptureSilence) Set whether to force capturing silence. This is for diagnostic purposes only. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetEnableAdvancedAutoLevels(bool enableAdvancedAutoLevels) Set whether to enable the advanced automatic settings of audio levels. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetEnablePersistentHTTP(bool enablePersistentHTTP) Enable persistent connections (Windows only). The default is 0, or 1 if the environment variable "VIVOX_ENABLE_PERSISTENT_HTTP" is set. Note that the use of proxies may interfere with behavior controlled by this setting. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetDisableAudioDucking(bool disableAudioDucking) Set whether to disable audio ducking (iOS and XBOX One only). Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetEnableFastNetworkChangeDetection(bool enableFastNetworkChangeDetection) Set whether to enable fast network change detection. This is disabled by default. |
| void | SetUseOSProxySettings(bool useOSProxySettings) Use operating system-configured proxy settings (Windows only). The default is 0, or 1 if the environment variable "VIVOX_USE_OS_PROXY_SETTINGS" is set. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetAllowSharedCaptureDevices(bool allowSharedCaptureDevices) Allow shared capture devices (shared in the Vivox context only). Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
| void | SetEnableDTX(bool enableDTX) For most platforms, this defaults to true. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation. |
Public Functions Documentation
function VivoxConfig
VivoxConfig()
function ToVx_Sdk_Config
inline vx_sdk_config_t ToVx_Sdk_Config()
Retrieve the underlying Vivox config.
function LogLevel
inline vx_log_level LogLevel() const
The log level of the SDK. Severity level of logs: -1 = no logging, 0 = errors only, 1 = warnings, 2 = info, 3 = debug, 4 = trace, 5 = log all.
function DefaultCodecsMask
media_codec_type DefaultCodecsMask() const
The default codec mask. Caution: Altering this value can result in unexpected behavior. Codec type none = 0, codec type siren14 = 1, codec type nm = 3, codec type speex = 4, codec type siren7 = 5, codec type opus = 6, codec type pcmu = 6 For more information, see the Vivox Developer Documentation.
function RenderSourceQueueDepthMax
inline int RenderSourceQueueDepthMax() const
The render source maximum queue depth. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function RenderSourceInitialBufferCount
inline int RenderSourceInitialBufferCount() const
The render source initial buffer count. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function UpstreamJitterFrameCount
inline int UpstreamJitterFrameCount() const
The upstream jitter frame count. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function MaxLoginsPerUser
inline int MaxLoginsPerUser() const
The maximum number of logins allowed for a user. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function CaptureDeviceBufferSizeIntervals
inline int CaptureDeviceBufferSizeIntervals() const
The number of 20 millisecond buffers for the capture device. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function RenderDeviceBufferSizeIntervals
inline int RenderDeviceBufferSizeIntervals() const
The number of 20 millisecond buffers for the render device. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function NeverRtpTimeoutMs
inline int NeverRtpTimeoutMs() const
The number of milliseconds to wait before disconnecting audio due to RTP timeout at initial call time. A zero or a negative value turns off the guard (this is not recommended).
function LostRtpTimeoutMs
inline int LostRtpTimeoutMs() const
The number of milliseconds to wait before disconnecting audio due to RTP timeout after the call has been established. A zero or a negative value turns off the guard (this is not recommended).
function ProcessorAffinityMask
inline long long ProcessorAffinityMask() const
A processor affinity mask for SDK threads. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function DisableDevicePolling
inline bool DisableDevicePolling() const
The status of device polling. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function ForceCaptureSilence
inline bool ForceCaptureSilence() const
The status of capturing silence. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function EnableAdvancedAutoLevels
inline bool EnableAdvancedAutoLevels() const
The status of the advanced automatic settings of audio levels. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function EnablePersistentHTTP
inline bool EnablePersistentHTTP() const
Enable persistent connections (Windows only). The default is 0, or 1 if the environment variable "VIVOX_ENABLE_PERSISTENT_HTTP" is set. Note that the use of proxies could interfere with any behavior controlled by this setting. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function DisableAudioDucking
inline bool DisableAudioDucking() const
The status of audio ducking (iOS and XBOX One only). Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function EnableFastNetworkChangeDetection
inline bool EnableFastNetworkChangeDetection() const
The status of fast network change detection. This is disabled by default.
function UseOSProxySettings
inline bool UseOSProxySettings() const
Use operating system-configured proxy settings (Windows only). The default is 0, or 1 if the environment variable "VIVOX_USE_OS_PROXY_SETTINGS" is set. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function AllowSharedCaptureDevices
inline bool AllowSharedCaptureDevices() const
Allow shared capture devices (shared in the Vivox context only). Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function EnableDTX
inline bool EnableDTX() const
For most platforms, the default is true. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetLogLevel
void SetLogLevel( vx_log_level logLevel)
Set the log level of the Vivox SDK. Severity level of logs: -1 = no logging, 0 = errors only, 1 = warnings, 2 = info, 3 = debug, 4 = trace, 5 = log all.
function SetDefaultCodecsMask
void SetDefaultCodecsMask( media_codec_type codecType)
Set the codec mask that is used to initialize the connector's configured_codecs. Caution: Altering this value can change the quality of the voice experience. codec type none = 0, codec type siren14 = 1, codec type nm = 3, codec type speex = 4, codec type siren7 = 5, codec type opus = 6, codec type pcmu = 6, For more information, see the Vivox Developer Documentation.
function SetRenderSourceQueueDepthMax
void SetRenderSourceQueueDepthMax( int queueDepthMax)
Set the render source maximum queue depth. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetRenderSourceInitialBufferCount
void SetRenderSourceInitialBufferCount( int initialBufferCount)
Set the render source initial buffer count. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetUpstreamJitterFrameCount
void SetUpstreamJitterFrameCount( int upstreamJitterFrameCount)
Set the upstream jitter frame count. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetMaxLoginsPerUser
void SetMaxLoginsPerUser( int maxLoginsPerUser)
Set the maximum number of logins that a user can have. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetCaptureDeviceBufferSizeIntervals
void SetCaptureDeviceBufferSizeIntervals( int captureDeviceBufferSizeIntervals)
Set the number of 20 millisecond buffers for the capture device. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetRenderDeviceBufferSizeIntervals
void SetRenderDeviceBufferSizeIntervals( int renderDeviceBufferSizeIntervals)
Set the number of 20 millisecond buffers for the render device. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetNeverRtpTimeoutMs
void SetNeverRtpTimeoutMs( int neverRtpTimeoutMs)
Set the number of milliseconds to wait before disconnecting audio due to RTP timeout at initial call time. A zero or a negative value turns off the guard (this is not recommended).
function SetLostRtpTimeoutMs
void SetLostRtpTimeoutMs( int lostRtpTimeoutMs)
Set the number of milliseconds to wait before disconnecting audio due to RTP timeout after the call has been established. A zero or a negative value turns off the guard (this is not recommended).
function SetProcessorAffinityMask
void SetProcessorAffinityMask( long long processorAffinityMask)
A processor affinity mask for SDK threads. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetDisableDevicePolling
void SetDisableDevicePolling( bool disableDevicePolling)
Set whether to disable audio device polling by using a timer. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetForceCaptureSilence
void SetForceCaptureSilence( bool forceCaptureSilence)
Set whether to force capturing silence. This is for diagnostic purposes only. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetEnableAdvancedAutoLevels
void SetEnableAdvancedAutoLevels( bool enableAdvancedAutoLevels)
Set whether to enable the advanced automatic settings of audio levels. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetEnablePersistentHTTP
void SetEnablePersistentHTTP( bool enablePersistentHTTP)
Enable persistent connections (Windows only). The default is 0, or 1 if the environment variable "VIVOX_ENABLE_PERSISTENT_HTTP" is set. Note that the use of proxies may interfere with behavior controlled by this setting. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetDisableAudioDucking
void SetDisableAudioDucking( bool disableAudioDucking)
Set whether to disable audio ducking (iOS and XBOX One only). Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetEnableFastNetworkChangeDetection
void SetEnableFastNetworkChangeDetection( bool enableFastNetworkChangeDetection)
Set whether to enable fast network change detection. This is disabled by default.
function SetUseOSProxySettings
void SetUseOSProxySettings( bool useOSProxySettings)
Use operating system-configured proxy settings (Windows only). The default is 0, or 1 if the environment variable "VIVOX_USE_OS_PROXY_SETTINGS" is set. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetAllowSharedCaptureDevices
void SetAllowSharedCaptureDevices( bool allowSharedCaptureDevices)
Allow shared capture devices (shared in the Vivox context only). Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.
function SetEnableDTX
void SetEnableDTX( bool enableDTX)
For most platforms, this defaults to true. Caution: Altering this value could result in unexpected behavior. For more information, see the Vivox Developer Documentation.