ConferenceServiceEventNames enum Models

The ConferenceServiceEventNames enum gathers events that inform about changes in the participants list and the connected streams.

Inheritance
Implemented types

Constructors

ConferenceServiceEventNames(String value)
const

Values

participantAdded → const ConferenceServiceEventNames

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.

ConferenceServiceEventNames('EVENT_CONFERENCE_PARTICIPANT_ADDED')
participantUpdated → const ConferenceServiceEventNames

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.

ConferenceServiceEventNames('EVENT_CONFERENCE_PARTICIPANT_UPDATED')
permissionsUpdated → const ConferenceServiceEventNames

Emitted when the local participant's permissions are updated.

ConferenceServiceEventNames('EVENT_CONFERENCE_PERMISSIONS_UPDATED')
statusUpdated → const ConferenceServiceEventNames

Emitted when a conference status has changed.

ConferenceServiceEventNames('EVENT_CONFERENCE_STATUS_UPDATED')
streamAdded → const ConferenceServiceEventNames

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 contains audio and video tracks. The SDK can also emit the streamAdded event only for the local participant. When the local participant uses the ConferenceService.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 ConferenceService.startAudio method for this remote participant, the local participant receives the streamAdded event.

ConferenceServiceEventNames('EVENT_CONFERENCE_STREAM_ADDED')
streamUpdated → const ConferenceServiceEventNames

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 ConferenceService.stopAudio or ConferenceService.startAudio method to locally mute or un-mute a selected remote participant who uses a camera, the local participant receives the streamUpdated event.

ConferenceServiceEventNames('EVENT_CONFERENCE_STREAM_UPDATED')
streamRemoved → const ConferenceServiceEventNames

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 ConferenceService.stopAudio method to locally mute a selected remote participant who does not use a camera, the local participant receives the streamRemoved event.

ConferenceServiceEventNames('EVENT_CONFERENCE_STREAM_REMOVED')

Properties

hashCode int
The hash code for this object.
read-onlyinherited
index int
A numeric identifier for the enumerated value.
read-onlyinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
value String
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

valueOf(String? value) ConferenceServiceEventNames

Constants

values → const List<ConferenceServiceEventNames>
A constant List of the values in this enum, in order of their declaration.
[participantAdded, participantUpdated, permissionsUpdated, statusUpdated, streamAdded, streamUpdated, streamRemoved]