Meta Developers

Platform-unity v63 Reference Guide

API reference

Select your platform

No SDKs available

No versions available

BufferedAudioStream

AbuseReportOptions

AdvancedAbuseReportOptions

AndroidPlatform

ApplicationLifecycle

ApplicationOptions

AvatarEditorOptions

OculusInitParams

ovrKeyValuePair

RequestCallback

RequestCallback

ChallengeOptions

DeviceApplicationIntegrity

GroupPresenceOptions

MessageWithAbuseReportRecording

MessageWithAchievementDefinitions

MessageWithAchievementProgressList

MessageWithAchievementUpdate

MessageWithAppDownloadProgressResult

MessageWithAppDownloadResult

MessageWithApplicationInviteList

MessageWithApplicationVersion

MessageWithAssetDetails

MessageWithAssetDetailsList

MessageWithAssetFileDeleteResult

MessageWithAssetFileDownloadCancelResult

MessageWithAssetFileDownloadResult

MessageWithAssetFileDownloadUpdate

MessageWithAvatarEditorResult

MessageWithBlockedUserList

MessageWithChallenge

MessageWithChallengeEntryList

MessageWithChallengeList

MessageWithCowatchViewerList

MessageWithCowatchViewerUpdate

MessageWithCowatchingState

MessageWithDestinationList

MessageWithGroupPresenceJoinIntent

MessageWithGroupPresenceLeaveIntent

MessageWithHttpTransferUpdate

MessageWithInstalledApplicationList

MessageWithInvitePanelResultInfo

MessageWithLaunchBlockFlowResult

MessageWithLaunchFriendRequestFlowResult

MessageWithLaunchInvitePanelFlowResult

MessageWithLaunchReportFlowResult

MessageWithLaunchUnblockFlowResult

MessageWithLeaderboardDidUpdate

MessageWithLeaderboardEntryList

MessageWithLeaderboardList

MessageWithLinkedAccountList

MessageWithLivestreamingApplicationStatus

MessageWithLivestreamingStartResult

MessageWithLivestreamingStatus

MessageWithLivestreamingVideoStats

MessageWithMicrophoneAvailabilityState

MessageWithNetSyncConnection

MessageWithNetSyncSessionList

MessageWithNetSyncSessionsChangedNotification

MessageWithNetSyncSetSessionPropertyResult

MessageWithNetSyncVoipAttenuationValueList

MessageWithOrgScopedID

MessageWithParty

MessageWithPartyID

MessageWithPartyUnderCurrentParty

MessageWithPartyUpdateNotification

MessageWithPidList

MessageWithPlatformInitialize

MessageWithProductList

MessageWithPurchase

MessageWithPurchaseList

MessageWithRejoinDialogResult

MessageWithSdkAccountList

MessageWithSendInvitesResult

MessageWithShareMediaResult

MessageWithString

MessageWithSystemVoipState

MessageWithUser

MessageWithUserAccountAgeCategory

MessageWithUserCapabilityList

MessageWithUserList

MessageWithUserProof

MessageWithUserReportID

AbuseReportRecording

AchievementDefinition

AchievementDefinitionList

AchievementProgress

AchievementProgressList

AchievementUpdate

AppDownloadProgressResult

AppDownloadResult

ApplicationInvite

ApplicationInviteList

ApplicationVersion

AssetDetailsList

AssetFileDeleteResult

AssetFileDownloadCancelResult

AssetFileDownloadResult

AssetFileDownloadUpdate

AvatarEditorResult

BlockedUserList

ChallengeEntryList

CowatchViewerList

CowatchViewerUpdate

CowatchingState

DeserializableList

DestinationList

GroupPresenceJoinIntent

GroupPresenceLeaveIntent

HttpTransferUpdate

InstalledApplication

InstalledApplicationList

InvitePanelResultInfo

LanguagePackInfo

LaunchBlockFlowResult

LaunchFriendRequestFlowResult

LaunchInvitePanelFlowResult

LaunchReportFlowResult

LaunchUnblockFlowResult

LeaderboardEntry

LeaderboardEntryList

LeaderboardList

LinkedAccountList

LivestreamingApplicationStatus

LivestreamingStartResult

LivestreamingStatus

LivestreamingVideoStats

MicrophoneAvailabilityState

NetSyncConnection

NetSyncSessionList

NetSyncSessionsChangedNotification

NetSyncSetSessionPropertyResult

NetSyncVoipAttenuationValue

NetSyncVoipAttenuationValueList

PartyUpdateNotification

PlatformInitialize

RejoinDialogResult

SendInvitesResult

ShareMediaResult

SupplementaryMetric

SystemVoipState

UserAccountAgeCategory

UserCapabilityList

UserDataStoreUpdateResponse

MultiplayerErrorOptions

PlatformInternal

PlatformInternal

PlatformSettings

RichPresenceOptions

StandalonePlatform

StandalonePlatformSettings

UserAgeCategory

VoipAudioSourceHiLevel

VoipAudioSourceHiLevel

FilterReadDelegate

VoipPCMSourceNative

WindowsPlatform

Cowatching Class

Overview

Static Public Member Functions

static Request< string >	GetPresenterData ( )
static Request< Models.CowatchViewerList >	GetViewersData ( )
static Request< Models.CowatchingState >	IsInSession ( )
static Request	JoinSession ( )
static Request	LaunchInviteDialog ( )
static Request	LeaveSession ( )
static Request	RequestToPresent ( )
static Request	ResignFromPresenting ( )
static Request	SetPresenterData ( string video_title, string presenter_data )
static Request	SetViewerData ( string viewer_data )
static void	SetApiNotReadyNotificationCallback ( Message< string >.Callback callback )
static void	SetApiReadyNotificationCallback ( Message< string >.Callback callback )
static void	SetInSessionChangedNotificationCallback ( Message< Models.CowatchingState >.Callback callback )
static void	SetInitializedNotificationCallback ( Message< string >.Callback callback )
static void	SetPresenterDataChangedNotificationCallback ( Message< string >.Callback callback )
static void	SetSessionStartedNotificationCallback ( Message< string >.Callback callback )
static void	SetSessionStoppedNotificationCallback ( Message< string >.Callback callback )
static void	SetViewersDataChangedNotificationCallback ( Message< Models.CowatchViewerUpdate >.Callback callback )
static Request< Models.CowatchViewerList >	GetNextCowatchViewerListPage ( Models.CowatchViewerList list )

Details

Static Member Functions

static Request<string> Oculus.Platform.Cowatching.GetPresenterData ( )
Presenter data is used to drive a cowatching session. This can be called when there is an active cowatching session.

static Request<Models.CowatchViewerList> Oculus.Platform.Cowatching.GetViewersData ( )
Get the viewer data of everyone who is in a cowatching session whose data was set by Cowatching.SetViewerData(). This can be called when there is an active cowatching session.

static Request<Models.CowatchingState> Oculus.Platform.Cowatching.IsInSession ( )
Check whether the current user is in the current cowatching session.

static Request Oculus.Platform.Cowatching.JoinSession ( )
Join the current cowatching session. Viewer data can only be updated by users who are in the session.

static Request Oculus.Platform.Cowatching.LaunchInviteDialog ( )
Launch a dialog for inviting users to cowatch in Copresent Home.

static Request Oculus.Platform.Cowatching.LeaveSession ( )
Leave the current cowatching session. Viewer data will no longer be relevant.

static Request Oculus.Platform.Cowatching.RequestToPresent ( )
Request to start a cowatching session as the presenter while copresent in home.

static Request Oculus.Platform.Cowatching.ResignFromPresenting ( )
Stop being the presenter. This will end the cowatching session.

static Request Oculus.Platform.Cowatching.SetPresenterData ( string video_title, string presenter_data )
Set the data that drives a cowatching session. This method is only callable by the presenter. Video title cannot exceed 100 characters, and data size is limited to 500 characters. The data will be eventually consistent across all users.

static Request Oculus.Platform.Cowatching.SetViewerData ( string viewer_data )
Set the current user's viewer data to be shared with copresent users. This can be called when there is an active cowatching session. Data size is limited to 500 characters. The data will be eventually consistent across all users.

static void Oculus.Platform.Cowatching.SetApiNotReadyNotificationCallback ( Message< string >.Callback callback )
Sent when user is no longer copresent. Cowatching actions should not be performed.

static void Oculus.Platform.Cowatching.SetApiReadyNotificationCallback ( Message< string >.Callback callback )
Sent when user is in copresent and cowatching is ready to go.

static void Oculus.Platform.Cowatching.SetInSessionChangedNotificationCallback ( Message< Models.CowatchingState >.Callback callback )
Sent when the current user joins/leaves the cowatching session.

static void Oculus.Platform.Cowatching.SetInitializedNotificationCallback ( Message< string >.Callback callback )
Sent when cowatching api has been initialized. The api is not yet ready at this stage.

static void Oculus.Platform.Cowatching.SetPresenterDataChangedNotificationCallback ( Message< string >.Callback callback )
Sent when the presenter updates the presenter data.

static void Oculus.Platform.Cowatching.SetSessionStartedNotificationCallback ( Message< string >.Callback callback )
Sent when a user has started a cowatching session whose id is reflected in the payload.

static void Oculus.Platform.Cowatching.SetSessionStoppedNotificationCallback ( Message< string >.Callback callback )
Sent when a cowatching session has ended.

static void Oculus.Platform.Cowatching.SetViewersDataChangedNotificationCallback ( Message< Models.CowatchViewerUpdate >.Callback callback )
Sent when a user joins or updates their viewer data.

static Request<Models.CowatchViewerList> Oculus.Platform.Cowatching.GetNextCowatchViewerListPage ( Models.CowatchViewerList list )
No description available.

Did you find this page helpful?