Hierarchy

  • default
    • ModeratorControlsService

Accessors

  • get isModeratorControlsAvailable(): boolean
  • isModeratorControlsAvailable checks if selfParticipant is moderator or not.

    Returns boolean

  • get isRecordingFeatureAvailable(): boolean
  • isRecordingFeatureAvailable provides information if the recording is enabled for the meeting.

    Returns boolean

Methods

  • checkSpaceAvailabilityForRecording function checks the space available for the user's account.

    Returns Promise<string | Error>

  • End current meeting for all participants in defined time.

    Parameters

    • timeInSeconds: number

      number Moderator calling this method will leave the meeting immediately and other participants will drop later after the timeout

    Returns Promise<boolean | Error>

  • It returns boolean value, based on participant's capability to turn on video.

    Parameters

    Returns boolean

  • Remove the given participant from the meeting

    Parameters

    Returns Promise<boolean | Error>

  • Set audio Muted/Unmuted state for all participants in the current meeting

    Parameters

    • muted: boolean

      boolean

    Returns Promise<boolean | Error>

  • Set audio Muted/Unmuted for a participant in the current meeting *

    Parameters

    Returns Promise<boolean | Error>

  • Parameters

    Returns Promise<boolean | Error>

  • Parameters

    Returns Promise<boolean | Error>

  • Set video Muted/Unmuted state for all participants in the current meeting

    Parameters

    • muted: boolean

      boolean

    Returns Promise<boolean | Error>

  • Set video Muted/Unmuted for a participant in the current meeting

    Parameters

    Returns Promise<boolean | Error>

  • It turns on/off spotlight on a participant's video.

    Parameters

    • enabled: boolean

      Based on the value passed for enable true/false spotlight is turned on/off respectively for the participant.

    • participant: Participant

    Returns Promise<boolean | Error>

  • This is used to start recording for the meeting. The promise returned by this method indicates if the API call was successful or not. It internally calls checkSpaceAvailabilityForRecording to validate if recording space is available and accordingly invokes the startRecording API. Also recording will only start when isRecordingFeatureAvailable is true and recording is not in progress. Please refer to the recordingState to check if the recording has started or not.

    Returns Promise<boolean | Error>

  • End recording for the current meeting.

    Returns Promise<boolean | Error>

Generated using TypeDoc