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

FOvrLivestreamingStatus Struct

The livestreaming status represents the status of a livestreaming event in your app. You will receive a notification by UOvrPlatformSubsystem::OnLivestreamingStatusChange() whenever your livestreaming session gets updated. The status contains info about your livestream type, whether your mic is enabled, whether the comments are visible and etc.

Constructors

FOvrLivestreamingStatus ()
This is the default constructor for the struct, which initializes the ::ovrLivestreamingStatusHandle and TOvrMessageHandlePtr to their default values.
Signature
FOvrLivestreamingStatus::FOvrLivestreamingStatus()
FOvrLivestreamingStatus ( OvrHandle , MessageHandlePtr )
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
FOvrLivestreamingStatus::FOvrLivestreamingStatus(ovrLivestreamingStatusHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrLivestreamingStatusHandle
MessageHandlePtr: TOvrMessageHandlePtr

Fields

CommentsVisible : bool
This boolean field indicates if the comments from the audience in your livestreaming are visible.
Signature
bool FOvrLivestreamingStatus::CommentsVisible
IsPaused : bool
This boolean field indicates if your livestreaming in the app is paused or not.
Signature
bool FOvrLivestreamingStatus::IsPaused
LivestreamingEnabled : bool
This boolean field indicates if your app is livestreaming enabled. If your app is enabled, you will receive a notification by UOvrPlatformSubsystem::OnLivestreamingStatusChange() when the livestreaming session gets updated.
Signature
bool FOvrLivestreamingStatus::LivestreamingEnabled
LivestreamingType : int32
This field indicates the type of your livestreaming.
Signature
int32 FOvrLivestreamingStatus::LivestreamingType
MicEnabled : bool
This boolean field indicates if your connected mic is enabled. The speaker will be muted if the field is false.
Signature
bool FOvrLivestreamingStatus::MicEnabled

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrLivestreamingStatus::Clear()
Returns
void
Update ( OvrHandle , MessageHandlePtr )
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
void FOvrLivestreamingStatus::Update(ovrLivestreamingStatusHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrLivestreamingStatusHandle
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void