LocalParticipant class

Represents the current participant in the room. Instance of LocalParticipant is automatically created after successfully connecting to a Room and will be accessible from Room.localParticipant.

Inheritance

Constructors

LocalParticipant({required Room room, required ParticipantInfo info})

Properties

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

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) → LocalTrackPublication<LocalTrack>?
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.
inherited
isCameraEnabled() → bool
Convenience property to check whether TrackSource.camera is published or not.
inherited
isMicrophoneEnabled() → bool
Convenience property to check whether TrackSource.microphone is published or not.
inherited
isScreenShareEnabled() → bool
Convenience property to check whether TrackSource.screenShareVideo is published or not.
inherited
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
publishAudioTrack(LocalAudioTrack track, {AudioPublishOptions? publishOptions}) → Future<LocalTrackPublication<LocalAudioTrack>>
Publish an AudioTrack to the Room. For most cases, using setMicrophoneEnabled would be simpler and recommended.
publishData(List<int> data, {Reliability reliability = Reliability.reliable, List<String>? destinationSids}) → Future<void>
Publish a new data payload to the room. @param destinationSids When empty, data will be forwarded to each participant in the room.
publishedTracksInfo() → Iterable<TrackPublishedResponse>
publishVideoTrack(LocalVideoTrack track, {VideoPublishOptions? publishOptions}) → Future<LocalTrackPublication<LocalVideoTrack>>
Publish a LocalVideoTrack to the Room. For most cases, using setCameraEnabled would be simpler and recommended.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
setCameraEnabled(bool enabled) → Future<LocalTrackPublication<LocalTrack>?>
Shortcut for publishing a TrackSource.camera
setMicrophoneEnabled(bool enabled) → Future<LocalTrackPublication<LocalTrack>?>
Shortcut for publishing a TrackSource.microphone
setPermissions(ParticipantPermissions newValue) → ParticipantPermissions?
override
setScreenShareEnabled(bool enabled) → Future<LocalTrackPublication<LocalTrack>?>
Shortcut for publishing a TrackSource.screenShareVideo
setSourceEnabled(TrackSource source, bool enabled) → Future<LocalTrackPublication<LocalTrack>?>
A convenience method to publish a track for a specific TrackSource. This is the recommended method to publish tracks.
setTrackSubscriptionPermissions({required bool allParticipantsAllowed, List<ParticipantTrackPermission> trackPermissions = const []}) → void
Control who can subscribe to LocalParticipant's published tracks.
toString() → String
A string representation of this object.
inherited
unpublishAllTracks({bool notify = true}) → Future<void>
Convenience method to unpublish all tracks.
inherited
unpublishTrack(String trackSid, {bool notify = true}) → Future<void>
Unpublish a LocalTrackPublication that's already published by this LocalParticipant.
override
updateConnectionQuality(ConnectionQuality quality) → void
inherited

Operators

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