Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClosedCaptionsController

The ClosedCaptionsController class is a managing class to control the closed captions related functions and states in an active meeting session, such as start closed captions or stop closed captions.

Hierarchy

  • ClosedCaptionsEventEmitter
    • ClosedCaptionsController

Index

Constructors

Events

Methods

Constructors

constructor

Events

on

Methods

getClosedCaptionsState

  • Returns the current state of the closed captions in the meetings.

    Returns ClosedCaptionsState

    ClosedCaptionsState: UNACTIVATED, STARTED, STOPPED

isClosedCaptionsAllowed

  • isClosedCaptionsAllowed(): boolean

  • Indicates the closed captions whether allowed to start.

    Returns boolean

    True means closed captions allowed or otherwise

off

  • Removes the specified listener from the listener array for the event named eventName.

    Parameters

    Returns void

once

  • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

    Parameters

    Returns void

startClosedCaptions

  • Start the closed captions and creates the data channel in an active meeting.

    description

    A successful call of the startClosedCaptions triggers the onClosedCaptionsStateChanged event ClosedCaptionsEvent.CLOSED_CAPTIONS_STATE_CHANGED callback.

    Returns Promise<ErrorCodeType>

    0 means the action succeeds or fails otherwise

stopClosedCaptions

  • Stops the closed captions and deletes the data channel in an active meeting.

    description

    A successful call of the stopClosedCaptions triggers the onClosedCaptionsStateChanged event ClosedCaptionsEvent.CLOSED_CAPTIONS_STATE_CHANGED callback.

    Returns Promise<ErrorCodeType>

    0 means the API call is valid or fails otherwise