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

Cowatching Class

Static Methods

GetNextCowatchViewerListPage ( list )
Signature
static Request<Models.CowatchViewerList> Oculus.Platform.Cowatching.GetNextCowatchViewerListPage(Models.CowatchViewerList list)
Parameters
GetPresenterData ()
Presenter data is used to drive a cowatching session. This can be called when there is an active cowatching session.
Signature
static Request<string> Oculus.Platform.Cowatching.GetPresenterData()
Returns
Request< string >
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.
Signature
static Request<Models.CowatchViewerList> Oculus.Platform.Cowatching.GetViewersData()
IsInSession ()
Check whether the current user is in the current cowatching session.
Signature
static Request<Models.CowatchingState> Oculus.Platform.Cowatching.IsInSession()
JoinSession ()
Join the current cowatching session. Viewer data can only be updated by users who are in the session.
Signature
static Request Oculus.Platform.Cowatching.JoinSession()
Returns
Request
LaunchInviteDialog ()
Launch a dialog for inviting users to cowatch in Copresent Home.
Signature
static Request Oculus.Platform.Cowatching.LaunchInviteDialog()
Returns
Request
LeaveSession ()
Leave the current cowatching session. Viewer data will no longer be relevant.
Signature
static Request Oculus.Platform.Cowatching.LeaveSession()
Returns
Request
RequestToPresent ()
Request to start a cowatching session as the presenter while copresent in home.
Signature
static Request Oculus.Platform.Cowatching.RequestToPresent()
Returns
Request
ResignFromPresenting ()
Stop being the presenter. This will end the cowatching session.
Signature
static Request Oculus.Platform.Cowatching.ResignFromPresenting()
Returns
Request
SetApiNotReadyNotificationCallback ( callback )
Sent when user is no longer copresent. Cowatching actions should not be performed.
Signature
static void Oculus.Platform.Cowatching.SetApiNotReadyNotificationCallback(Message< string >.Callback callback)
Parameters
callback: Message< string >.Callback
Returns
void
SetApiReadyNotificationCallback ( callback )
Sent when user is in copresent and cowatching is ready to go.
Signature
static void Oculus.Platform.Cowatching.SetApiReadyNotificationCallback(Message< string >.Callback callback)
Parameters
callback: Message< string >.Callback
Returns
void
SetInitializedNotificationCallback ( callback )
Sent when cowatching api has been initialized. The api is not yet ready at this stage.
Signature
static void Oculus.Platform.Cowatching.SetInitializedNotificationCallback(Message< string >.Callback callback)
Parameters
callback: Message< string >.Callback
Returns
void
SetInSessionChangedNotificationCallback ( callback )
Sent when the current user joins/leaves the cowatching session.
Signature
static void Oculus.Platform.Cowatching.SetInSessionChangedNotificationCallback(Message< Models.CowatchingState >.Callback callback)
Parameters
callback: Message< Models.CowatchingState >.Callback
Returns
void
SetPresenterData ( video_title , 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.
Signature
static Request Oculus.Platform.Cowatching.SetPresenterData(string video_title, string presenter_data)
Parameters
video_title: string
presenter_data: string
Returns
Request
SetPresenterDataChangedNotificationCallback ( callback )
Sent when the presenter updates the presenter data.
Signature
static void Oculus.Platform.Cowatching.SetPresenterDataChangedNotificationCallback(Message< string >.Callback callback)
Parameters
callback: Message< string >.Callback
Returns
void
SetSessionStartedNotificationCallback ( callback )
Sent when a user has started a cowatching session whose id is reflected in the payload.
Signature
static void Oculus.Platform.Cowatching.SetSessionStartedNotificationCallback(Message< string >.Callback callback)
Parameters
callback: Message< string >.Callback
Returns
void
SetSessionStoppedNotificationCallback ( callback )
Sent when a cowatching session has ended.
Signature
static void Oculus.Platform.Cowatching.SetSessionStoppedNotificationCallback(Message< string >.Callback callback)
Parameters
callback: Message< string >.Callback
Returns
void
SetViewerData ( 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.
Signature
static Request Oculus.Platform.Cowatching.SetViewerData(string viewer_data)
Parameters
viewer_data: string
Returns
Request
SetViewersDataChangedNotificationCallback ( callback )
Sent when a user joins or updates their viewer data.
Signature
static void Oculus.Platform.Cowatching.SetViewersDataChangedNotificationCallback(Message< Models.CowatchViewerUpdate >.Callback callback)
Parameters
callback: Message< Models.CowatchViewerUpdate >.Callback
Returns
void