Nav Logo
Why Meta Quest?
Design
Develop
API reference
Distribute
Blog
Support
Login
Platform-unreal-5 v63 Reference Guide
API reference
Select your platform
No SDKs available
No versions available
Overview
FNetworkProtocolTypes
FOvrAbuseReportOptions
FOvrAbuseReportRecording
FOvrAchievementDefinition
FOvrAchievementDefinitionPages
FOvrAchievementProgress
FOvrAchievementProgressPages
FOvrAchievementUpdate
FOvrAdvancedAbuseReportOptions
FOvrAppDownloadProgressResult
FOvrAppDownloadResult
FOvrApplicationInvite
FOvrApplicationInvitePages
FOvrApplicationOptions
FOvrApplicationVersion
FOvrAssetDetails
FOvrAssetFileDeleteResult
FOvrAssetFileDownloadCancelResult
FOvrAssetFileDownloadResult
FOvrAssetFileDownloadUpdate
FOvrAvatarEditorOptions
FOvrAvatarEditorResult
FOvrBlockedUser
FOvrBlockedUserPages
FOvrChallenge
FOvrChallengeEntry
FOvrChallengeEntryPages
FOvrChallengeOptions
FOvrChallengePages
FOvrCowatchViewer
FOvrCowatchViewerPages
FOvrCowatchViewerUpdate
FOvrCowatchingState
FOvrDestination
FOvrDestinationPages
FOvrError
FOvrGroupPresenceJoinIntent
FOvrGroupPresenceLeaveIntent
FOvrGroupPresenceOptions
FOvrHttpTransferUpdate
FOvrId
FOvrInstalledApplication
FOvrInviteOptions
FOvrInvitePanelResultInfo
FOvrLanguagePackInfo
FOvrLaunchBlockFlowResult
FOvrLaunchDetails
FOvrLaunchFriendRequestFlowResult
FOvrLaunchInvitePanelFlowResult
FOvrLaunchReportFlowResult
FOvrLaunchUnblockFlowResult
FOvrLeaderboard
FOvrLeaderboardEntry
FOvrLeaderboardEntryPages
FOvrLeaderboardPages
FOvrLeaderboardUpdateStatus
FOvrLinkedAccount
FOvrLivestreamingApplicationStatus
FOvrLivestreamingStartResult
FOvrLivestreamingStatus
FOvrLivestreamingVideoStats
FOvrMicrophone
FOvrMicrophoneAvailabilityState
FOvrMultiplayerErrorOptions
FOvrNetSyncConnection
FOvrNetSyncOptions
FOvrNetSyncSession
FOvrNetSyncSessionsChangedNotification
FOvrNetSyncSetSessionPropertyResult
FOvrNetSyncVoipAttenuationValue
FOvrOrgScopedID
FOvrPacket
FOvrPageRequestLatentAction
FOvrParty
FOvrPartyID
FOvrPartyUpdateNotification
FOvrPid
FOvrPlatformInitialize
FOvrPlatformModule
FOvrPreemptableLatentAction
FOvrProduct
FOvrProductPages
FOvrPurchase
FOvrPurchasePages
FOvrRejoinDialogResult
FOvrRequestLatentAction
FOvrRichPresenceOptions
FOvrRosterOptions
FOvrSdkAccount
FOvrSendInvitesResult
FOvrShareMediaResult
FOvrSupplementaryMetric
FOvrSystemVoipState
FOvrUser
FOvrUserAccountAgeCategory
FOvrUserCapability
FOvrUserCapabilityPages
FOvrUserDataStoreUpdateResponse
FOvrUserOptions
FOvrUserPages
FOvrUserProof
FOvrUserReportID
FOvrVariant
FOvrVoipDecoder
FOvrVoipEncoder
FOvrVoipOptions
OVRPlatform.h
OVRPlatformCppPageRequests.h
OVRPlatformCppRequests.h
OVRPlatformEnums.h
OVRPlatformFunctions.h
OVRPlatformModels.h
OVRPlatformOptions.h
OVRPlatformPageRequests.h
OVRPlatformRequests.h
OVRPlatformRequestsSupport.h
OVRPlatformSubsystem.h
OVRPlatformTypes.h
OVRPlatformUtils.h
OVR_AbuseReportOptions.h
OVR_AbuseReportRecording.h
OVR_AbuseReportType.h
OVR_AbuseReportVideoMode.h
OVR_AccountAgeCategory.h
OVR_AchievementDefinition.h
OVR_AchievementDefinitionArray.h
OVR_AchievementProgress.h
OVR_AchievementProgressArray.h
OVR_AchievementType.h
OVR_AchievementUpdate.h
OVR_AdvancedAbuseReportOptions.h
OVR_AppAgeCategory.h
OVR_AppDownloadProgressResult.h
OVR_AppDownloadResult.h
OVR_AppStatus.h
OVR_ApplicationInvite.h
OVR_ApplicationInviteArray.h
OVR_ApplicationOptions.h
OVR_ApplicationVersion.h
OVR_AssetDetails.h
OVR_AssetDetailsArray.h
OVR_AssetFileDeleteResult.h
OVR_AssetFileDownloadCancelResult.h
OVR_AssetFileDownloadResult.h
OVR_AssetFileDownloadUpdate.h
OVR_AvatarEditorOptions.h
OVR_AvatarEditorResult.h
OVR_BlockedUser.h
OVR_BlockedUserArray.h
OVR_Challenge.h
OVR_ChallengeArray.h
OVR_ChallengeCreationType.h
OVR_ChallengeEntry.h
OVR_ChallengeEntryArray.h
OVR_ChallengeOptions.h
OVR_ChallengeViewerFilter.h
OVR_ChallengeVisibility.h
OVR_CowatchViewer.h
OVR_CowatchViewerArray.h
OVR_CowatchViewerUpdate.h
OVR_CowatchingState.h
OVR_DataStore.h
OVR_Destination.h
OVR_DestinationArray.h
OVR_Error.h
OVR_Functions_ApplicationLifecycle.h
OVR_Functions_Voip.h
OVR_GroupPresenceJoinIntent.h
OVR_GroupPresenceLeaveIntent.h
OVR_GroupPresenceOptions.h
OVR_HttpTransferUpdate.h
OVR_InstalledApplication.h
OVR_InstalledApplicationArray.h
OVR_InviteOptions.h
OVR_InvitePanelResultInfo.h
OVR_KeyValuePairType.h
OVR_LanguagePackInfo.h
OVR_LaunchBlockFlowResult.h
OVR_LaunchDetails.h
OVR_LaunchFriendRequestFlowResult.h
OVR_LaunchInvitePanelFlowResult.h
OVR_LaunchReportFlowResult.h
OVR_LaunchResult.h
OVR_LaunchType.h
OVR_LaunchUnblockFlowResult.h
OVR_Leaderboard.h
OVR_LeaderboardArray.h
OVR_LeaderboardEntry.h
OVR_LeaderboardEntryArray.h
OVR_LeaderboardFilterType.h
OVR_LeaderboardStartAt.h
OVR_LeaderboardUpdateStatus.h
OVR_LinkedAccount.h
OVR_LinkedAccountArray.h
OVR_LivestreamingApplicationStatus.h
OVR_LivestreamingAudience.h
OVR_LivestreamingMicrophoneStatus.h
OVR_LivestreamingStartResult.h
OVR_LivestreamingStartStatus.h
OVR_LivestreamingStatus.h
OVR_LivestreamingVideoStats.h
OVR_LogEventName.h
OVR_LogEventParameter.h
OVR_MediaContentType.h
OVR_Message.h
OVR_MessageType.h
OVR_Microphone.h
OVR_MicrophoneAvailabilityState.h
OVR_MultiplayerErrorErrorKey.h
OVR_MultiplayerErrorOptions.h
OVR_NetSyncConnection.h
OVR_NetSyncConnectionStatus.h
OVR_NetSyncDisconnectReason.h
OVR_NetSyncOptions.h
OVR_NetSyncSession.h
OVR_NetSyncSessionArray.h
OVR_NetSyncSessionsChangedNotification.h
OVR_NetSyncSetSessionPropertyResult.h
OVR_NetSyncVoipAttenuationValue.h
OVR_NetSyncVoipAttenuationValueArray.h
OVR_NetSyncVoipMicSource.h
OVR_NetSyncVoipStreamMode.h
OVR_OrgScopedID.h
OVR_Packet.h
OVR_Party.h
OVR_PartyID.h
OVR_PartyMicState.h
OVR_PartyUpdateAction.h
OVR_PartyUpdateNotification.h
OVR_PermissionGrantStatus.h
OVR_PermissionType.h
OVR_Pid.h
OVR_PidArray.h
OVR_Platform.h
OVR_PlatformInitialize.h
OVR_PlatformInitializeResult.h
OVR_PlatformVersion.h
OVR_Platform_Defs.h
OVR_Platform_Internal.h
OVR_Product.h
OVR_ProductArray.h
OVR_Purchase.h
OVR_PurchaseArray.h
OVR_RejoinDialogResult.h
OVR_ReportRequestResponse.h
OVR_Requests_AbuseReport.h
OVR_Requests_Achievements.h
OVR_Requests_Application.h
OVR_Requests_ApplicationLifecycle.h
OVR_Requests_AssetFile.h
OVR_Requests_Avatar.h
OVR_Requests_Challenges.h
OVR_Requests_Cowatching.h
OVR_Requests_DeviceApplicationIntegrity.h
OVR_Requests_Entitlement.h
OVR_Requests_GroupPresence.h
OVR_Requests_IAP.h
OVR_Requests_LanguagePack.h
OVR_Requests_Leaderboard.h
OVR_Requests_Media.h
OVR_Requests_Notification.h
OVR_Requests_Party.h
OVR_Requests_RichPresence.h
OVR_Requests_User.h
OVR_Requests_UserAgeCategory.h
OVR_Requests_Voip.h
OVR_RichPresenceExtraContext.h
OVR_RichPresenceOptions.h
OVR_RosterOptions.h
OVR_SdkAccount.h
OVR_SdkAccountArray.h
OVR_SdkAccountType.h
OVR_SendInvitesResult.h
OVR_ServiceProvider.h
OVR_ShareMediaResult.h
OVR_ShareMediaStatus.h
OVR_SupplementaryMetric.h
OVR_SystemVoipState.h
OVR_SystemVoipStatus.h
OVR_TimeWindow.h
OVR_Types.h
OVR_User.h
OVR_UserAccountAgeCategory.h
OVR_UserArray.h
OVR_UserCapability.h
OVR_UserCapabilityArray.h
OVR_UserDataStoreUpdateResponse.h
OVR_UserOptions.h
OVR_UserOrdering.h
OVR_UserPresenceStatus.h
OVR_UserProof.h
OVR_UserReportID.h
OVR_VoipBitrate.h
OVR_VoipDecoder.h
OVR_VoipDtxState.h
OVR_VoipEncoder.h
OVR_VoipMuteState.h
OVR_VoipOptions.h
OVR_VoipSampleRate.h
OVR_Voip_LowLevel.h
TOvrMessageHandle
UOvrAchievementDefinitionPagesMethods
UOvrAchievementProgressPagesMethods
UOvrApplicationInvitePagesMethods
UOvrBlockedUserPagesMethods
UOvrChallengeEntryPagesMethods
UOvrChallengePagesMethods
UOvrCowatchViewerPagesMethods
UOvrDestinationPagesMethods
UOvrFunctionsBlueprintLibrary
UOvrLeaderboardEntryPagesMethods
UOvrLeaderboardPagesMethods
UOvrMicrophoneMethods
UOvrPacketMethods
UOvrPageRequestsBlueprintLibrary
UOvrPlatformSubsystem
UOvrPlatformUtilsLibrary
UOvrProductPagesMethods
UOvrPurchasePagesMethods
UOvrRequestsBlueprintLibrary
UOvrUserCapabilityPagesMethods
UOvrUserPagesMethods
UOvrVoipDecoderMethods
UOvrVoipEncoderMethods
ovrKeyValuePair
ovrNetSyncVec3
ovrOculusInitParams
ovrPlatformLogValue
Code samples
Downloads
Release notes
Platform-unreal-5 v63 Reference Guide
How do I use the Oculus Platform SDK?
To initialize the Platform SDK import OVRPlatform.h to get access to the Startup Module.
  1. Initialize :
    See StartupModule in OVRPlatform.h to initialize Platform SDK.
  2. Request:
    Make some requests. A full list of requests follows below.
  3. Handle Responses:
    Retrieve responses from the message queue and process them.
  • ReportRequestHandled
  • AddCount
  • AddFields
  • GetAllDefinitions
  • GetAllProgress
  • GetDefinitionsByName
  • GetProgressByName
  • Unlock
  • CancelAppDownload
  • CheckAppDownloadProgress
  • GetVersion
  • InstallAppUpdateAndRelaunch
  • LaunchOtherApp
  • StartAppDownload
  • GetRegisteredPIDs
  • GetSessionKey
  • RegisterSessionKey
  • Delete
  • DeleteById
  • DeleteByName
  • Download
  • DownloadById
  • DownloadByName
  • DownloadCancel
  • DownloadCancelById
  • DownloadCancelByName
  • GetList
  • Status
  • StatusById
  • StatusByName
  • LaunchAvatarEditor
  • Create
  • DeclineInvite
  • Delete
  • Get
  • GetEntries
  • GetEntriesAfterRank
  • GetEntriesByIds
  • GetList
  • GetNextChallenges
  • GetNextEntries
  • GetPreviousChallenges
  • GetPreviousEntries
  • Join
  • Leave
  • UpdateInfo
  • GetPresenterData
  • GetViewersData
  • IsInSession
  • JoinSession
  • LaunchInviteDialog
  • LeaveSession
  • RequestToPresent
  • ResignFromPresenting
  • SetPresenterData
  • SetViewerData
  • GetIntegrityToken
  • GetIsViewerEntitled
  • Clear
  • GetInvitableUsers
  • GetSentInvites
  • LaunchInvitePanel
  • LaunchMultiplayerErrorDialog
  • LaunchRejoinDialog
  • LaunchRosterPanel
  • SendInvites
  • Set
  • SetDeeplinkMessageOverride
  • SetDestination
  • SetIsJoinable
  • SetLobbySession
  • SetMatchSession
  • ConsumePurchase
  • GetProductsBySKU
  • GetViewerPurchases
  • GetViewerPurchasesDurableCache
  • LaunchCheckoutFlow
  • GetCurrent
  • SetCurrent
  • Get
  • GetEntries
  • GetEntriesAfterRank
  • GetEntriesByIds
  • GetNextEntries
  • GetPreviousEntries
  • WriteEntry
  • WriteEntryWithSupplementaryMetric
  • ShareToFacebook
  • MarkAsRead
  • GetCurrent
  • Clear
  • GetDestinations
  • Set
  • Get
  • GetAccessToken
  • GetBlockedUsers
  • GetLoggedInUser
  • GetLoggedInUserFriends
  • GetOrgScopedID
  • GetSdkAccounts
  • GetUserProof
  • LaunchBlockFlow
  • LaunchFriendRequestFlow
  • LaunchUnblockFlow
  • Get
  • Report
  • GetMicrophoneAvailability
  • SetSystemVoipSuppressed
  • AbuseReportType
  • AbuseReportVideoMode
  • AccountAgeCategory
  • AchievementType
  • AppAgeCategory
  • AppStatus
  • ChallengeCreationType
  • ChallengeViewerFilter
  • ChallengeVisibility
  • KeyValuePairType
  • LaunchResult
  • LaunchType
  • LeaderboardFilterType
  • LeaderboardStartAt
  • LivestreamingAudience
  • LivestreamingMicrophoneStatus
  • LivestreamingStartStatus
  • LogEventName
  • LogEventParameter
  • MediaContentType
  • MultiplayerErrorErrorKey
  • NetSyncConnectionStatus
  • NetSyncDisconnectReason
  • NetSyncVoipMicSource
  • NetSyncVoipStreamMode
  • PartyMicState
  • PartyUpdateAction
  • PermissionGrantStatus
  • PermissionType
  • PlatformInitializeResult
  • ReportRequestResponse
  • RichPresenceExtraContext
  • SdkAccountType
  • ServiceProvider
  • ShareMediaStatus
  • SystemVoipStatus
  • TimeWindow
  • UserOrdering
  • UserPresenceStatus
  • VoipBitrate
  • VoipDtxState
  • VoipMuteState
  • VoipSampleRate
  • AbuseReportRecording
  • AchievementDefinition
  • AchievementProgress
  • AchievementUpdate
  • AppDownloadProgressResult
  • AppDownloadResult
  • ApplicationInvite
  • ApplicationVersion
  • AssetDetails
  • AssetFileDeleteResult
  • AssetFileDownloadCancelResult
  • AssetFileDownloadResult
  • AssetFileDownloadUpdate
  • AvatarEditorResult
  • BlockedUser
  • Challenge
  • ChallengeEntry
  • CowatchViewer
  • CowatchViewerUpdate
  • CowatchingState
  • Destination
  • GroupPresenceJoinIntent
  • GroupPresenceLeaveIntent
  • InstalledApplication
  • InvitePanelResultInfo
  • LanguagePackInfo
  • LaunchBlockFlowResult
  • LaunchDetails
  • LaunchFriendRequestFlowResult
  • LaunchInvitePanelFlowResult
  • LaunchReportFlowResult
  • LaunchUnblockFlowResult
  • Leaderboard
  • LeaderboardEntry
  • LeaderboardUpdateStatus
  • LinkedAccount
  • LivestreamingApplicationStatus
  • LivestreamingStartResult
  • LivestreamingStatus
  • LivestreamingVideoStats
  • MicrophoneAvailabilityState
  • NetSyncConnection
  • NetSyncSession
  • NetSyncSessionsChangedNotification
  • NetSyncSetSessionPropertyResult
  • NetSyncVoipAttenuationValue
  • OrgScopedID
  • Party
  • PartyID
  • PartyUpdateNotification
  • Pid
  • PlatformInitialize
  • Product
  • Purchase
  • RejoinDialogResult
  • SdkAccount
  • SendInvitesResult
  • ShareMediaResult
  • SupplementaryMetric
  • SystemVoipState
  • User
  • UserAccountAgeCategory
  • UserCapability
  • UserDataStoreUpdateResponse
  • UserProof
  • UserReportID
  • AbuseReportOptions
  • AdvancedAbuseReportOptions
  • ApplicationOptions
  • AvatarEditorOptions
  • ChallengeOptions
  • GroupPresenceOptions
  • InviteOptions
  • MultiplayerErrorOptions
  • NetSyncOptions
  • RichPresenceOptions
  • RosterOptions
  • UserOptions
  • VoipOptions
Nav Logo
Build with Meta
Social Technologies
Meta Horizon
AI
Horizon Worlds
About us
Careers
Research
Products
Virtual reality / Meta Horizon
Developer Blog
Download SDKs
Meta for Work
Programs
Start
Meta Horizon Creator Program
Discover
Why Meta Quest?
What is mixed reality?
Platforms and tools
2D apps for Meta Horizon OS
Devices
Meta Avatars
Success stories
Use cases
Support and legal
Developer policies
Legal
Privacy
Forums
Support
Build with Meta
Social Technologies
Meta Horizon
AI
Horizon Worlds
About us
Careers
Research
Products
Virtual reality / Meta Horizon
Developer Blog
Download SDKs
Meta for Work
Programs
Start
Meta Horizon Creator Program
Discover
Why Meta Quest?
What is mixed reality?
Platforms and tools
2D apps for Meta Horizon OS
Devices
Meta Avatars
Success stories
Use cases
Support and legal
Developer policies
Legal
Privacy
Forums
Support
Build with Meta
Social Technologies
Meta Horizon
AI
Horizon Worlds
About us
Careers
Research
Products
Virtual reality / Meta Horizon
Developer Blog
Download SDKs
Meta for Work
Programs
Start
Meta Horizon Creator Program
Discover
Why Meta Quest?
What is mixed reality?
Platforms and tools
2D apps for Meta Horizon OS
Devices
Meta Avatars
Success stories
Use cases
Support and legal
Developer policies
Legal
Privacy
Forums
Support
English (US)
© 2025 Meta