LiveStreamingModule Module

The LiveStreamingModule class exposes Facebook Live functionality to an effect.

Usage

const LiveStreaming = require('LiveStreaming');

Properties

PropertyDescription

comments

read-only: LiveStreamingComments

Specifies a LiveStreamingComments object that lets you interact with comments on the live stream.

concurrentViewerCount

read-only: ScalarSignal

Specifies a ScalarSignal representing the number of concurrent viewers of the Live stream. This always matches the number that the broadcaster sees on their screen.

reactions

read-only: LiveStreamingReactions

Specifies a LiveStreamingReactions object that lets you interact with reactions on the live stream.

state

read-only: LiveStreaming.State

Specifies a LiveStreaming.State enum value indicating the broadcast state.

Methods

This class exposes no methods.

Classes

ClassDescription

LiveStreamingComments

The LiveStreamingComments class provides access to the Facebook Live comments stream.

LiveStreamingReactions

The LiveStreamingReactions class provides access to the Facebook Live reactions stream.

Enums

EnumDescription

State

The State enum describes the state of a live stream.

Example

Include the LiveStreaming module in your script with the following code:

const LiveStreaming = require('LiveStreaming');