API reference

VoipOptions Class

The voip_options configuration is used to specify additional settings for the VoIP transmission for a com.meta.horizon.platform.ovr.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 ()
Signature
com.meta.horizon.platform.ovr.options.VoipOptions.VoipOptions()

Protected Methods

finalize ()
Signature
void com.meta.horizon.platform.ovr.options.VoipOptions.finalize()
Returns
void

Methods

getHandle ()
Signature
long com.meta.horizon.platform.ovr.options.VoipOptions.getHandle()
Returns
long
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 com.meta.horizon.platform.ovr.options.VoipOptions.setBitrateForNewConnections(VoipBitrate value)
Parameters
value: VoipBitrate
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 com.meta.horizon.platform.ovr.enums.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 com.meta.horizon.platform.ovr.options.VoipOptions.setCreateNewConnectionUseDtx(VoipDtxState value)
Parameters
value: VoipDtxState
Returns
void