API reference
API reference
Select your platform
No SDKs available
No versions available

VoipOptions Class

The voip_options configuration is used to specify additional settings for the VoIP transmission for a Models.User. It consists of two primary options which include using DTX for transmission and setting a maxmimum bitrate for the network connection. You can read more about VoIP here.

Constructors

VoipOptions ()
Creates a new instance of ::VoipOptions which is used to customize the option flow. It returns a handle to the newly created options object, which can be used to set various properties for the options.
Signature
Oculus.Platform.VoipOptions.VoipOptions()

Methods

SetBitrateForNewConnections ( value )
Sets the maximum average bitrate the audio codec should use. Higher bitrates will increase audio quality at the expense of increased network usage. Use a lower bitrate if you think the quality is good but the network usage is too much. Use a higher bitrate if you think the quality is bad and you can afford to have a large streaming bitrate.
Signature
void Oculus.Platform.VoipOptions.SetBitrateForNewConnections(VoipBitrate value)
Parameters
Returns
void
SetCreateNewConnectionUseDtx ( value )
Set the opus codec to use discontinous transmission (DTX). DTX only transmits data when a person is speaking. Setting this to VoipDtxState.Enabled takes advantage of the fact that in a two-way converstation each individual speaks for less than half the time. Enabling DTX will conserve battery power and reduce transmission rate when a pause in the voice chat is detected.
Signature
void Oculus.Platform.VoipOptions.SetCreateNewConnectionUseDtx(VoipDtxState value)
Parameters
Returns
void

Static Methods

operator IntPtr ( options )
This operator allows you to pass an instance of the ::VoipOptions class to native C code as an IntPtr. The operator returns the handle of the options object, or IntPtr.Zero if the object is null.
Signature
static Oculus.Platform.VoipOptions.operator IntPtr(VoipOptions options)
Parameters
options: VoipOptions