SfuEvent class

SFUEvent is a message that is sent from the SFU to the client.

Inheritance

• Object
• GeneratedMessage
• SfuEvent

Constructors

SfuEvent({SubscriberOffer? subscriberOffer, PublisherAnswer? publisherAnswer, ConnectionQualityChanged? connectionQualityChanged, AudioLevelChanged? audioLevelChanged, ICETrickle? iceTrickle, ChangePublishQuality? changePublishQuality, ParticipantJoined? participantJoined, ParticipantLeft? participantLeft, DominantSpeakerChanged? dominantSpeakerChanged, JoinResponse? joinResponse, HealthCheckResponse? healthCheckResponse, TrackPublished? trackPublished, TrackUnpublished? trackUnpublished, Error? error, CallGrantsUpdated? callGrantsUpdated, GoAway? goAway, ICERestart? iceRestart, PinsChanged? pinsUpdated, CallEnded? callEnded, ParticipantUpdated? participantUpdated, ParticipantMigrationComplete? participantMigrationComplete})

factory

SfuEvent.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

SfuEvent.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Properties

audioLevelChanged ↔ AudioLevelChanged

AudioLevelChanged is sent for change in audio levels of the participants.

getter/setter pair

callEnded ↔ CallEnded

CallEnded is sent by the SFU to the client to signal that the call has ended. The reason may specify why the call has ended.

getter/setter pair

callGrantsUpdated ↔ CallGrantsUpdated

CallGrantsUpdated tells what tracks a participant is allowed to publish.

getter/setter pair

changePublishQuality ↔ ChangePublishQuality

ChangePublishQuality advises the publisher to switch on/off various qualities of their video stream based on the subscription. This is done to save the bandwidth and the CPU of the publisher.

getter/setter pair

connectionQualityChanged ↔ ConnectionQualityChanged

ConnectionQualityChanged is sent to inform the connection quality of the participants in the call. It does not have to contain the full list of call participants in it.

getter/setter pair

dominantSpeakerChanged ↔ DominantSpeakerChanged

DominantSpeakerChanged notifies the client about the current dominant speaker. This is required for certain use cases like the spotlight view.

getter/setter pair

error ↔ Error

Error is used to communicate any error related to the participant. The error code and the message explain what went wrong. Whether the participant can retry is also indicated.

getter/setter pair

eventPlugin → EventPlugin?

Subclasses can override this getter to be notified of changes to protobuf fields.

no setter, inherited

goAway ↔ GoAway

GoAway tells the client to migrate away from the SFU it is connected to. The reason field indicates why this message was sent.

getter/setter pair

hashCode → int

Calculates a hash code based on the contents of the protobuf.

no setter, inherited

healthCheckResponse ↔ HealthCheckResponse

HealthCheckResponse is sent in response to the HealthCheckRequest. It contains the participant count in the call.

getter/setter pair

iceRestart ↔ ICERestart

ICERestart tells the client to perform ICE restart.

getter/setter pair

iceTrickle ↔ ICETrickle

ICETrickle contains the ICE candidate required to establish the ICE transport: part of establishing the PeerConnection and also for ICE restarts.

getter/setter pair

info_ → BuilderInfo

no setter, override

isFrozen → bool

Returns true if this message is marked read-only. Otherwise false.

no setter, inherited

joinResponse ↔ JoinResponse

JoinResponse acknowledges a participant successfully joining the call. This is sent in response to the JoinRequest.

getter/setter pair

participantJoined ↔ ParticipantJoined

ParticipantJoined notifies the client that a new participant has joined the call. This is not sent for anonymous users.

getter/setter pair

participantLeft ↔ ParticipantLeft

ParticipantLeft notifies the client that a call participant has left the call. This is not sent for anonymous users.

getter/setter pair

participantMigrationComplete ↔ ParticipantMigrationComplete

ParticipantMigrationComplete is sent when the participant migration is complete

getter/setter pair

participantUpdated ↔ ParticipantUpdated

ParticipantUpdated is sent when user data is updated

getter/setter pair

pinsUpdated ↔ PinsChanged

PinsChanged is sent the list of pins in the call changes. This event contains the entire list of pins.

getter/setter pair

publisherAnswer ↔ PublisherAnswer

PublisherAnswer sends the SDP answer to the offer sent by the client for establishing the Publisher PeerConnection.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

subscriberOffer ↔ SubscriberOffer

SubscriberOffer sends the SDP offer for establishing the subscriber PeerConnection.

getter/setter pair

trackPublished ↔ TrackPublished

TrackPublished is sent when a new track (like audio, video, screenshare) is published by a participant in the call. It is also sent on mute/unmute.

getter/setter pair

trackUnpublished ↔ TrackUnpublished

TrackUnpublished is sent when a track (like audio, video, screenshare) is no longer published. It is sent on muting a track or when the participant is leaving the call.

getter/setter pair

unknownFields → UnknownFieldSet

no setter, inherited

Methods

addExtension(Extension extension, Object? value) → void

Adds an extension field value to a repeated field.

inherited

check() → void

inherited

clear() → void

Clears all data that was set in this message.

inherited

clearAudioLevelChanged() → void

clearCallEnded() → void

clearCallGrantsUpdated() → void

clearChangePublishQuality() → void

clearConnectionQualityChanged() → void

clearDominantSpeakerChanged() → void

clearError() → void

clearEventPayload() → void

clearExtension(Extension extension) → void

Clears an extension field and also removes the extension.

inherited

clearField(int tagNumber) → void

Clears the contents of a given field.

inherited

clearGoAway() → void

clearHealthCheckResponse() → void

clearIceRestart() → void

clearIceTrickle() → void

clearJoinResponse() → void

clearParticipantJoined() → void

clearParticipantLeft() → void

clearParticipantMigrationComplete() → void

clearParticipantUpdated() → void

clearPinsUpdated() → void

clearPublisherAnswer() → void

clearSubscriberOffer() → void

clearTrackPublished() → void

clearTrackUnpublished() → void

clone() → SfuEvent

Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)

override

copyWith(void updates(SfuEvent)) → SfuEvent

Apply updates to a copy of this message.

override

createEmptyInstance() → SfuEvent

Creates an empty instance of the same message type as this.

override

createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>

Creates a Map representing a map field.

inherited

createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>

Creates List implementing a mutable repeated field.

inherited

ensureAudioLevelChanged() → AudioLevelChanged

ensureCallEnded() → CallEnded

ensureCallGrantsUpdated() → CallGrantsUpdated

ensureChangePublishQuality() → ChangePublishQuality

ensureConnectionQualityChanged() → ConnectionQualityChanged

ensureDominantSpeakerChanged() → DominantSpeakerChanged

ensureError() → Error

ensureGoAway() → GoAway

ensureHealthCheckResponse() → HealthCheckResponse

ensureIceRestart() → ICERestart

ensureIceTrickle() → ICETrickle

ensureJoinResponse() → JoinResponse

ensureParticipantJoined() → ParticipantJoined

ensureParticipantLeft() → ParticipantLeft

ensureParticipantMigrationComplete() → ParticipantMigrationComplete

ensureParticipantUpdated() → ParticipantUpdated

ensurePinsUpdated() → PinsChanged

ensurePublisherAnswer() → PublisherAnswer

ensureSubscriberOffer() → SubscriberOffer

ensureTrackPublished() → TrackPublished

ensureTrackUnpublished() → TrackUnpublished

extensionsAreInitialized() → bool

inherited

freeze() → GeneratedMessage

Make this message read-only.

inherited

getDefaultForField(int tagNumber) → dynamic

Returns the default value for the given field.

inherited

getExtension(Extension extension) → dynamic

Returns the value of extension.

inherited

getField(int tagNumber) → dynamic

Returns the value of the field associated with tagNumber, or the default value if it is not set.

inherited

getFieldOrNull(int tagNumber) → dynamic

Returns the value of a field, ignoring any defaults.

inherited

getTagNumber(String fieldName) → int?

inherited

hasAudioLevelChanged() → bool

hasCallEnded() → bool

hasCallGrantsUpdated() → bool

hasChangePublishQuality() → bool

hasConnectionQualityChanged() → bool

hasDominantSpeakerChanged() → bool

hasError() → bool

hasExtension(Extension extension) → bool

Returns true if a value of extension is present.

inherited

hasField(int tagNumber) → bool

Whether this message has a field associated with tagNumber.

inherited

hasGoAway() → bool

hasHealthCheckResponse() → bool

hasIceRestart() → bool

hasIceTrickle() → bool

hasJoinResponse() → bool

hasParticipantJoined() → bool

hasParticipantLeft() → bool

hasParticipantMigrationComplete() → bool

hasParticipantUpdated() → bool

hasPinsUpdated() → bool

hasPublisherAnswer() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasSubscriberOffer() → bool

hasTrackPublished() → bool

hasTrackUnpublished() → bool

isInitialized() → bool

Whether all required fields in the message and embedded messages are set.

inherited

mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges serialized protocol buffer data into this message.

inherited

mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

inherited

mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.

inherited

mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from a JSON object represented as a Dart map.

inherited

mergeFromMessage(GeneratedMessage other) → void

Merges the contents of the other into this message.

inherited

mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void

Merges field values from json, a JSON object using proto3 encoding.

inherited

mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setExtension(Extension extension, Object value) → void

Sets the value of a non-repeated extension field to value.

inherited

setField(int tagNumber, Object value) → void

Sets the value of a field by its tagNumber.

inherited

toBuilder() → GeneratedMessage

Creates a writable, shallow copy of this message.

inherited

toDebugString() → String

Returns a String representation of this message.

inherited

toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?

Returns an Object representing Proto3 JSON serialization of this.

inherited

toString() → String

Returns a String representation of this message.

inherited

whichEventPayload() → SfuEvent_EventPayload

writeToBuffer() → Uint8List

inherited

writeToCodedBufferWriter(CodedBufferWriter output) → void

inherited

writeToJson() → String

Returns a JSON string that encodes this message.

inherited

writeToJsonMap() → Map<String, dynamic>

Returns the JSON encoding of this message as a Dart Map.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

create() → SfuEvent

createRepeated() → PbList<SfuEvent>

getDefault() → SfuEvent