Event class

Describes the different events that can be emitted from a CallClient.

Implementers

• ActiveSpeakerChangedEvent
• AppMessageReceivedEvent
• AvailableDevicesUpdatedEvent
• CallStateUpdatedEvent
• ErrorEvent
• InputsUpdatedEvent
• LiveStreamErrorEvent
• LiveStreamStartedEvent
• LiveStreamStoppedEvent
• LiveStreamWarningEvent
• NetworkStatsUpdatedEvent
• ParticipantCountsUpdatedEvent
• ParticipantJoinedEvent
• ParticipantLeftEvent
• ParticipantUpdatedEvent
• PublishingUpdatedEvent
• RecordingErrorEvent
• RecordingStartedEvent
• RecordingStoppedEvent
• SubscriptionsProfilesUpdatedEvent
• SubscriptionsUpdatedEvent

Annotations

• @Freezed(copyWith: false, fromJson: false, toJson: false)

Constructors

Event.activeSpeakerChanged({required Participant? participant})

Emitted when the active speaker changes in the CallClient's current call.

const

factory

Event.appMessageReceived({required String data, required ParticipantId from})

Emitted when a custom app message is received from the server.

const

factory

Event.availableDevicesUpdated({required Devices availableDevices})

Emitted when the set of available input/output devices changes

const

factory

Event.callStateUpdated({required CallStateData stateData})

Emitted when the CallClient's CallState changes, most frequently due to invoking CallClient.join or CallClient.leave.

const

factory

Event.error({required String message})

Emitted upon error.

const

factory

Event.inputsUpdated({required InputSettings inputs})

Emitted when the CallClient input settings are updated, normally due to invoking CallClient.join, CallClient.updateInputs or CallClient.updatePublishing.

const

factory

Event.liveStreamError({required StreamId streamId, required String message})

Emitted when a room live streaming error has been encountered.

const

factory

Event.liveStreamStarted({required LiveStreamStatus status})

Emitted when a room live stream has been started.

const

factory

Event.liveStreamStopped({required StreamId streamId})

Emitted when a room live stream has been stopped.

const

factory

Event.liveStreamWarning({required StreamId streamId, required String message})

Emitted when a live streaming warning has been encountered.

const

factory

Event.networkStatsUpdated({required NetworkStats stats})

Emitted when new network statistics have been calculated.

const

factory

Event.participantCountsUpdated({required ParticipantCounts counts})

Emitted when the number of call participants changes.

const

factory

Event.participantJoined({required Participant participant})

Emitted when a participant has joined the CallClient's current call.

const

factory

Event.participantLeft({required Participant participant})

Emitted when a participant has left the CallClient's current call.

const

factory

Event.participantUpdated({required Participant participant})

Emitted when a participant in the CallClient's current call is updated. This means that the participants metadata was changed and/or that one or more of their media tracks changed.

const

factory

Event.publishingUpdated({required PublishingSettings publishing})

Emitted when the CallClient publishing settings are updated, normally due to invoking of CallClient.join or CallClient.updatePublishing.

const

factory

Event.recordingError({required StreamId streamId, required String message})

Emitted when a room recording error has been encountered.

const

factory

Event.recordingStarted({required RecordingStatus status})

Emitted when a room recording has started.

const

factory

Event.recordingStopped({required StreamId streamId})

Emitted when a room recording has stopped.

const

factory

Event.subscriptionProfilesUpdated({required Map<SubscriptionProfile, MediaSubscriptionSettings> profiles})

Emitted when the CallClient's subscription profile settings are updated, due to invoking CallClient.updateSubscriptionProfiles.

const

factory

Event.subscriptionsUpdated({required Map<ParticipantId, SubscriptionSettings> subscriptions})

Emitted when the CallClient's subscription settings are updated, due to invoking CallClient.updateSubscriptions.

const

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

map<TResult extends Object?>({required TResult callStateUpdated(CallStateUpdatedEvent value), required TResult inputsUpdated(InputsUpdatedEvent value), required TResult publishingUpdated(PublishingUpdatedEvent value), required TResult participantJoined(ParticipantJoinedEvent value), required TResult participantUpdated(ParticipantUpdatedEvent value), required TResult participantLeft(ParticipantLeftEvent value), required TResult activeSpeakerChanged(ActiveSpeakerChangedEvent value), required TResult subscriptionsUpdated(SubscriptionsUpdatedEvent value), required TResult participantCountsUpdated(ParticipantCountsUpdatedEvent value), required TResult subscriptionProfilesUpdated(SubscriptionsProfilesUpdatedEvent value), required TResult availableDevicesUpdated(AvailableDevicesUpdatedEvent value), required TResult appMessageReceived(AppMessageReceivedEvent value), required TResult recordingStarted(RecordingStartedEvent value), required TResult recordingStopped(RecordingStoppedEvent value), required TResult recordingError(RecordingErrorEvent value), required TResult liveStreamStarted(LiveStreamStartedEvent value), required TResult liveStreamStopped(LiveStreamStoppedEvent value), required TResult liveStreamWarning(LiveStreamWarningEvent value), required TResult liveStreamError(LiveStreamErrorEvent value), required TResult networkStatsUpdated(NetworkStatsUpdatedEvent value), required TResult error(ErrorEvent value)}) → TResult

inherited

mapOrNull<TResult extends Object?>({TResult? callStateUpdated(CallStateUpdatedEvent value)?, TResult? inputsUpdated(InputsUpdatedEvent value)?, TResult? publishingUpdated(PublishingUpdatedEvent value)?, TResult? participantJoined(ParticipantJoinedEvent value)?, TResult? participantUpdated(ParticipantUpdatedEvent value)?, TResult? participantLeft(ParticipantLeftEvent value)?, TResult? activeSpeakerChanged(ActiveSpeakerChangedEvent value)?, TResult? subscriptionsUpdated(SubscriptionsUpdatedEvent value)?, TResult? participantCountsUpdated(ParticipantCountsUpdatedEvent value)?, TResult? subscriptionProfilesUpdated(SubscriptionsProfilesUpdatedEvent value)?, TResult? availableDevicesUpdated(AvailableDevicesUpdatedEvent value)?, TResult? appMessageReceived(AppMessageReceivedEvent value)?, TResult? recordingStarted(RecordingStartedEvent value)?, TResult? recordingStopped(RecordingStoppedEvent value)?, TResult? recordingError(RecordingErrorEvent value)?, TResult? liveStreamStarted(LiveStreamStartedEvent value)?, TResult? liveStreamStopped(LiveStreamStoppedEvent value)?, TResult? liveStreamWarning(LiveStreamWarningEvent value)?, TResult? liveStreamError(LiveStreamErrorEvent value)?, TResult? networkStatsUpdated(NetworkStatsUpdatedEvent value)?, TResult? error(ErrorEvent value)?}) → TResult?

inherited

maybeMap<TResult extends Object?>({TResult callStateUpdated(CallStateUpdatedEvent value)?, TResult inputsUpdated(InputsUpdatedEvent value)?, TResult publishingUpdated(PublishingUpdatedEvent value)?, TResult participantJoined(ParticipantJoinedEvent value)?, TResult participantUpdated(ParticipantUpdatedEvent value)?, TResult participantLeft(ParticipantLeftEvent value)?, TResult activeSpeakerChanged(ActiveSpeakerChangedEvent value)?, TResult subscriptionsUpdated(SubscriptionsUpdatedEvent value)?, TResult participantCountsUpdated(ParticipantCountsUpdatedEvent value)?, TResult subscriptionProfilesUpdated(SubscriptionsProfilesUpdatedEvent value)?, TResult availableDevicesUpdated(AvailableDevicesUpdatedEvent value)?, TResult appMessageReceived(AppMessageReceivedEvent value)?, TResult recordingStarted(RecordingStartedEvent value)?, TResult recordingStopped(RecordingStoppedEvent value)?, TResult recordingError(RecordingErrorEvent value)?, TResult liveStreamStarted(LiveStreamStartedEvent value)?, TResult liveStreamStopped(LiveStreamStoppedEvent value)?, TResult liveStreamWarning(LiveStreamWarningEvent value)?, TResult liveStreamError(LiveStreamErrorEvent value)?, TResult networkStatsUpdated(NetworkStatsUpdatedEvent value)?, TResult error(ErrorEvent value)?, required TResult orElse()}) → TResult

inherited

maybeWhen<TResult extends Object?>({TResult callStateUpdated(CallStateData stateData)?, TResult inputsUpdated(InputSettings inputs)?, TResult publishingUpdated(PublishingSettings publishing)?, TResult participantJoined(Participant participant)?, TResult participantUpdated(Participant participant)?, TResult participantLeft(Participant participant)?, TResult activeSpeakerChanged(Participant? participant)?, TResult subscriptionsUpdated(Map<ParticipantId, SubscriptionSettings> subscriptions)?, TResult participantCountsUpdated(ParticipantCounts counts)?, TResult subscriptionProfilesUpdated(Map<SubscriptionProfile, MediaSubscriptionSettings> profiles)?, TResult availableDevicesUpdated(Devices availableDevices)?, TResult appMessageReceived(String data, ParticipantId from)?, TResult recordingStarted(RecordingStatus status)?, TResult recordingStopped(StreamId streamId)?, TResult recordingError(StreamId streamId, String message)?, TResult liveStreamStarted(LiveStreamStatus status)?, TResult liveStreamStopped(StreamId streamId)?, TResult liveStreamWarning(StreamId streamId, String message)?, TResult liveStreamError(StreamId streamId, String message)?, TResult networkStatsUpdated(NetworkStats stats)?, TResult error(String message)?, required TResult orElse()}) → TResult

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>({required TResult callStateUpdated(CallStateData stateData), required TResult inputsUpdated(InputSettings inputs), required TResult publishingUpdated(PublishingSettings publishing), required TResult participantJoined(Participant participant), required TResult participantUpdated(Participant participant), required TResult participantLeft(Participant participant), required TResult activeSpeakerChanged(Participant? participant), required TResult subscriptionsUpdated(Map<ParticipantId, SubscriptionSettings> subscriptions), required TResult participantCountsUpdated(ParticipantCounts counts), required TResult subscriptionProfilesUpdated(Map<SubscriptionProfile, MediaSubscriptionSettings> profiles), required TResult availableDevicesUpdated(Devices availableDevices), required TResult appMessageReceived(String data, ParticipantId from), required TResult recordingStarted(RecordingStatus status), required TResult recordingStopped(StreamId streamId), required TResult recordingError(StreamId streamId, String message), required TResult liveStreamStarted(LiveStreamStatus status), required TResult liveStreamStopped(StreamId streamId), required TResult liveStreamWarning(StreamId streamId, String message), required TResult liveStreamError(StreamId streamId, String message), required TResult networkStatsUpdated(NetworkStats stats), required TResult error(String message)}) → TResult

inherited

whenOrNull<TResult extends Object?>({TResult? callStateUpdated(CallStateData stateData)?, TResult? inputsUpdated(InputSettings inputs)?, TResult? publishingUpdated(PublishingSettings publishing)?, TResult? participantJoined(Participant participant)?, TResult? participantUpdated(Participant participant)?, TResult? participantLeft(Participant participant)?, TResult? activeSpeakerChanged(Participant? participant)?, TResult? subscriptionsUpdated(Map<ParticipantId, SubscriptionSettings> subscriptions)?, TResult? participantCountsUpdated(ParticipantCounts counts)?, TResult? subscriptionProfilesUpdated(Map<SubscriptionProfile, MediaSubscriptionSettings> profiles)?, TResult? availableDevicesUpdated(Devices availableDevices)?, TResult? appMessageReceived(String data, ParticipantId from)?, TResult? recordingStarted(RecordingStatus status)?, TResult? recordingStopped(StreamId streamId)?, TResult? recordingError(StreamId streamId, String message)?, TResult? liveStreamStarted(LiveStreamStatus status)?, TResult? liveStreamStopped(StreamId streamId)?, TResult? liveStreamWarning(StreamId streamId, String message)?, TResult? liveStreamError(StreamId streamId, String message)?, TResult? networkStatsUpdated(NetworkStats stats)?, TResult? error(String message)?}) → TResult?

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

fromJson(Map<String, dynamic> json) → Event?