MeetingController | RingCentral Video Client SDK for Browser

The MeetingController class is the main class for managing in-meeting actions, the application can use it to lock or leave/end the meeting and obtains sub-controllers to do more in-meeting actions.

Hierarchy

MeetingEventEmitter
- MeetingController

Constructors

constructor

new MeetingController(): MeetingController

Inherited from MeetingEventEmitter.constructor
Returns MeetingController

Events

on

on(event: MEETING_LOCK_STATE_CHANGED, listener: ((locked: boolean) => void)): any
on(event: MEETING_STATE_CHANGED, listener: ((state: RcvMeetingState) => void)): any
on(event: MEETING_ENCRYPTION_STATE_CHANGED, listener: ((state: E2EEState) => void)): any

Inherited from MeetingEventEmitter.on

Occurs when the meeting lock state is changed

Parameters
- event: MEETING_LOCK_STATE_CHANGED
- listener: ((locked: boolean) => void)
  - - (locked: boolean): void
    - Parameters
      - locked: boolean
      Returns void
Returns any
Occurs when the meeting state changes.

Parameters
- event: MEETING_STATE_CHANGED
- listener: ((state: RcvMeetingState) => void)
  - - (state: RcvMeetingState): void
    - Parameters
      - state: RcvMeetingState
      Returns void
Returns any
inheritdoc MeetingEvent.MEETING_ENCRYPTION_STATE_CHANGED
Parameters
- event: MEETING_ENCRYPTION_STATE_CHANGED
- listener: ((state: E2EEState) => void)
  - - (state: E2EEState): void
    - Parameters
      - state: E2EEState
      Returns void
Returns any

Methods

disableEndToEndEncryption

disableEndToEndEncryption(): ErrorCodeType

Disables the end-to-end encryption in the meeting.

description
A successful call of disableEndToEndEncryption triggers the MeetingEvent.MEETING_ENCRYPTION_STATE_CHANGED event callback for all meeting users.

Returns ErrorCodeType
0 means the action succeeds or fails otherwise

enableEndToEndEncryption

enableEndToEndEncryption(): Promise<ErrorCodeType>

Enables the end-to-end encryption in the meeting dynamically.

description
A successful call of enableEndToEndEncryption triggers the MeetingEvent.MEETING_ENCRYPTION_STATE_CHANGED event callback for all meeting users.

Returns Promise<ErrorCodeType>
0 means the action succeeds or fails otherwise

endMeeting

endMeeting(): Promise<ErrorCodeType>

Ends the current meeting.

description
A successful call of endMeeting triggers the EngineEvent.MEETING_LEFT 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

getAudioController

getAudioController(): AudioController

Gets the AudioController instance.
description
AudioController instance listens for some events if initialized successfully, related events:
Returns AudioController
The AudioController instance or undefined otherwise

getChatController

getChatController(): ChatController

Gets the ChatController instance.
description
ChatController instance listens for some events if initialized successfully, related to events:
- ChatEvent.CHAT_MESSAGE_RECEIVED
Returns ChatController
The ChatController instance

getClosedCaptionsController

getClosedCaptionsController(): ClosedCaptionsController

Gets the ClosedCaptionsController instance.
description
ClosedCaptionsController instance listens for some events if initialized successfully, related to events:
- ClosedCaptionsEvent.CLOSED_CAPTIONS_STATE_CHANGED
- ClosedCaptionsEvent.CLOSED_CAPTIONS_DATA
Returns ClosedCaptionsController
The ClosedCaptionsController instance

getEndToEndEncryptionState

getEndToEndEncryptionState(): E2EEState

Get the current EndToEnd Encryption state.

Returns E2EEState
E2EEState

getLiveTranscriptionController

getLiveTranscriptionController(): LiveTranscriptionController

Gets the LiveTranscription instance.
description
LiveTranscription instance listens for some events if initialized successfully, related to events:
Returns LiveTranscriptionController
The LiveTranscription instance

getMeetingInfo

getMeetingInfo(): Promise<IMeetingInfo>

Gets the current active meeting details.

Returns Promise<IMeetingInfo>
The meeting information object or error code 10000

getMeetingState

getMeetingState(): RcvMeetingState

Get the current meeting state.

Returns RcvMeetingState
RcvMeetingState

getRecordingController

getRecordingController(): RecordingController

Gets the RecordingController instance.
description
RecordingController instance listens for some events if initialized successfully, related to events:
- RecordingEvent.RECORDING_STATE_CHANGED
- RecordingEvent.RECORDING_ALLOWED_CHANGED
Returns RecordingController
The RecordingController instance

getSharingController

getSharingController(): SharingController

Gets the SharingController instance.
description
SharingController instance listens for some events if initialized successfully, related events:
Returns SharingController
The SharingController instance

getStreamManager

getStreamManager(): StreamManager

Gets the StreamManager instance.
description
StreamManager instance listens for some events if initialized successfully, related events:
Returns StreamManager
The StreamManager instance

getUserController

getUserController(): UserController

Gets the UserController instance.
description
UserController instance listens for some events if initialized successfully, related to events:
Returns UserController
The UserController instance

getVideoController

getVideoController(): VideoController

Gets the VideoController instance.
description
VideoController instance listens for some events if initialized successfully, related events:
Returns VideoController
The VideoController instance

isMeetingLocked

isMeetingLocked(): boolean

Indicates whether the meeting is locked.

Returns boolean
True means the meeting is locked or otherwise

leaveMeeting

leaveMeeting(): Promise<ErrorCodeType>

Leaves the current meeting.

description
A successful call of leaveMeeting triggers the {@link RcvEngine.on(EngineEvent.MEETING_LEFT)} event callback.

Returns Promise<ErrorCodeType>
0 means the action succeeds or fails otherwise

leaveMeetingViaBeacon

leaveMeetingViaBeacon(): Promise<ErrorCodeType>

Leaves the current meeting via beacon.

description
A successful call of leaveMeetingViaBeacon triggers the {@link RcvEngine.on(EngineEvent.MEETING_LEFT)} event callback.

Returns Promise<ErrorCodeType>
0 means the action succeeds or fails otherwise

lockMeeting

lockMeeting(): Promise<ErrorCodeType>

Locks meetings.

descriptiona
successful call of lockMeeting triggers the MeetingEvent.MEETING_LOCK_STATE_CHANGED event callback to all meeting participants.

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

Returns Promise<ErrorCodeType>
0 means the action succeeds or fails otherwise

off

off(eventName: MeetingEvent, listener: TEventCB): void

Inherited from MeetingEventEmitter.off

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

Parameters
- eventName: MeetingEvent
- listener: TEventCB
Returns void

once

once(eventName: MeetingEvent, listener: TEventCB): void

Inherited from MeetingEventEmitter.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
- eventName: MeetingEvent
- listener: TEventCB
Returns void

unlockMeeting

unlockMeeting(): Promise<ErrorCodeType>

Unlocks meetings.

descriptiona
successful call of unlockMeeting triggers the MeetingEvent.MEETING_LOCK_STATE_CHANGED event callback to all meeting participants.

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

Returns Promise<ErrorCodeType>
0 means the action succeeds or fails otherwise

Hierarchy

Index

Constructors

Events

Methods

Constructors

constructor

Returns MeetingController

Events

on

Parameters

event: MEETING_LOCK_STATE_CHANGED

listener: ((locked: boolean) => void)

Parameters

locked: boolean

Returns void

Returns any

Parameters

event: MEETING_STATE_CHANGED

listener: ((state: RcvMeetingState) => void)

Parameters

state: RcvMeetingState

Returns void

Returns any

Parameters

event: MEETING_ENCRYPTION_STATE_CHANGED

listener: ((state: E2EEState) => void)

Parameters

state: E2EEState

Returns void

Returns any

Methods

disableEndToEndEncryption

Returns ErrorCodeType

enableEndToEndEncryption

Returns Promise<ErrorCodeType>

endMeeting

Returns Promise<ErrorCodeType>

getAudioController

Returns AudioController

getChatController

Returns ChatController

getClosedCaptionsController

Returns ClosedCaptionsController

getEndToEndEncryptionState

Returns E2EEState

getLiveTranscriptionController

Returns LiveTranscriptionController

getMeetingInfo

Returns Promise<IMeetingInfo>

getMeetingState

Returns RcvMeetingState

getRecordingController

Returns RecordingController

getSharingController

Returns SharingController

getStreamManager

Returns StreamManager

getUserController

Returns UserController

getVideoController

Returns VideoController

isMeetingLocked

Returns boolean

leaveMeeting

Returns Promise<ErrorCodeType>

leaveMeetingViaBeacon

Returns Promise<ErrorCodeType>

lockMeeting

Returns Promise<ErrorCodeType>

off

Parameters

eventName: MeetingEvent

listener: TEventCB

Returns void

once

Parameters

eventName: MeetingEvent

listener: TEventCB

Returns void