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

OVR_MessageType.h File

Enumeration Types

Enumeration ovrMessageType_

ovrMessage_Unknown
This value should never appear on the message queue. If it does, it indicates that something has gone horribly, horribly wrong.
ovrMessage_AbuseReport_ReportRequestHandled
ovrMessage_Achievements_AddCount
Generated in response to ovr_Achievements_AddCount()
ovrMessage_Achievements_AddFields
Generated in response to ovr_Achievements_AddFields()
ovrMessage_Achievements_GetAllDefinitions
Generated in response to ovr_Achievements_GetAllDefinitions()
ovrMessage_Achievements_GetAllProgress
Generated in response to ovr_Achievements_GetAllProgress()
ovrMessage_Achievements_GetDefinitionsByName
ovrMessage_Achievements_GetNextAchievementDefinitionArrayPage
ovrMessage_Achievements_GetNextAchievementProgressArrayPage
ovrMessage_Achievements_GetProgressByName
Generated in response to ovr_Achievements_GetProgressByName()
ovrMessage_Achievements_Unlock
Generated in response to ovr_Achievements_Unlock()
ovrMessage_ApplicationLifecycle_GetRegisteredPIDs
ovrMessage_ApplicationLifecycle_GetSessionKey
ovrMessage_ApplicationLifecycle_RegisterSessionKey
ovrMessage_Application_CancelAppDownload
Generated in response to ovr_Application_CancelAppDownload()
ovrMessage_Application_CheckAppDownloadProgress
ovrMessage_Application_GetVersion
Generated in response to ovr_Application_GetVersion()
ovrMessage_Application_InstallAppUpdateAndRelaunch
ovrMessage_Application_LaunchOtherApp
Generated in response to ovr_Application_LaunchOtherApp()
ovrMessage_Application_StartAppDownload
Generated in response to ovr_Application_StartAppDownload()
ovrMessage_AssetFile_Delete
Generated in response to ovr_AssetFile_Delete()
ovrMessage_AssetFile_DeleteById
Generated in response to ovr_AssetFile_DeleteById()
ovrMessage_AssetFile_DeleteByName
Generated in response to ovr_AssetFile_DeleteByName()
ovrMessage_AssetFile_Download
Generated in response to ovr_AssetFile_Download()
ovrMessage_AssetFile_DownloadById
Generated in response to ovr_AssetFile_DownloadById()
ovrMessage_AssetFile_DownloadByName
Generated in response to ovr_AssetFile_DownloadByName()
ovrMessage_AssetFile_DownloadCancel
Generated in response to ovr_AssetFile_DownloadCancel()
ovrMessage_AssetFile_DownloadCancelById
Generated in response to ovr_AssetFile_DownloadCancelById()
ovrMessage_AssetFile_DownloadCancelByName
Generated in response to ovr_AssetFile_DownloadCancelByName()
ovrMessage_AssetFile_GetList
Generated in response to ovr_AssetFile_GetList()
ovrMessage_AssetFile_Status
Generated in response to ovr_AssetFile_Status()
ovrMessage_AssetFile_StatusById
Generated in response to ovr_AssetFile_StatusById()
ovrMessage_AssetFile_StatusByName
Generated in response to ovr_AssetFile_StatusByName()
ovrMessage_Avatar_LaunchAvatarEditor
Generated in response to ovr_Avatar_LaunchAvatarEditor()
ovrMessage_Challenges_Create
Generated in response to ovr_Challenges_Create()
ovrMessage_Challenges_DeclineInvite
Generated in response to ovr_Challenges_DeclineInvite()
ovrMessage_Challenges_Delete
Generated in response to ovr_Challenges_Delete()
ovrMessage_Challenges_Get
Generated in response to ovr_Challenges_Get()
ovrMessage_Challenges_GetEntries
Generated in response to ovr_Challenges_GetEntries()
ovrMessage_Challenges_GetEntriesAfterRank
Generated in response to ovr_Challenges_GetEntriesAfterRank()
ovrMessage_Challenges_GetEntriesByIds
Generated in response to ovr_Challenges_GetEntriesByIds()
ovrMessage_Challenges_GetList
Generated in response to ovr_Challenges_GetList()
ovrMessage_Challenges_GetNextChallenges
Generated in response to ovr_Challenges_GetNextChallenges()
ovrMessage_Challenges_GetNextEntries
Generated in response to ovr_Challenges_GetNextEntries()
ovrMessage_Challenges_GetPreviousChallenges
ovrMessage_Challenges_GetPreviousEntries
Generated in response to ovr_Challenges_GetPreviousEntries()
ovrMessage_Challenges_Join
Generated in response to ovr_Challenges_Join()
ovrMessage_Challenges_Leave
Generated in response to ovr_Challenges_Leave()
ovrMessage_Challenges_UpdateInfo
Generated in response to ovr_Challenges_UpdateInfo()
ovrMessage_Cowatching_GetNextCowatchViewerArrayPage
ovrMessage_Cowatching_GetPresenterData
Generated in response to ovr_Cowatching_GetPresenterData()
ovrMessage_Cowatching_GetViewersData
Generated in response to ovr_Cowatching_GetViewersData()
ovrMessage_Cowatching_IsInSession
Generated in response to ovr_Cowatching_IsInSession()
ovrMessage_Cowatching_JoinSession
Generated in response to ovr_Cowatching_JoinSession()
ovrMessage_Cowatching_LaunchInviteDialog
Generated in response to ovr_Cowatching_LaunchInviteDialog()
ovrMessage_Cowatching_LeaveSession
Generated in response to ovr_Cowatching_LeaveSession()
ovrMessage_Cowatching_RequestToPresent
Generated in response to ovr_Cowatching_RequestToPresent()
ovrMessage_Cowatching_ResignFromPresenting
Generated in response to ovr_Cowatching_ResignFromPresenting()
ovrMessage_Cowatching_SetPresenterData
Generated in response to ovr_Cowatching_SetPresenterData()
ovrMessage_Cowatching_SetViewerData
Generated in response to ovr_Cowatching_SetViewerData()
ovrMessage_DeviceApplicationIntegrity_GetIntegrityToken
ovrMessage_Entitlement_GetIsViewerEntitled
Generated in response to ovr_Entitlement_GetIsViewerEntitled()
ovrMessage_GroupPresence_Clear
Generated in response to ovr_GroupPresence_Clear()
ovrMessage_GroupPresence_GetInvitableUsers
Generated in response to ovr_GroupPresence_GetInvitableUsers()
ovrMessage_GroupPresence_GetNextApplicationInviteArrayPage
ovrMessage_GroupPresence_GetSentInvites
Generated in response to ovr_GroupPresence_GetSentInvites()
ovrMessage_GroupPresence_LaunchInvitePanel
Generated in response to ovr_GroupPresence_LaunchInvitePanel()
ovrMessage_GroupPresence_LaunchMultiplayerErrorDialog
ovrMessage_GroupPresence_LaunchRejoinDialog
ovrMessage_GroupPresence_LaunchRosterPanel
Generated in response to ovr_GroupPresence_LaunchRosterPanel()
ovrMessage_GroupPresence_SendInvites
Generated in response to ovr_GroupPresence_SendInvites()
ovrMessage_GroupPresence_Set
Generated in response to ovr_GroupPresence_Set()
ovrMessage_GroupPresence_SetDeeplinkMessageOverride
ovrMessage_GroupPresence_SetDestination
Generated in response to ovr_GroupPresence_SetDestination()
ovrMessage_GroupPresence_SetIsJoinable
Generated in response to ovr_GroupPresence_SetIsJoinable()
ovrMessage_GroupPresence_SetLobbySession
Generated in response to ovr_GroupPresence_SetLobbySession()
ovrMessage_GroupPresence_SetMatchSession
Generated in response to ovr_GroupPresence_SetMatchSession()
ovrMessage_IAP_ConsumePurchase
Generated in response to ovr_IAP_ConsumePurchase()
ovrMessage_IAP_GetNextProductArrayPage
Generated in response to ovr_IAP_GetNextProductArrayPage()
ovrMessage_IAP_GetNextPurchaseArrayPage
Generated in response to ovr_IAP_GetNextPurchaseArrayPage()
ovrMessage_IAP_GetProductsBySKU
Generated in response to ovr_IAP_GetProductsBySKU()
ovrMessage_IAP_GetViewerPurchases
Generated in response to ovr_IAP_GetViewerPurchases()
ovrMessage_IAP_GetViewerPurchasesDurableCache
ovrMessage_IAP_LaunchCheckoutFlow
Generated in response to ovr_IAP_LaunchCheckoutFlow()
ovrMessage_LanguagePack_GetCurrent
Generated in response to ovr_LanguagePack_GetCurrent()
ovrMessage_LanguagePack_SetCurrent
Generated in response to ovr_LanguagePack_SetCurrent()
ovrMessage_Leaderboard_Get
Generated in response to ovr_Leaderboard_Get()
ovrMessage_Leaderboard_GetEntries
Generated in response to ovr_Leaderboard_GetEntries()
ovrMessage_Leaderboard_GetEntriesAfterRank
Generated in response to ovr_Leaderboard_GetEntriesAfterRank()
ovrMessage_Leaderboard_GetEntriesByIds
Generated in response to ovr_Leaderboard_GetEntriesByIds()
ovrMessage_Leaderboard_GetNextEntries
Generated in response to ovr_Leaderboard_GetNextEntries()
ovrMessage_Leaderboard_GetNextLeaderboardArrayPage
ovrMessage_Leaderboard_GetPreviousEntries
Generated in response to ovr_Leaderboard_GetPreviousEntries()
ovrMessage_Leaderboard_WriteEntry
Generated in response to ovr_Leaderboard_WriteEntry()
ovrMessage_Leaderboard_WriteEntryWithSupplementaryMetric
ovrMessage_Media_ShareToFacebook
Generated in response to ovr_Media_ShareToFacebook()
ovrMessage_Notification_MarkAsRead
Generated in response to ovr_Notification_MarkAsRead()
ovrMessage_Party_GetCurrent
Generated in response to ovr_Party_GetCurrent()
ovrMessage_RichPresence_Clear
Generated in response to ovr_RichPresence_Clear()
ovrMessage_RichPresence_GetDestinations
Generated in response to ovr_RichPresence_GetDestinations()
ovrMessage_RichPresence_GetNextDestinationArrayPage
ovrMessage_RichPresence_Set
Generated in response to ovr_RichPresence_Set()
ovrMessage_UserAgeCategory_Get
Generated in response to ovr_UserAgeCategory_Get()
ovrMessage_UserAgeCategory_Report
Generated in response to ovr_UserAgeCategory_Report()
ovrMessage_User_Get
Generated in response to ovr_User_Get()
ovrMessage_User_GetAccessToken
Generated in response to ovr_User_GetAccessToken()
ovrMessage_User_GetBlockedUsers
Generated in response to ovr_User_GetBlockedUsers()
ovrMessage_User_GetLoggedInUser
Generated in response to ovr_User_GetLoggedInUser()
ovrMessage_User_GetLoggedInUserFriends
Generated in response to ovr_User_GetLoggedInUserFriends()
ovrMessage_User_GetNextBlockedUserArrayPage
ovrMessage_User_GetNextUserArrayPage
Generated in response to ovr_User_GetNextUserArrayPage()
ovrMessage_User_GetNextUserCapabilityArrayPage
ovrMessage_User_GetOrgScopedID
Generated in response to ovr_User_GetOrgScopedID()
ovrMessage_User_GetSdkAccounts
Generated in response to ovr_User_GetSdkAccounts()
ovrMessage_User_GetUserProof
Generated in response to ovr_User_GetUserProof()
ovrMessage_User_LaunchBlockFlow
Generated in response to ovr_User_LaunchBlockFlow()
ovrMessage_User_LaunchFriendRequestFlow
Generated in response to ovr_User_LaunchFriendRequestFlow()
ovrMessage_User_LaunchUnblockFlow
Generated in response to ovr_User_LaunchUnblockFlow()
ovrMessage_Voip_GetMicrophoneAvailability
Generated in response to ovr_Voip_GetMicrophoneAvailability()
ovrMessage_Voip_SetSystemVoipSuppressed
Generated in response to ovr_Voip_SetSystemVoipSuppressed()
ovrMessage_Notification_AbuseReport_ReportButtonPressed
The user has tapped the report button in the panel that appears after pressing the Oculus button.
The message will contain a payload of type const char *. Extract the payload from the message handle with ovr_Message_GetString().
ovrMessage_Notification_ApplicationLifecycle_LaunchIntentChanged
Sent when a launch intent is received (for both cold and warm starts). The payload is the type of the intent. ovr_ApplicationLifecycle_GetLaunchDetails() should be called to get the other details.
The message will contain a payload of type const char *. Extract the payload from the message handle with ovr_Message_GetString().
ovrMessage_Notification_AssetFile_DownloadUpdate
Sent to indicate download progress for asset files.
The message will contain a payload of type ovrAssetFileDownloadUpdateHandle. Extract the payload from the message handle with ovr_Message_GetAssetFileDownloadUpdate().
ovrMessage_Notification_Cowatching_ApiNotReady
Sent when user is no longer copresent. Cowatching actions should not be performed.
The message will contain a payload of type const char *. Extract the payload from the message handle with ovr_Message_GetString().
ovrMessage_Notification_Cowatching_ApiReady
Sent when user is in copresent and cowatching is ready to go.
The message will contain a payload of type const char *. Extract the payload from the message handle with ovr_Message_GetString().
ovrMessage_Notification_Cowatching_InSessionChanged
Sent when the current user joins/leaves the cowatching session.
The message will contain a payload of type ovrCowatchingStateHandle. Extract the payload from the message handle with ovr_Message_GetCowatchingState().
ovrMessage_Notification_Cowatching_Initialized
Sent when cowatching api has been initialized. The api is not yet ready at this stage.
The message will contain a payload of type const char *. Extract the payload from the message handle with ovr_Message_GetString().
ovrMessage_Notification_Cowatching_PresenterDataChanged
Sent when the presenter updates the presenter data.
The message will contain a payload of type const char *. Extract the payload from the message handle with ovr_Message_GetString().
ovrMessage_Notification_Cowatching_SessionStarted
Sent when a user has started a cowatching session whose id is reflected in the payload.
The message will contain a payload of type const char *. Extract the payload from the message handle with ovr_Message_GetString().
ovrMessage_Notification_Cowatching_SessionStopped
Sent when a cowatching session has ended.
The message will contain a payload of type const char *. Extract the payload from the message handle with ovr_Message_GetString().
ovrMessage_Notification_Cowatching_ViewersDataChanged
Sent when a user joins or updates their viewer data.
The message will contain a payload of type ovrCowatchViewerUpdateHandle. Extract the payload from the message handle with ovr_Message_GetCowatchViewerUpdate().
ovrMessage_Notification_GroupPresence_InvitationsSent
Sent when the user is finished using the invite panel to send out invitations. Contains a list of invitees.
The message will contain a payload of type ovrLaunchInvitePanelFlowResultHandle. Extract the payload from the message handle with ovr_Message_GetLaunchInvitePanelFlowResult().
ovrMessage_Notification_GroupPresence_JoinIntentReceived
Sent when a user has chosen to join the destination/lobby/match. Read all the fields to figure out where the user wants to go and take the appropriate actions to bring them there. If the user is unable to go there, provide adequate messaging to the user on why they cannot go there. These notifications should be responded to immediately.
The message will contain a payload of type ovrGroupPresenceJoinIntentHandle. Extract the payload from the message handle with ovr_Message_GetGroupPresenceJoinIntent().
ovrMessage_Notification_GroupPresence_LeaveIntentReceived
Sent when the user has chosen to leave the destination/lobby/match from the Oculus menu. Read the specific fields to check the user is currently from the destination/lobby/match and take the appropriate actions to remove them. Update the user's presence clearing the appropriate fields to indicate the user has left.
The message will contain a payload of type ovrGroupPresenceLeaveIntentHandle. Extract the payload from the message handle with ovr_Message_GetGroupPresenceLeaveIntent().
ovrMessage_Notification_HTTP_Transfer
Sent to indicate that more data has been read or an error occured.
The message will contain a payload of type ovrHttpTransferUpdateHandle. Extract the payload from the message handle with ovr_Message_GetHttpTransferUpdate().
ovrMessage_Notification_Livestreaming_StatusChange
Indicates that the livestreaming session has been updated. You can use this information to throttle your game performance or increase CPU/GPU performance. Use ovr_Message_GetLivestreamingStatus() to extract the updated livestreaming status.
The message will contain a payload of type ovrLivestreamingStatusHandle. Extract the payload from the message handle with ovr_Message_GetLivestreamingStatus().
ovrMessage_Notification_NetSync_ConnectionStatusChanged
Sent when the status of a connection has changed.
The message will contain a payload of type ovrNetSyncConnectionHandle. Extract the payload from the message handle with ovr_Message_GetNetSyncConnection().
ovrMessage_Notification_NetSync_SessionsChanged
Sent when the list of known connected sessions has changed. Contains the new list of sessions.
The message will contain a payload of type ovrNetSyncSessionsChangedNotificationHandle. Extract the payload from the message handle with ovr_Message_GetNetSyncSessionsChangedNotification().
ovrMessage_Notification_Party_PartyUpdate
Indicates that party has been updated
The message will contain a payload of type ovrPartyUpdateNotificationHandle. Extract the payload from the message handle with ovr_Message_GetPartyUpdateNotification().
ovrMessage_Notification_Voip_MicrophoneAvailabilityStateUpdate
Indicates that the current microphone availability state has been updated. Use ovr_Voip_GetMicrophoneAvailability() to extract the microphone availability state.
The message will contain a payload of type const char *. Extract the payload from the message handle with ovr_Message_GetString().
ovrMessage_Notification_Voip_SystemVoipState
Sent to indicate that some part of the overall state of SystemVoip has changed. Use ovr_Message_GetSystemVoipState() and the properties of ovrSystemVoipStateHandle 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.
The message will contain a payload of type ovrSystemVoipStateHandle. Extract the payload from the message handle with ovr_Message_GetSystemVoipState().
ovrMessage_Notification_Vrcamera_GetDataChannelMessageUpdate
Get vr camera related webrtc data channel messages for update.
The message will contain a payload of type const char *. Extract the payload from the message handle with ovr_Message_GetString().
ovrMessage_Notification_Vrcamera_GetSurfaceUpdate
Get surface and update action from platform webrtc for update.
The message will contain a payload of type const char *. Extract the payload from the message handle with ovr_Message_GetString().
ovrMessage_PlatformInitializeWithAccessToken
= 0x35692F2B
ovrMessage_Platform_InitializeStandaloneOculus
= 0x51F8CE0C
ovrMessage_PlatformInitializeAndroidAsynchronous
= 0x1AD307B4
ovrMessage_PlatformInitializeWindowsAsynchronous
= 0x6DA7BA8F

Typedefs

enum ovrMessageType_ ovrMessageType

Functions

Convert an ovrMessageType to a human readable string
Return true if an ovrMessageType is a notification
Did you find this page helpful?
Thumbs up icon
Thumbs down icon