Participant<T extends TrackPublication<Track>> class abstract

Represents a Participant in the room, notifies changes via delegates as well as ChangeNotifier/providers. A change notification is triggered when

  • speaking status changed
  • mute status changed
  • added/removed subscribed tracks
  • metadata changed Base for RemoteParticipant and LocalParticipant, can not be instantiated directly.
Inheritance
Mixed in types
Implementers

Constructors

Participant({required Room room, required String sid, required String identity, required String name})

Properties

audioLevel ↔ double
Audio level between 0-1, 1 being the loudest.
read / write
audioTracks → List<T>
read-only
connectionQuality → ConnectionQuality
Connection quality between the Participant and the Server.
read-only
disposeFuncCount → int
read-onlyinherited
events → EventsEmitter<ParticipantEvent>
finalinherited
firstTrackEncryptionType → EncryptionType
read-only
hasAudio → bool
true if this Participant has more than 1 AudioTrack.
read-only
hashCode → int
(Equality operator) Participant.hashCode is same as sid.hashCode.
read-onlyoverride
hasInfo → bool
read-only
hasListeners → bool
Whether any listeners are currently registered.
read-onlyinherited
hasVideo → bool
true if this Participant has more than 1 VideoTrack.
read-only
identity ↔ String
User-assigned identity.
read / write
isDisposed → bool
read-onlyinherited
isEncrypted → bool
read-only
isMuted → bool
true if Participant is publishing an AudioTrack and is muted.
read-only
isSpeaking → bool
if Participant is currently speaking.
read-only
joinedAt → DateTime
when the participant joined the room
read-only
lastSpokeAt ↔ DateTime?
When the participant had last spoken.
read / write
metadata ↔ String?
Client-assigned metadata, opaque to livekit.
read / write
name → String
Name of the participant (readonly).
read-only
permissions → ParticipantPermissions
read-only
room → Room
Reference to Room
final
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
sid ↔ String
Server assigned unique id.
read / write
trackPublications → Map<String, T>
Map of track sid => published track
final
videoTracks → List<T>
read-only

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
createListener({bool synchronized = false}) → EventsListener<ParticipantEvent>
inherited
dispose() → Future<bool>
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
inherited
getTrackPublicationBySource(TrackSource source) → T?
Tries to find a TrackPublication by its TrackSource. Otherwise, will return a compatible type of TrackPublication for the TrackSource specified. returns null when not found.
isCameraEnabled() → bool
Convenience property to check whether TrackSource.camera is published or not.
isMicrophoneEnabled() → bool
Convenience property to check whether TrackSource.microphone is published or not.
isScreenShareEnabled() → bool
Convenience property to check whether TrackSource.screenShareVideo is published or not.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
onDispose(OnDisposeFunc func) → void
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
setPermissions(ParticipantPermissions newValue) → ParticipantPermissions?
toString() → String
A string representation of this object.
override
unpublishAllTracks({bool notify = true, bool? stopOnUnpublish}) → Future<void>
Convenience method to unpublish all tracks.
unpublishTrack(String trackSid, {bool notify = true}) → Future<void>
updateConnectionQuality(ConnectionQuality quality) → void
updateName(String name) → void

Operators

operator ==(Object other) → bool
(Equality operator) Participant is considered equal when sid's are equal.
override