CLEAR

LiveStreamingModule


The LiveStreamingModule class enables to retrieve information from a live stream from within the effect, such as reactions and comments

Properties

PropertyDescription

comments

(get) comments: LiveStreamingComments (set) (Not Available)

Provides access to a LiveStreamingComments object that encapsulates data about the live stream's comments

concurrentViewerCount

(get) concurrentViewerCount: ScalarSignal (set) (Not Available)

Provides access to a ScalarSignal that encapsulates the number of concurrent viewers of the live stream

reactions

(get) reactions: LiveStreamingReactions (set) (Not Available)

Provides access to a LiveStreamingReactions object that encapsulates data about the live stream's reactions

state

(get) state: LiveStreaming.State (set) (Not Available)

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. For low volumes of reactions this will correspond to the stream of reaction bubbles that float by the broadcast, for higher volumes of reactions this will an approximate count of how many times the reaction button was tapped, with some rate limiting per-user. This number will not correspond to the number of reactions displayed elsewhere because that number only counts each user's reaction once.

Enums

ValueDescription

State

The LiveStreamingModule.State enum describes the state of a live stream.