Options
All
  • Public
  • Public/Protected
  • All
Menu

The RecordingController class is a managing class to control the recording functions and states in an active meeting, such as starting or pausing the recording.

Hierarchy

  • RecordingEventEmitter
    • RecordingController

Index

Constructors

Events

  • Occurs when the meeting recording state is changed, refer to RecordingStatus

    Parameters

    Returns any

  • Occurs when the meeting recording privilege changes. For example, when a user assigns as the moderator.

    Parameters

    • event: RECORDING_ALLOWED_CHANGED
    • listener: ((allowed: boolean) => void)
        • (allowed: boolean): void
        • Parameters

          • allowed: boolean

          Returns void

    Returns any

Methods

  • getRecordingDuration(): number
  • Gets the current recording duration (seconds).

    Returns number

    The recording duration

  • Get current meeting recording state

    Returns RecordingStatus

    The current recording status

  • isRecordingAllowed(): boolean
  • Indicates whether the local user has permission to control the recording functions.

    Returns boolean

    True means has permission or otherwise

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

    Parameters

    Returns void

  • 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

  • Pauses recording the meeting session.

    description

    A successful call of pauseRecording triggers the RecordingEvent.RECORDING_STATE_CHANGED event callback for all meeting users.

    description

    Only the meeting host or moderator has permission to invoke this method.

    Returns Promise<ErrorCodeType>

    0 means the action succeeds or fails otherwise

  • Starts recording the meeting session.

    description

    A successful call of pauseRecording triggers the RecordingEvent.RECORDING_STATE_CHANGED event callback for all meeting users.

    description

    Only the meeting host or moderator has permission to invoke this method.

    Returns Promise<ErrorCodeType>

    0 means the action succeeds or fails otherwise