Modules

Enumeration Members

ParticipantAdded

• ParticipantAdded: "EVENT_CONFERENCE_PARTICIPANT_ADDED"

Emitted when a new participant is invited to a conference. The SDK does not emit the participantAdded event for the local participant. Listeners only receive the participantAdded events about users; they do not receive events for other listeners. Users receive the participantAdded events about users and do not receive any events about listeners.

---

ParticipantUpdated

• ParticipantUpdated: "EVENT_CONFERENCE_PARTICIPANT_UPDATED"

Emitted when a conference participant changes status. Listeners only receive the participantUpdated events about users; they do not receive events for other listeners. Users receive the participantUpdated events about users and do not receive any events about listeners.

---

StreamAdded

• StreamAdded: "EVENT_CONFERENCE_STREAM_ADDED"

Emitted when the SDK adds a new stream to a conference participant. Each conference participant can be connected to two streams: the audio and video stream and the screen-share stream. If a participant enables audio or video, the SDK adds the audio and video stream to the participant and emits the streamAdded event to all participants. When a participant is connected to the audio and video stream and changes the stream, for example, enables a camera while using a microphone, the SDK updates the audio and video stream and emits the streamUpdated event. When a participant starts sharing a screen, the SDK adds the screen-share stream to this participants and emits the streamAdded event to all participants. The following graphic shows this behavior:

Based on the stream type, the application chooses to either render a camera view or a screen-share view.
When a new participant joins a conference with enabled audio and video, the SDK emits the streamAdded event that includes audio and video tracks.
The SDK can also emit the streamAdded event only for the local participant. When the local participant uses the stopAudio method to locally mute the selected remote participant who does not use a camera, the local participant receives the streamRemoved event. After using the startAudio method for this remote participant, the local participant receives the streamAdded event.

---

StreamUpdated

• StreamUpdated: "EVENT_CONFERENCE_STREAM_UPDATED"

Emitted when a conference participant who is connected to the audio and video stream changes the stream by enabling a microphone while using a camera or by enabling a camera while using a microphone. The event is emitted to all conference participants. The following graphic shows this behavior:

The SDK can also emit the streamUpdated event only for the local participant. When the local participant uses the stopAudio or startAudio method to locally mute or unmute a selected remote participant who uses a camera, the local participant receives the streamUpdated event.

---

StreamRemoved

• StreamRemoved: "EVENT_CONFERENCE_STREAM_REMOVED"

Emitted when the SDK removes a stream from a conference participant. Each conference participant can be connected to two streams: the audio and video stream and the screen-share stream. If a participant disables audio and video or stops a screen-share presentation, the SDK removes the proper stream and emits the streamRemoved event to all conference participants.
The SDK can also emit the streamRemoved event only for the local participant. When the local participant uses the stopAudio method to locally mute a selected remote participant who does not use a camera, the local participant receives the streamRemoved event.

---

FilePresentationStarted

• FilePresentationStarted: "EVENT_FILEPRESENTATION_STARTED"

Emitted when a presenter starts a file presentation.

---

FilePresentationStopped

• FilePresentationStopped: "EVENT_FILEPRESENTATION_STOPPED"

Emitted when a presenter ends a file presentation.

---

FilePresentationUpdated

• FilePresentationUpdated: "EVENT_FILEPRESENTATION_UPDATED"

Emitted when the presenter changes the displayed page of the shared file.

---

VideoPresentationPaused

• VideoPresentationPaused: "EVENT_VIDEOPRESENTATION_PAUSED"

Emitted when a video presentation is paused.

---

VideoPresentationPlayed

• VideoPresentationPlayed: "EVENT_VIDEOPRESENTATION_PLAYED"

Emitted when a video presentation is resumed.

---

VideoPresentationSought

• VideoPresentationSought: "EVENT_VIDEOPRESENTATION_SOUGHT"

Emitted when a video presentation is sought.

---

VideoPresentationStarted

• VideoPresentationStarted: "EVENT_VIDEOPRESENTATION_STARTED"

Emitted when a video presentation is started.

Type Aliases

AudioTrack

Ƭ AudioTrack: any

The AudioTrack type gathers audio tracks available in a stream.

---

VideoTrack

Ƭ VideoTrack: any

The VideoTrack type gathers video tracks available in a stream.

---

MediaStream

Ƭ MediaStream: Object

The MediaStream type gathers information about media streams.

Type declaration

---

UnsubscribeFunction

Ƭ UnsubscribeFunction: () => void

Type declaration

▸ (): void

The UnsubscribeFunction unsubscribes from event listeners.

Returns

void

Based on the stream type, the application chooses to either render a camera view or a screen-share view.
When a new participant joins a conference with enabled audio and video, the SDK emits the streamAdded event that includes audio and video tracks.
The SDK can also emit the streamAdded event only for the local participant. When the local participant uses the stopAudio method to locally mute the selected remote participant who does not use a camera, the local participant receives the streamRemoved event. After using the startAudio method for this remote participant, the local participant receives the streamAdded event.

---

StreamUpdated

• StreamUpdated: Object = "EVENT_CONFERENCE_STREAM_UPDATED"

Emitted when a conference participant who is connected to the audio and video stream changes the stream by enabling a microphone while using a camera or by enabling a camera while using a microphone. The event is emitted to all conference participants. The following graphic shows this behavior:

The SDK can also emit the streamUpdated event only for the local participant. When the local participant uses the stopAudio or startAudio method to locally mute or unmute a selected remote participant who uses a camera, the local participant receives the streamUpdated event.

---

StreamRemoved

• StreamRemoved: Object = "EVENT_CONFERENCE_STREAM_REMOVED"

Emitted when the SDK removes a stream from a conference participant. Each conference participant can be connected to two streams: the audio and video stream and the screen-share stream. If a participant disables audio and video or stops a screen-share presentation, the SDK removes the proper stream and emits the streamRemoved event to all conference participants.
The SDK can also emit the streamRemoved event only for the local participant. When the local participant uses the stopAudio method to locally mute a selected remote participant who does not use a camera, the local participant receives the streamRemoved event.

---

VideoPresentationPaused

• VideoPresentationPaused: Object = "EVENT_VIDEOPRESENTATION_PAUSED"

Emitted when a video presentation is paused.

---

VideoPresentationPlayed

• VideoPresentationPlayed: Object = "EVENT_VIDEOPRESENTATION_PLAYED"

Emitted when a video presentation is resumed.

---

VideoPresentationSought

• VideoPresentationSought: Object = "EVENT_VIDEOPRESENTATION_SOUGHT"

Emitted when a video presentation is sought.

---

VideoPresentationStarted

• VideoPresentationStarted: Object = "EVENT_VIDEOPRESENTATION_STARTED"

Emitted when a video presentation is started.

Type aliases

AudioTrack

Ƭ AudioTrack: any

The AudioTrack type gathers audio tracks available in a stream.

---

MediaStream

Ƭ MediaStream: Object

The MediaStream type gathers information about media streams.

Type declaration

---

UnsubscribeFunction

Ƭ UnsubscribeFunction: () => void

Type declaration

▸ (): void

The UnsubscribeFunction unsubscribes from event listeners.

Returns

void

---

VideoTrack

Ƭ VideoTrack: any

The VideoTrack type gathers video tracks available in a stream.