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

OVR_Requests_Voip.h File

The voip API provides platform methods to interact with the voip connections, inputs, syncing, and systems. You can also retrieve different statuses for the current voip state. These methods exist to help integrate a platform solution for voip in your app. Read more about voip in our docs

Functions

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. Returns a microphone availability state flag which determines whether it is available or not - ovrMicrophoneAvailabilityStateHandle.A message with type ovrMessage_Voip_GetMicrophoneAvailability will be generated in response.First call ovr_Message_IsError() to check if an error occurred.If no error occurred, the message will contain a payload of type ovrMicrophoneAvailabilityStateHandle. Extract the payload from the message handle with ovr_Message_GetMicrophoneAvailabilityState().
Sets whether SystemVoip should be suppressed so that this app's Voip can use the microphone and play incoming Voip audio. Once microphone switching functionality for the user is released, this function will no longer work. You can use ovr_Voip_GetMicrophoneAvailability() to see if the user has allowed the app access to the microphone. This returns a ovrSystemVoipStateHandle object which contains statuses about whether the microphone is muted or whether passthrough is enabled.
Parameters
suppressed
A boolean indicates if the voip is supressed or not.
A message with type ovrMessage_Voip_SetSystemVoipSuppressed will be generated in response.First call ovr_Message_IsError() to check if an error occurred.If no error occurred, the message will contain a payload of type ovrSystemVoipStateHandle. Extract the payload from the message handle with ovr_Message_GetSystemVoipState().
Did you find this page helpful?
Thumbs up icon
Thumbs down icon