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

UOvrPlatformSubsystem Class

Extends UGameInstanceSubsystem, FTickableGameObject

Fields

The user has tapped the report button in the panel that appears after pressing the Oculus button.
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.
Sent to indicate download progress for asset files.
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.
Sets a callback function that will be triggered when the user is in a copresent state and cowatching is ready to begin.
Sets a callback function that will be triggered when the current user joins/leaves the cowatching session.
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.
Sets a callback function that will be triggered when the presenter updates the presenter data.
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.
Sets a callback function that will be triggered when a cowatching session has ended.
Sets a callback function that will be triggered when a user joins or updates their viewer data.
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.
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.
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.
Sent to indicate that more data has been read or an error occured.
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.
Sent when the status of a connection has changed. The payload will be a type of FOvrNetSyncConnection.
Sent when the list of known connected sessions has changed. Contains the new list of sessions. The payload will be a type of FOvrNetSyncSessionsChangedNotification.
Indicates that party has been updated
Indicates that the current microphone availability state has been updated. Use Voip_GetMicrophoneAvailability() to extract the microphone availability state.
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.
Get vr camera related webrtc data channel messages for update.
Get surface and update action from platform webrtc for update.

Member Functions

virtual bool ShouldCreateSubsystem
( UObject * Outer )
virtual void Initialize
( FSubsystemCollectionBase & Collection )
virtual void Deinitialize ( )
The subsystem waits for your authorization to start processing messages, allowing you to register your callbacks first.
void AddRequestDelegate
( ovrRequest RequestId,
FOvrPlatformMessageOnComplete && Delegate )
void RemoveRequestDelegate
( ovrRequest RequestId )
FOvrPlatformMulticastMessageOnComplete & GetNotifDelegate
( ovrMessageType MessageType )
void RemoveNotifDelegate
( ovrMessageType MessageType,
const FDelegateHandle & Delegate )
Did you find this page helpful?
Thumbs up icon
Thumbs down icon