Meta Developers

UOvrPlatformSubsystem Class

UOvrPlatformSubsystem extends UGameInstanceSubsystem.

UOvrPlatformSubsystem extends FTickableGameObject.

Overview

Data Fields

FOvrNotification_AbuseReport_ReportButtonPressed	OnAbuseReportReportButtonPressed`[Get]`
FOvrNotification_ApplicationLifecycle_LaunchIntentChanged	OnApplicationLifecycleLaunchIntentChanged`[Get]`
FOvrNotification_AssetFile_DownloadUpdate	OnAssetFileDownloadUpdate`[Get]`
FOvrNotification_Cowatching_ApiNotReady	OnCowatchingApiNotReady`[Get]`
FOvrNotification_Cowatching_ApiReady	OnCowatchingApiReady`[Get]`
FOvrNotification_Cowatching_InSessionChanged	OnCowatchingInSessionChanged`[Get]`
FOvrNotification_Cowatching_Initialized	OnCowatchingInitialized`[Get]`
FOvrNotification_Cowatching_PresenterDataChanged	OnCowatchingPresenterDataChanged`[Get]`
FOvrNotification_Cowatching_SessionStarted	OnCowatchingSessionStarted`[Get]`
FOvrNotification_Cowatching_SessionStopped	OnCowatchingSessionStopped`[Get]`
FOvrNotification_Cowatching_ViewersDataChanged	OnCowatchingViewersDataChanged`[Get]`
FOvrNotification_GroupPresence_InvitationsSent	OnGroupPresenceInvitationsSent`[Get]`
FOvrNotification_GroupPresence_JoinIntentReceived	OnGroupPresenceJoinIntentReceived`[Get]`
FOvrNotification_GroupPresence_LeaveIntentReceived	OnGroupPresenceLeaveIntentReceived`[Get]`
FOvrNotification_HTTP_Transfer	OnHTTPTransfer`[Get]`
FOvrNotification_Livestreaming_StatusChange	OnLivestreamingStatusChange`[Get]`
FOvrNotification_NetSync_ConnectionStatusChanged	OnNetSyncConnectionStatusChanged`[Get]`
FOvrNotification_NetSync_SessionsChanged	OnNetSyncSessionsChanged`[Get]`
FOvrNotification_Party_PartyUpdate	OnPartyPartyUpdate`[Get]`
FOvrNotification_Voip_MicrophoneAvailabilityStateUpdate	OnVoipMicrophoneAvailabilityStateUpdate`[Get]`
FOvrNotification_Voip_SystemVoipState	OnVoipSystemVoipState`[Get]`
FOvrNotification_Vrcamera_GetDataChannelMessageUpdate	OnVrcameraGetDataChannelMessageUpdate`[Get]`
FOvrNotification_Vrcamera_GetSurfaceUpdate	OnVrcameraGetSurfaceUpdate`[Get]`

Public Member Functions

bool	ShouldCreateSubsystem ( UObject * Outer )
void	Initialize ( FSubsystemCollectionBase & Collection )
void	Deinitialize ( )
void	StartMessagePump ( )
void	AddRequestDelegate ( ovrRequest RequestId, FOvrPlatformMessageOnComplete && Delegate )
void	RemoveRequestDelegate ( ovrRequest RequestId )
FOvrPlatformMulticastMessageOnComplete &	GetNotifDelegate ( ovrMessageType MessageType )
void	RemoveNotifDelegate ( ovrMessageType MessageType, const FDelegateHandle & Delegate )

Details

Fields

FOvrNotification_AbuseReport_ReportButtonPressed UOvrPlatformSubsystem::OnAbuseReportReportButtonPressed
The user has tapped the report button in the panel that appears after pressing the Oculus button.

FOvrNotification_ApplicationLifecycle_LaunchIntentChanged UOvrPlatformSubsystem::OnApplicationLifecycleLaunchIntentChanged
Sent when a launch intent is received (for both cold and warm starts). The payload is the type of the intent. ApplicationLifecycle_GetLaunchDetails() should be called to get the other details.

FOvrNotification_AssetFile_DownloadUpdate UOvrPlatformSubsystem::OnAssetFileDownloadUpdate
Sent to indicate download progress for asset files.

FOvrNotification_Cowatching_ApiNotReady UOvrPlatformSubsystem::OnCowatchingApiNotReady
Sent when user is no longer copresent. Cowatching actions should not be performed.

FOvrNotification_Cowatching_ApiReady UOvrPlatformSubsystem::OnCowatchingApiReady
Sent when user is in copresent and cowatching is ready to go.

FOvrNotification_Cowatching_InSessionChanged UOvrPlatformSubsystem::OnCowatchingInSessionChanged
Sent when the current user joins/leaves the cowatching session.

FOvrNotification_Cowatching_Initialized UOvrPlatformSubsystem::OnCowatchingInitialized
Sent when cowatching api has been initialized. The api is not yet ready at this stage.

FOvrNotification_Cowatching_PresenterDataChanged UOvrPlatformSubsystem::OnCowatchingPresenterDataChanged
Sent when the presenter updates the presenter data.

FOvrNotification_Cowatching_SessionStarted UOvrPlatformSubsystem::OnCowatchingSessionStarted
Sent when a user has started a cowatching session whose id is reflected in the payload.

FOvrNotification_Cowatching_SessionStopped UOvrPlatformSubsystem::OnCowatchingSessionStopped
Sent when a cowatching session has ended.

FOvrNotification_Cowatching_ViewersDataChanged UOvrPlatformSubsystem::OnCowatchingViewersDataChanged
Sent when a user joins or updates their viewer data.

FOvrNotification_GroupPresence_InvitationsSent UOvrPlatformSubsystem::OnGroupPresenceInvitationsSent
Sent when the user is finished using the invite panel to send out invitations. Contains a list of invitees.

FOvrNotification_GroupPresence_JoinIntentReceived UOvrPlatformSubsystem::OnGroupPresenceJoinIntentReceived
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.

FOvrNotification_GroupPresence_LeaveIntentReceived UOvrPlatformSubsystem::OnGroupPresenceLeaveIntentReceived
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.

FOvrNotification_HTTP_Transfer UOvrPlatformSubsystem::OnHTTPTransfer
Sent to indicate that more data has been read or an error occured.

FOvrNotification_Livestreaming_StatusChange UOvrPlatformSubsystem::OnLivestreamingStatusChange
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.

FOvrNotification_NetSync_ConnectionStatusChanged UOvrPlatformSubsystem::OnNetSyncConnectionStatusChanged
Sent when the status of a connection has changed.

FOvrNotification_NetSync_SessionsChanged UOvrPlatformSubsystem::OnNetSyncSessionsChanged
Sent when the list of known connected sessions has changed. Contains the new list of sessions.

FOvrNotification_Party_PartyUpdate UOvrPlatformSubsystem::OnPartyPartyUpdate
Indicates that party has been updated

FOvrNotification_Voip_MicrophoneAvailabilityStateUpdate UOvrPlatformSubsystem::OnVoipMicrophoneAvailabilityStateUpdate
Indicates that the current microphone availability state has been updated. Use Voip_GetMicrophoneAvailability() to extract the microphone availability state.

FOvrNotification_Voip_SystemVoipState UOvrPlatformSubsystem::OnVoipSystemVoipState
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.

FOvrNotification_Voip_SystemVoipState UOvrPlatformSubsystem::OnVoipSystemVoipState

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.

FOvrNotification_Vrcamera_GetDataChannelMessageUpdate UOvrPlatformSubsystem::OnVrcameraGetDataChannelMessageUpdate
Get vr camera related webrtc data channel messages for update.

FOvrNotification_Vrcamera_GetSurfaceUpdate UOvrPlatformSubsystem::OnVrcameraGetSurfaceUpdate
Get surface and update action from platform webrtc for update.

Member Functions

virtual bool UOvrPlatformSubsystem::ShouldCreateSubsystem ( UObject * Outer )
No description available.

virtual void UOvrPlatformSubsystem::Initialize ( FSubsystemCollectionBase & Collection )
No description available.

virtual void UOvrPlatformSubsystem::Deinitialize ( )
No description available.

void UOvrPlatformSubsystem::StartMessagePump ( )
The subsystem waits for your authorization to start processing messages, allowing you to register your callbacks first.

void UOvrPlatformSubsystem::AddRequestDelegate ( ovrRequest RequestId, FOvrPlatformMessageOnComplete && Delegate )
No description available.

void UOvrPlatformSubsystem::RemoveRequestDelegate ( ovrRequest RequestId )
No description available.

FOvrPlatformMulticastMessageOnComplete& UOvrPlatformSubsystem::GetNotifDelegate ( ovrMessageType MessageType )
No description available.

void UOvrPlatformSubsystem::RemoveNotifDelegate ( ovrMessageType MessageType, const FDelegateHandle & Delegate )
No description available.

Did you find this page helpful?