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

Voip Class

Static Methods

Accept ( userID )
Signature
static void Oculus.Platform.Voip.Accept(UInt64 userID)
Parameters
userID: UInt64
Returns
void
GetIsConnectionUsingDtx ( peerID )
Signature
static Oculus.Platform.VoipDtxState Oculus.Platform.Voip.GetIsConnectionUsingDtx(UInt64 peerID)
Parameters
peerID: UInt64
GetLocalBitrate ( peerID )
Signature
static Oculus.Platform.VoipBitrate Oculus.Platform.Voip.GetLocalBitrate(UInt64 peerID)
Parameters
peerID: UInt64
GetMicrophoneAvailability ()
Gets whether the microphone is currently available to the app. This can be used to show if the user's voice is able to be heard by other users.
Signature
static Request<Models.MicrophoneAvailabilityState> Oculus.Platform.Voip.GetMicrophoneAvailability()
GetRemoteBitrate ( peerID )
Signature
static Oculus.Platform.VoipBitrate Oculus.Platform.Voip.GetRemoteBitrate(UInt64 peerID)
Parameters
peerID: UInt64
GetSystemVoipMicrophoneMuted ()
Signature
static VoipMuteState Oculus.Platform.Voip.GetSystemVoipMicrophoneMuted()
GetSystemVoipStatus ()
Signature
static SystemVoipStatus Oculus.Platform.Voip.GetSystemVoipStatus()
SetMicrophoneAvailabilityStateUpdateNotificationCallback ( callback )
Indicates that the current microphone availability state has been updated. Use Voip.GetMicrophoneAvailability() to extract the microphone availability state.
Signature
static void Oculus.Platform.Voip.SetMicrophoneAvailabilityStateUpdateNotificationCallback(Message< string >.Callback callback)
Parameters
callback: Message< string >.Callback
Returns
void
SetMicrophoneFilterCallback ( callback )
Signature
static void Oculus.Platform.Voip.SetMicrophoneFilterCallback(CAPI.FilterCallback callback)
Parameters
Returns
void
SetMicrophoneMuted ( state )
Signature
static void Oculus.Platform.Voip.SetMicrophoneMuted(VoipMuteState state)
Parameters
Returns
void
SetNewConnectionOptions ( voipOptions )
Signature
static void Oculus.Platform.Voip.SetNewConnectionOptions(VoipOptions voipOptions)
Parameters
voipOptions: VoipOptions
Returns
void
SetSystemVoipStateNotificationCallback ( callback )
Sent to indicate that some part of the overall state of SystemVoip has changed. Use Message.GetSystemVoipState() and the properties of SystemVoipState to extract the state that triggered the notification.
Note that the state may have changed further since the notification was generated, and that you may call the GetSystemVoip...() family of functions at any time to get the current state directly.
Signature
static void Oculus.Platform.Voip.SetSystemVoipStateNotificationCallback(Message< Models.SystemVoipState >.Callback callback)
Parameters
callback: Message< Models.SystemVoipState >.Callback
Returns
void
SetSystemVoipSuppressed ( suppressed )
Sets whether SystemVoip should be suppressed so that this app's Voip can use the mic and play incoming Voip audio. Once microphone switching functionality for the user is released, this function will no longer work. You can use get_microphone_availability to see if the user has allowed the app access to the microphone.
Signature
static Request<Models.SystemVoipState> Oculus.Platform.Voip.SetSystemVoipSuppressed(bool suppressed)
Parameters
suppressed: bool
Start ( userID )
Signature
static void Oculus.Platform.Voip.Start(UInt64 userID)
Parameters
userID: UInt64
Returns
void
Stop ( userID )
Signature
static void Oculus.Platform.Voip.Stop(UInt64 userID)
Parameters
userID: UInt64
Returns
void