Platform v15 Reference Guide

OVR_Requests_Livestreaming.h File Reference

Detailed Description

Livestreaming to Facebook is a great way to increase visibility of your application to people that might not have a VR Headset.

We provide both a push and a pull API for Livestreaming status changes.

You can call ovr_Livestreaming_GetStatus() to retrieve the current livestreaming status.

You can register for the ovrMessage_Notification_Livestreaming_StatusChange notification to be alerted when the user starts or stops an active livestream.

Potentially your application has content that don't make sense to livestream publicly. For example: a pin entry screen or a sensitive social interaction.
You can toggle the livestreaming state (INCLUDING audio) using ovr_Livestreaming_PauseStream() and ovr_Livestreaming_ResumeStream().
NOTE both of these methods are safe to call when no livestream is active.

If want to disable (or re-enable) livestreaming for your application, you can visit the developer dashboard:

Function Documentation

ovrRequest ovr_Livestreaming_GetStatus ( )
Return the status of the current livestreaming session if there is one.
A message with type ovrMessage_Livestreaming_GetStatus 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 ovrLivestreamingStatusHandle. Extract the payload from the message handle with ovr_Message_GetLivestreamingStatus().
ovrRequest ovr_Livestreaming_PauseStream ( )
Pauses the livestreaming session if there is one. NOTE: this function is safe to call if no session is active.
A message with type ovrMessage_Livestreaming_PauseStream 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 ovrLivestreamingStatusHandle. Extract the payload from the message handle with ovr_Message_GetLivestreamingStatus().
ovrRequest ovr_Livestreaming_ResumeStream ( )
Resumes the livestreaming session if there is one. NOTE: this function is safe to call if no session is active.
A message with type ovrMessage_Livestreaming_ResumeStream 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 ovrLivestreamingStatusHandle. Extract the payload from the message handle with ovr_Message_GetLivestreamingStatus().
1
2
3
4
5
6
7
8
9
41
50
51
61
62
72
73
74
// This file was @generated with LibOVRPlatform/codegen/main. Do not modify it!

#ifndef OVR_REQUESTS_LIVESTREAMING_H
#define OVR_REQUESTS_LIVESTREAMING_H

#include "OVR_Types.h"
#include "OVR_Platform_Defs.h"



OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_Livestreaming_GetStatus();

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_Livestreaming_PauseStream();

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_Livestreaming_ResumeStream();

#endif
The documentation for this file was generated from the following file: OVR_Requests_Livestreaming.h