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

OVR_Platform_Internal.h File

Enumeration Types

Enumeration ovrMessageTypeInternal_

ovrMessage_AbuseReport_LaunchAdvancedReportFlow
= 0x4CB13A6E
ovrMessage_Application_ExecuteCoordinatedLaunch
= 0x267DB4F4
ovrMessage_Application_GetInstalledApplications
= 0x520F744C
ovrMessage_Avatar_UpdateMetaData
= 0x7BCFD98E
ovrMessage_Cal_FinalizeApplication
= 0x1DA9CBD5
ovrMessage_Cal_GetSuggestedApplications
= 0x56707015
ovrMessage_Cal_ProposeApplication
= 0x4E83F2DD
ovrMessage_Colocation_GetCurrentMapUuid
= 0x34557EB2
ovrMessage_Colocation_RequestMap
= 0x3215666D
ovrMessage_Colocation_ShareMap
= 0x186DC4DD
ovrMessage_DeviceApplicationIntegrity_GetAttestationToken
= 0x102FA3DE
ovrMessage_GraphAPI_Get
= 0x30FF006E
ovrMessage_GraphAPI_Post
= 0x76A5A7C4
ovrMessage_HTTP_Get
= 0x6FB63223
ovrMessage_HTTP_GetToFile
= 0x4E81DC59
ovrMessage_HTTP_MultiPartPost
= 0x5842D210
ovrMessage_HTTP_Post
= 0x6B36A54F
ovrMessage_Livestreaming_IsAllowedForApplication
= 0x0B6D8D76
ovrMessage_Livestreaming_StartPartyStream
= 0x7B2F5CDC
ovrMessage_Livestreaming_StartStream
= 0x501AC7BE
ovrMessage_Livestreaming_StopPartyStream
= 0x27670F58
ovrMessage_Livestreaming_StopStream
= 0x44E40DCA
ovrMessage_Livestreaming_UpdateMicStatus
= 0x1C577D87
ovrMessage_NetSync_Connect
= 0x646D855F
ovrMessage_NetSync_Disconnect
= 0x1569FEB5
ovrMessage_NetSync_GetSessions
= 0x6ED60A35
ovrMessage_NetSync_GetVoipAttenuation
= 0x112ACA17
ovrMessage_NetSync_GetVoipAttenuationDefault
= 0x577BA8A0
ovrMessage_NetSync_SetVoipAttenuation
= 0x3497D7F6
ovrMessage_NetSync_SetVoipAttenuationModel
= 0x6A94AD8E
ovrMessage_NetSync_SetVoipChannelCfg
= 0x5C95A4F3
ovrMessage_NetSync_SetVoipGroup
= 0x58129C8E
ovrMessage_NetSync_SetVoipListentoChannels
= 0x5ED0EA32
ovrMessage_NetSync_SetVoipMicSource
= 0x3302F770
ovrMessage_NetSync_SetVoipSessionMuted
= 0x5585FF0A
ovrMessage_NetSync_SetVoipSpeaktoChannels
= 0x2DAFCDD5
ovrMessage_NetSync_SetVoipStreamMode
= 0x67E19D37
ovrMessage_Party_Create
= 0x1AD31B4F
ovrMessage_Party_GatherInApplication
= 0x7287C183
ovrMessage_Party_Get
= 0x5E8953BD
ovrMessage_Party_GetCurrentForUser
= 0x58CBFF2A
ovrMessage_Party_Invite
= 0x35B5C4E3
ovrMessage_Party_Join
= 0x68027C73
ovrMessage_Party_Leave
= 0x329206D1
ovrMessage_RichPresence_SetDestination
= 0x4F32E10D
ovrMessage_RichPresence_SetIsJoinable
= 0x3E9B1F61
ovrMessage_RichPresence_SetLobbySession
= 0x71010917
ovrMessage_RichPresence_SetMatchSession
= 0x63DFFC8E
ovrMessage_Room_CreateOrUpdateAndJoinNamed
= 0x7C8E0A91
ovrMessage_Room_GetNamedRooms
= 0x077D6E8C
ovrMessage_Room_GetSocialRooms
= 0x61881D76
ovrMessage_User_CancelRecordingForReportFlow
= 0x03E0D149
ovrMessage_User_GetLinkedAccounts
= 0x5793F456
ovrMessage_User_GetUserCapabilities
= 0x121C317C
ovrMessage_User_LaunchReportFlow
= 0x5662A011
ovrMessage_User_LaunchReportFlow2
= 0x7F835863
ovrMessage_User_NewEntitledTestUser
= 0x11741F03
ovrMessage_User_NewTestUser
= 0x36E84F8C
ovrMessage_User_NewTestUserFriends
= 0x1ED726C7
ovrMessage_User_StartRecordingForReportFlow
= 0x6C6E33E3
ovrMessage_User_StopRecordingAndLaunchReportFlow
= 0x60788C8B
ovrMessage_User_StopRecordingAndLaunchReportFlow2
= 0x19C2B32B
ovrMessage_User_TestUserCreateDeviceManifest
= 0x6570B2BD
ovrMessage_Voip_ReportAppVoipSessions
= 0x185251CE

Enumeration ovrCloudStorageLocation_

ovrCloudStorageLocation_Local
= 0
ovrCloudStorageLocation_Remote
= 1

Enumeration ovrLivestreamMicStatus_

ovrLivestreamMicStatus_Enabled
= 0
ovrLivestreamMicStatus_Disabled
= 1

Enumeration ovrLivestreamHeadphoneStatus_

ovrLivestreamHeadphoneStatus_Disconnected
= 0
ovrLivestreamHeadphoneStatus_Connected
= 1

Enumeration ovrConfigOptionInternal_

ovrConfigOption_DisableFbns
this is a way to remove FBNS when you don't need notifications for rooms / invites / matchmaking / p2p
valid options are true and false
ovrConfigOption_DisableP2pNetworking
Disables the initialization of the WebRTC networking stack, when you don't need to use any of the ovr_Voip_* or ovr_Net_* functions.
valid options are true and false
ovrConfigOption_EnableCowatching
Enables the initialization of cowatching stack to use ovr_Cowatching_* functions.
valid options are true and false

Typedefs

void * ovrSystemPermissionHandle
enum ovrMessageTypeInternal_ ovrMessageTypeInternal
enum ovrCloudStorageLocation_ ovrCloudStorageLocation
enum ovrLivestreamMicStatus_ ovrLivestreamMicStatus
enum ovrLivestreamHeadphoneStatus_ ovrLivestreamHeadphoneStatus
void * ovrCaptureredAudioRendererHandle
void * video_track_t
struct ovrVoipCodecOptions * ovrVoipCodecOptionsHandle
enum ovrConfigOptionInternal_ ovrConfigOptionInternal

Functions

void ovr_PlatformInitializeStandaloneAccessTokenWithRequestURI
( const char * requestURIPrefix,
const char * accessToken )
void ovr_PlatformInitializeStandaloneAccessToken
( const char * accessToken )
ovrRequest ovr_SystemPermissions_GetStatus
( ovrPermissionType permType )
ovrRequest ovr_SystemPermissions_LaunchDeeplink
( ovrPermissionType permType )
ovrSystemPermissionHandle ovr_Message_GetSystemPermission
( const ovrMessageHandle obj )
bool ovr_SystemPermission_GetHasPermission
ovrPermissionGrantStatus ovr_SystemPermission_GetPermissionGrantStatus
void ovr_CrashApplication ( )
void ovr_LogoutUser ( )
void ovr_PlatformTeardownPlugin ( )
void ovr_Log_NewEvent
( const char * eventName,
const ovrPlatformLogValue * values,
size_t length )
void ovr_Log_Event
( const ovrPlatformLogValue * values,
size_t length )
void ovr_Log_NewUnifiedEvent
( ovrLogEventName eventName,
const ovrPlatformLogValue * values,
size_t length )
void ovr_Log_UnifiedEvent
( ovrLogEventName eventName,
const ovrPlatformLogValue * values,
size_t length )
ovrVoipEncoderHandle ovr_Voip_CreateEncoderWithOptions
void ovr_Voip_SetMicrophoneFilterCallbackWithFixedSizeBuffer
size_t bufferSizeElements )
void ovr_Livestream_SetHeadphoneStatus
void ovr_Livestream_InitializeForCastingWithVideoSpecAndBitrateAndDataChannel
( const char * endpoint,
const char * token,
const char * session,
int videoHeight,
int videoWidth,
int videoFps,
int videoMaxBitrateKbps,
bool enableJsonDataChannel )
void ovr_AudioManager_SetCurrentHeadphoneStatus
void ovr_AudioManager_SetCurrentMountStatus
( bool isMounted )
void ovr_AudioManager_SetTuneInMode
( bool isInTuneInMode )
void ovr_Voip_PluginSetSystemVoipDisabled
( bool disabled )
void ovr_Voip_PluginSetSystemVoipPassthrough
( bool passthrough )
int ovr_Voip_PluginSetSystemVoipPassthrough2
( bool passthrough )
void ovr_Voip_PluginSetSystemVoipSuppressed
( bool suppressed )
size_t ovr_Voip_PluginGetSystemVoipPeers
( ovrID * peers,
size_t size )
void ovr_Voip_PluginSetMicrophoneMuted
( ovrVoipMuteState muted )
ovrLivestreamMicStatus ovr_Livestreaming_PluginGetMicrophoneMuted ( )
Deprecated: Returns a null video track.
Deprecated: Will always return 0.
void ovr_Party_PluginAddGameAudioToInput
( int16_t * pcmData,
size_t pcmDataLength,
int frequency,
int numChannels,
float volume,
int64_t trackID,
int bitsPerSample )
void ovr_Party_PluginSetGameAudioMuted
( bool muted )
void ovr_Party_PluginSetVoipVolume
( float scaleFactor )
float ovr_Party_PluginGetVoipVolume ( )
float ovr_Party_GetVoipVolume ( )
void ovr_Party_SetVoipVolume
( float volume )
bool ovr_Party_PluginIsParticipantConnectedToMWS
( ovrID participantID )
bool ovr_Party_PluginHasParticipantRecentlySpoken
( ovrID participantID )
void ovr_Voip_SetSystemVoipPassthrough
( bool passthrough )
void ovr_Voip_SetSystemVoipMicrophoneMuted
( ovrVoipMuteState muted )
bool ovr_Voip_GetSystemVoipPassthrough ( )
void ovr_Livestream_StartUnsupportedPackage
( const char * packageName )
ovrRequest ovr_Livestreaming_LaunchLivestreamingFlow ( )
ovrRequest ovr_Livestreaming_UpdateCommentsOverlayVisibility
( bool isVisible )
ovrRequest ovr_Livestreaming_GetStatus ( )
ovrRequest ovr_Livestreaming_PauseStream ( )
ovrRequest ovr_Livestreaming_ResumeStream ( )
void ovr_Livestream_SetMicStatus
void ovr_Livestream_AddGameAudioToInput
( int16_t * pcmData,
size_t pcmDataLength,
int frequency,
int numChannels,
float volume,
int64_t trackID,
int bitsPerSample )
void ovr_Vrcamera_SetVrcameraAvailable
( bool isAvailable )
size_t ovr_Microphone_PluginGetPCMShared
( ovrID uid,
int16_t * outputBuffer,
size_t outputBufferSizeElements )
void ovr_Microphone_PluginSharedMicrophoneDisableNoiseSuppressor
( ovrID uid )
void ovr_Microphone_PluginSharedMicrophoneEnableNoiseSuppressor
( ovrID uid )
int ovr_Microphone_PluginGetSocketFDShared
( ovrID uid )
void ovr_Microphone_PluginSharedStop
( ovrID uid )
void ovr_SetPlatformLogFunc
( LogFunctionPtr logFunc )
bool ovr_UnityInitWrapper
( const char * appId )
void ovr_UnityInitGlobals
( LogFunctionPtr logptr )
ovrRequest ovr_UnityInitWrapperAsynchronous
( const char * appId )
ovrRequest ovr_HTTP_GetWithMessageType
( const char * url,
int messageType )
bool ovr_UnityInitWrapperStandalone
( const char * appID,
LogFunctionPtr logptr )
void ovr_UnityResetTestPlatform ( )
const char * ovr_GetGatekeepers ( )
ovrCaptureredAudioRendererHandle ovr_CapturedAudioRenderer_New ( )
void ovr_CapturedAudioRenderer_Delete
void ovr_CapturedAudioRenderer_StorePCM
int16_t * pcmData,
size_t pcmDataLength,
int frequency,
int numChannels,
float volume,
int64_t trackID,
int bitsPerSample )
size_t ovr_CapturedAudioRenderer_RetrievePCM
int16_t * outputBuffer,
size_t outputBufferLength,
int frequency,
int numChannel )
ovrKeyValuePair ovr_ConfigOption_CreateInternal
int value )
const char * ovrConfigOptionInternal_toString
( ovrConfigOptionInternal configOption )
ovrRequest ovr_AbuseReport_LaunchAdvancedReportFlow
( ovrID content_id,
ovrAdvancedAbuseReportOptionsHandle abuse_report_options )
ovrRequest ovr_Application_ExecuteCoordinatedLaunch
( unsigned long long appID,
unsigned long long roomID )
ovrRequest ovr_Application_GetInstalledApplications ( )
ovrRequest ovr_Avatar_UpdateMetaData
( const char * avatarMetaData,
const char * imageFilePath )
ovrRequest ovr_Colocation_GetCurrentMapUuid ( )
ovrRequest ovr_Colocation_RequestMap
( const char * uuid )
ovrRequest ovr_Colocation_ShareMap
( const char * uuid )
ovrRequest ovr_DeviceApplicationIntegrity_GetAttestationToken
( const char * challenge_nonce )
ovrRequest ovr_GraphAPI_Get
( const char * url )
ovrRequest ovr_GraphAPI_Post
( const char * url )
ovrRequest ovr_HTTP_Get
( const char * url )
ovrRequest ovr_HTTP_GetToFile
( const char * url,
const char * diskFile )
ovrRequest ovr_HTTP_MultiPartPost
( const char * url,
const char * filepath_param_name,
const char * filepath,
const char * access_token,
ovrKeyValuePair * post_params,
unsigned int numItems )
ovrRequest ovr_HTTP_Post
( const char * url )
Initiates an HTTP transfer to a given URL. Returns an id that can be used to write data to the stream. A message will be posted when new data is received or in case of an error.
Writes data to the stream identified by a given `transferId'.
Indicates that the no more data will be sent to the server. The connection will eventually be closed. Note that we might still receive data from the server for a little while.
Initializes a connection via a custom HTTP endpoint.
Initializes a connection via a custom HTTP endpoint with video spec and bitrate parameters
Initializes a cast connection with turn servers options.
Initializes a connection via a custom HTTP endpoint with video spec parameters (use default max bitrate to 3000 kbps)
Initializes a connection via a custom HTTP endpoint with video spec and bitrate parameters
Initializes a connection via a custom HTTP endpoint with video spec and data channel parameters (use default max bitrate to 3000 kbps)
Initializes a connection to the MWS with a Facebook UID and FBUID/Oculus FB App access token
Send data to livestream webrtc data channel.
Starts a livestream to streamID from packageName.
Stops the current livestream.
ovrRequest ovr_Livestreaming_IsAllowedForApplication
( const char * packageName )
ovrRequest ovr_Livestreaming_StartPartyStream ( )
ovrRequest ovr_Livestreaming_StartStream
ovrRequest ovr_Livestreaming_StopPartyStream ( )
ovrRequest ovr_Livestreaming_StopStream ( )
ovrRequest ovr_Livestreaming_UpdateMicStatus
returns a json formatted string to be sent to javascript / ReactVR it is populated by the public CAPI, so that we don't increase our compatibility surface. It's always a json array with a single json object inside of it. The only key will always be data/error. The keys are defined to be the same as in models.yaml so we can codegen easily.
ovrRequest ovr_NetSync_Connect
( ovrNetSyncOptionsHandle connect_options )
ovrRequest ovr_NetSync_Disconnect
( long long connection_id )
ovrRequest ovr_NetSync_GetSessions
( long long connection_id )
ovrRequest ovr_NetSync_GetVoipAttenuation
( long long connection_id )
ovrRequest ovr_NetSync_GetVoipAttenuationDefault ( )
ovrRequest ovr_NetSync_SetVoipAttenuation
( long long connection_id,
const float * distances,
const float * decibels,
size_t count )
ovrRequest ovr_NetSync_SetVoipAttenuationModel
( long long connection_id,
const char * name,
const float * distances,
const float * decibels,
size_t count )
ovrRequest ovr_NetSync_SetVoipChannelCfg
( long long connection_id,
const char * channel_name,
const char * attnmodel,
bool disable_spatialization )
ovrRequest ovr_NetSync_SetVoipGroup
( long long connection_id,
const char * group_id )
ovrRequest ovr_NetSync_SetVoipListentoChannels
( long long connection_id,
const char ** listento_channels,
size_t count )
ovrRequest ovr_NetSync_SetVoipMicSource
( long long connection_id,
ovrRequest ovr_NetSync_SetVoipSessionMuted
( long long connection_id,
ovrID session_id,
bool muted )
ovrRequest ovr_NetSync_SetVoipSpeaktoChannels
( long long connection_id,
const char ** speakto_channels,
size_t count )
ovrRequest ovr_NetSync_SetVoipStreamMode
( long long connection_id,
ovrID sessionId,
Gets all available samples of ambisonic mixed voice data and copies it into outputBuffer. Returns the number of frames copied.This function can be safely called from any thread.
Gets all available samples of ambisonic mixed voice data and copies it into outputBuffer. Returns the number of frames copied.This function can be safely called from any thread.
Gets all available samples of ambisonic mixed voice data and copies it into outputBuffer. Returns the number of frames copied.This function can be safely called from any thread.
Gets all available samples of ambisonic mixed voice data and copies it into outputBuffer. Returns the number of frames copied.This function can be safely called from any thread.
Populates the given 3 element array with the position of the given session. If the given session has never called set_listener_position, or if the position has not yet been replicated, this method will set each to { 0, 0, 0 }The coordinate system used for ambisonic mixing is as right handed: positive X pointing right, positive Y pointing upward, positive Z pointing backwardA value of 1.0 is equal to 1 meter.
Gets all available samples of monostream voice data for the given networking session identifier and copies it into outputBuffer. Returns the number of frames copied.This function can be safely called from any thread.
Gets all available samples of monostream voice data for the given networking session identifier and copies it into outputBuffer. Returns the number of frames copied.This function can be safely called from any thread.
Returns the maximum number of samples that an output buffer will need to hold.
gets the voip amplitude of other sessions. the amplitude range is from [0.0f, 1.0f]when successfully set the function returns true, else false.
Sets the position of the listener for spatialized audio, which is used to mix the ambisonic stream on the server. This is also used as the position for the microphone.
ovrRequest ovr_Party_Create ( )
ovrRequest ovr_Party_GatherInApplication
( ovrID partyID,
ovrID appID )
ovrRequest ovr_Party_Get
( ovrID partyID )
ovrRequest ovr_Party_GetCurrentForUser
( ovrID userID )
ovrRequest ovr_Party_Invite
( ovrID partyID,
ovrID userID )
ovrRequest ovr_Party_Join
( ovrID partyID )
ovrRequest ovr_Party_Leave
( ovrID partyID )
This internal-only method is used by the platform plugin to extract audio frames for a given user. See ovr_Voip_GetPCMWithTimestamp() for details.
Returns a handle to a shared memory object that can be used to receive pcm data in passthrough mode.
Internal use only. Noop if called from a 3P app context. Gets party chat microphone mute status.
Internal use only. Noop if called from a 3P app context. Returns true if we are in voip passthrough mode.
Internal use only. Noop if called from a 3P app context. Gets party chat status.
This internal-only method is used by the platform plugin in order to enable video streaming to the party.
This internal-only method is called by the platform plugin in order to set up a conference call with all members of the given party.
This internal-only method is used by the platform plugin in order to disable video streaming to the party.
This internal-only method is called by the platform plugin after leaving the party in order to stop the conference call.
Sends a request to the system to start party chat.
Sends a request to the system to stop party chat.
ovrRequest ovr_RichPresence_SetDestination
( const char * api_name )
ovrRequest ovr_RichPresence_SetIsJoinable
( bool is_joinable )
ovrRequest ovr_RichPresence_SetLobbySession
( const char * id )
ovrRequest ovr_RichPresence_SetMatchSession
( const char * id )
ovrRequest ovr_User_CancelRecordingForReportFlow
( const char * recordingUUID )
ovrRequest ovr_User_GetLinkedAccounts
( ovrUserOptionsHandle userOptions )
ovrRequest ovr_User_GetUserCapabilities ( )
ovrRequest ovr_User_LaunchReportFlow
( ovrID userID )
ovrRequest ovr_User_LaunchReportFlow2
( ovrID optionalUserID,
ovrAbuseReportOptionsHandle abuseReportOptions )
ovrRequest ovr_User_NewEntitledTestUser ( )
ovrRequest ovr_User_NewTestUser ( )
ovrRequest ovr_User_NewTestUserFriends ( )
ovrRequest ovr_User_StartRecordingForReportFlow ( )
ovrRequest ovr_User_StopRecordingAndLaunchReportFlow
( ovrID optionalUserID,
const char * optionalRecordingUUID )
ovrRequest ovr_User_StopRecordingAndLaunchReportFlow2
( ovrID optionalUserID,
const char * optionalRecordingUUID,
ovrAbuseReportOptionsHandle abuseReportOptions )
ovrRequest ovr_User_TestUserCreateDeviceManifest
( const char * deviceID,
ovrID * appIDs,
int numAppIDs )
ovrRequest ovr_Voip_ReportAppVoipSessions
( unsigned long long * sessionIDs )
Did you find this page helpful?
Thumbs up icon
Thumbs down icon