API reference

UOvrPlatformSubsystem Class

Extends UGameInstanceSubsystem, FTickableGameObject

Fields

OnAbuseReportReportButtonPressed : FOvrNotification_AbuseReport_ReportButtonPressed
The user has tapped the report button in the panel that appears after pressing the Oculus button.
Signature 
FOvrNotification_AbuseReport_ReportButtonPressed UOvrPlatformSubsystem::OnAbuseReportReportButtonPressed
OnApplicationLifecycleLaunchIntentChanged : FOvrNotification_ApplicationLifecycle_LaunchIntentChanged
This event is triggered when a launch intent is received, whether it's a cold or warm start. The payload contains the type of intent that was received. To obtain additional details, you should call the ApplicationLifecycle_GetLaunchDetails() function.
Signature 
FOvrNotification_ApplicationLifecycle_LaunchIntentChanged UOvrPlatformSubsystem::OnApplicationLifecycleLaunchIntentChanged
OnAssetFileDownloadUpdate : FOvrNotification_AssetFile_DownloadUpdate
Sent to indicate download progress for asset files.
Signature 
FOvrNotification_AssetFile_DownloadUpdate UOvrPlatformSubsystem::OnAssetFileDownloadUpdate
OnCowatchingApiNotReady : FOvrNotification_Cowatching_ApiNotReady
Sets a callback function that will be triggered when the user is no longer in a copresent state and cowatching actions should not be performed.
Signature 
FOvrNotification_Cowatching_ApiNotReady UOvrPlatformSubsystem::OnCowatchingApiNotReady
OnCowatchingApiReady : FOvrNotification_Cowatching_ApiReady
Sets a callback function that will be triggered when the user is in a copresent state and cowatching is ready to begin.
Signature 
FOvrNotification_Cowatching_ApiReady UOvrPlatformSubsystem::OnCowatchingApiReady
OnCowatchingInitialized : FOvrNotification_Cowatching_Initialized
Sets a callback function that will be triggered when the cowatching API has been initialized. At this stage, the API is not yet ready for use.
Signature 
FOvrNotification_Cowatching_Initialized UOvrPlatformSubsystem::OnCowatchingInitialized
OnCowatchingInSessionChanged : FOvrNotification_Cowatching_InSessionChanged
Sets a callback function that will be triggered when the current user joins/leaves the cowatching session.
Signature 
FOvrNotification_Cowatching_InSessionChanged UOvrPlatformSubsystem::OnCowatchingInSessionChanged
OnCowatchingPresenterDataChanged : FOvrNotification_Cowatching_PresenterDataChanged
Sets a callback function that will be triggered when the presenter updates the presenter data.
Signature 
FOvrNotification_Cowatching_PresenterDataChanged UOvrPlatformSubsystem::OnCowatchingPresenterDataChanged
OnCowatchingSessionStarted : FOvrNotification_Cowatching_SessionStarted
Sets a callback function that will be triggered when a user has started a cowatching session, and the ID of the session is reflected in the payload.
Signature 
FOvrNotification_Cowatching_SessionStarted UOvrPlatformSubsystem::OnCowatchingSessionStarted
OnCowatchingSessionStopped : FOvrNotification_Cowatching_SessionStopped
Sets a callback function that will be triggered when a cowatching session has ended.
Signature 
FOvrNotification_Cowatching_SessionStopped UOvrPlatformSubsystem::OnCowatchingSessionStopped
OnCowatchingViewersDataChanged : FOvrNotification_Cowatching_ViewersDataChanged
Sets a callback function that will be triggered when a user joins or updates their viewer data.
Signature 
FOvrNotification_Cowatching_ViewersDataChanged UOvrPlatformSubsystem::OnCowatchingViewersDataChanged
OnGroupPresenceInvitationsSent : FOvrNotification_GroupPresence_InvitationsSent
Sent when the user is finished using the invite panel to send out invitations. Contains a list of invitees. Parameter: Callback is a function that will be called when the invitation sent status changes. FOvrLaunchInvitePanelFlowResult has 1 member: UserList field FOvrLaunchInvitePanelFlowResult::InvitedUsers - A list of users that were sent an invitation to the session.
Signature 
FOvrNotification_GroupPresence_InvitationsSent UOvrPlatformSubsystem::OnGroupPresenceInvitationsSent
OnGroupPresenceJoinIntentReceived : FOvrNotification_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. Parameter: Callback is a function that will be called when a user has chosen to join the destination/lobby/match. FOvrGroupPresenceJoinIntent has 4 members: string field FOvrGroupPresenceJoinIntent::DeeplinkMessage - An opaque string provided by the developer to help them deeplink to content. string field FOvrGroupPresenceJoinIntent::DestinationApiName - The destination the current user wants to go to. string field FOvrGroupPresenceJoinIntent::LobbySessionId - The lobby session the current user wants to go to. string field FOvrGroupPresenceJoinIntent::MatchSessionId - The match session the current user wants to go to.
Signature 
FOvrNotification_GroupPresence_JoinIntentReceived UOvrPlatformSubsystem::OnGroupPresenceJoinIntentReceived
OnGroupPresenceLeaveIntentReceived : FOvrNotification_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. Parameter: Callback is a function that will be called when the user has chosen to leave the destination/lobby/match. FOvrGroupPresenceLeaveIntent has 3 members: string field FOvrGroupPresenceLeaveIntent::DestinationApiName - The destination the current user wants to leave. string field FOvrGroupPresenceLeaveIntent::LobbySessionId - The lobby session the current user wants to leave. string field FOvrGroupPresenceLeaveIntent::MatchSessionId - The match session the current user wants to leave.
Signature 
FOvrNotification_GroupPresence_LeaveIntentReceived UOvrPlatformSubsystem::OnGroupPresenceLeaveIntentReceived
OnHTTPTransfer : FOvrNotification_HTTP_Transfer
Sent to indicate that more data has been read or an error occured.
Signature 
FOvrNotification_HTTP_Transfer UOvrPlatformSubsystem::OnHTTPTransfer
OnLivestreamingStatusChange : FOvrNotification_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 field FOvrMessage::LivestreamingStatus to extract the updated livestreaming status.
Signature 
FOvrNotification_Livestreaming_StatusChange UOvrPlatformSubsystem::OnLivestreamingStatusChange
OnNetSyncConnectionStatusChanged : FOvrNotification_NetSync_ConnectionStatusChanged
Sent when the status of a connection has changed. The payload will be a type of FOvrNetSyncConnection.
Signature 
FOvrNotification_NetSync_ConnectionStatusChanged UOvrPlatformSubsystem::OnNetSyncConnectionStatusChanged
OnNetSyncSessionsChanged : FOvrNotification_NetSync_SessionsChanged
Sent when the list of known connected sessions has changed. Contains the new list of sessions. The payload will be a type of FOvrNetSyncSessionsChangedNotification.
Signature 
FOvrNotification_NetSync_SessionsChanged UOvrPlatformSubsystem::OnNetSyncSessionsChanged
OnPartyPartyUpdate : FOvrNotification_Party_PartyUpdate
Indicates that party has been updated
Signature 
FOvrNotification_Party_PartyUpdate UOvrPlatformSubsystem::OnPartyPartyUpdate
OnVoipMicrophoneAvailabilityStateUpdate : FOvrNotification_Voip_MicrophoneAvailabilityStateUpdate
Indicates that the current microphone availability state has been updated. Use Voip_GetMicrophoneAvailability() to extract the microphone availability state.
Signature 
FOvrNotification_Voip_MicrophoneAvailabilityStateUpdate UOvrPlatformSubsystem::OnVoipMicrophoneAvailabilityStateUpdate
OnVoipSystemVoipState : FOvrNotification_Voip_SystemVoipState
Sent to indicate that some part of the overall state of SystemVoip has changed. Use field FOvrMessage::SystemVoipState and the properties of FOvrSystemVoipState 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 
FOvrNotification_Voip_SystemVoipState UOvrPlatformSubsystem::OnVoipSystemVoipState
OnVrcameraGetDataChannelMessageUpdate : FOvrNotification_Vrcamera_GetDataChannelMessageUpdate
Get vr camera related webrtc data channel messages for update.
Signature 
FOvrNotification_Vrcamera_GetDataChannelMessageUpdate UOvrPlatformSubsystem::OnVrcameraGetDataChannelMessageUpdate
OnVrcameraGetSurfaceUpdate : FOvrNotification_Vrcamera_GetSurfaceUpdate
Get surface and update action from platform webrtc for update.
Signature 
FOvrNotification_Vrcamera_GetSurfaceUpdate UOvrPlatformSubsystem::OnVrcameraGetSurfaceUpdate

Member Functions

AddRequestDelegate ( RequestId , Delegate )
Signature 
void UOvrPlatformSubsystem::AddRequestDelegate(ovrRequest RequestId, FOvrPlatformMessageOnComplete &&Delegate)
Parameters
RequestId: ovrRequest
Delegate: FOvrPlatformMessageOnComplete &&
Returns
void
Deinitialize ()
Signature 
virtual void UOvrPlatformSubsystem::Deinitialize() override
Returns
void
GetNotifDelegate ( MessageType )
Signature 
FOvrPlatformMulticastMessageOnComplete& UOvrPlatformSubsystem::GetNotifDelegate(ovrMessageType MessageType)
Parameters
MessageType: ovrMessageType
Returns
FOvrPlatformMulticastMessageOnComplete &
Initialize ( Collection )
Signature 
virtual void UOvrPlatformSubsystem::Initialize(FSubsystemCollectionBase &Collection) override
Parameters
Collection: FSubsystemCollectionBase &
Returns
void
RemoveNotifDelegate ( MessageType , Delegate )
Signature 
void UOvrPlatformSubsystem::RemoveNotifDelegate(ovrMessageType MessageType, const FDelegateHandle &Delegate)
Parameters
MessageType: ovrMessageType
Delegate: const FDelegateHandle &
Returns
void
RemoveRequestDelegate ( RequestId )
Signature 
void UOvrPlatformSubsystem::RemoveRequestDelegate(ovrRequest RequestId)
Parameters
RequestId: ovrRequest
Returns
void
ShouldCreateSubsystem ( Outer )
Signature 
virtual bool UOvrPlatformSubsystem::ShouldCreateSubsystem(UObject *Outer) const override
Parameters
Outer: UObject *
Returns
bool
StartMessagePump ()
The subsystem waits for your authorization to start processing messages, allowing you to register your callbacks first.
Signature 
void UOvrPlatformSubsystem::StartMessagePump()
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta