OVR_Requests_Cowatching.h File

Get the next page of entriesA message with type ovrMessage_Cowatching_GetNextCowatchViewerArrayPage will be generated in response.First call ovr_Message_IsError() to check if an error occurred.If no error occurred, the message will contain a payload of type ovrCowatchViewerArrayHandle. Extract the payload from the message handle with ovr_Message_GetCowatchViewerArray().

Presenter data is used to drive a cowatching session. This can be called when there is an active cowatching session.A message with type ovrMessage_Cowatching_GetPresenterData will be generated in response.First call ovr_Message_IsError() to check if an error occurred.If no error occurred, the message will contain a payload of type const char *. Extract the payload from the message handle with ovr_Message_GetString().

Get the viewer data of everyone who is in a cowatching session whose data was set by ovr_Cowatching_SetViewerData(). This can be called when there is an active cowatching session.A message with type ovrMessage_Cowatching_GetViewersData will be generated in response.First call ovr_Message_IsError() to check if an error occurred.If no error occurred, the message will contain a payload of type ovrCowatchViewerArrayHandle. Extract the payload from the message handle with ovr_Message_GetCowatchViewerArray().

Check whether the current user is in the current cowatching session.A message with type ovrMessage_Cowatching_IsInSession will be generated in response.First call ovr_Message_IsError() to check if an error occurred.If no error occurred, the message will contain a payload of type ovrCowatchingStateHandle. Extract the payload from the message handle with ovr_Message_GetCowatchingState().

Join the current cowatching session. Viewer data can only be updated by users who are in the session.A message with type ovrMessage_Cowatching_JoinSession will be generated in response.First call ovr_Message_IsError() to check if an error occurred.This response has no payload. If no error occurred, the request was successful. Yay!

Launch a dialog for inviting users to cowatch in Copresent Home.A message with type ovrMessage_Cowatching_LaunchInviteDialog will be generated in response.First call ovr_Message_IsError() to check if an error occurred.This response has no payload. If no error occurred, the request was successful. Yay!

Leave the current cowatching session. Viewer data will no longer be relevant.A message with type ovrMessage_Cowatching_LeaveSession will be generated in response.First call ovr_Message_IsError() to check if an error occurred.This response has no payload. If no error occurred, the request was successful. Yay!

Request to start a cowatching session as the presenter while copresent in home.A message with type ovrMessage_Cowatching_RequestToPresent will be generated in response.First call ovr_Message_IsError() to check if an error occurred.This response has no payload. If no error occurred, the request was successful. Yay!

Stop being the presenter. This will end the cowatching session.A message with type ovrMessage_Cowatching_ResignFromPresenting will be generated in response.First call ovr_Message_IsError() to check if an error occurred.This response has no payload. If no error occurred, the request was successful. Yay!

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.A message with type ovrMessage_Cowatching_SetPresenterData will be generated in response.First call ovr_Message_IsError() to check if an error occurred.This response has no payload. If no error occurred, the request was successful. Yay!

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.A message with type ovrMessage_Cowatching_SetViewerData will be generated in response.First call ovr_Message_IsError() to check if an error occurred.This response has no payload. If no error occurred, the request was successful. Yay!