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

• Object
• ChangeNotifier
• Participant<LocalTrackPublication<LocalTrack>>
• LocalParticipant

Constructors

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

Properties

audioLevel ↔ double

Audio level between 0-1, 1 being the loudest.

getter/setter pair, inherited

audioTrackPublications → List<LocalTrackPublication<LocalAudioTrack>>

A convenience property to get all audio tracks.

no setter, override

connectionQuality → ConnectionQuality

Connection quality between the Participant and the Server.

no setter, inherited

disposeFuncCount → int

no setter, inherited

events → EventsEmitter<ParticipantEvent>

final, inherited

firstTrackEncryptionType → EncryptionType

no setter, inherited

hasAudio → bool

true if this Participant has more than 1 AudioTrack.

no setter, inherited

hashCode → int

(Equality operator) Participant.hashCode is same as sid.hashCode.

no setter, inherited

hasInfo → bool

no setter, inherited

hasListeners → bool

Whether any listeners are currently registered.

no setter, inherited

hasVideo → bool

true if this Participant has more than 1 VideoTrack.

no setter, inherited

identity ↔ String

User-assigned identity.

getter/setter pair, inherited

isDisposed → bool

no setter, inherited

isEncrypted → bool

no setter, inherited

isMuted → bool

true if Participant is publishing an AudioTrack and is muted.

no setter, inherited

isSpeaking ↔ bool

if Participant is currently speaking.

getter/setter pair, inherited

joinedAt → DateTime

when the participant joined the room

no setter, inherited

lastSpokeAt ↔ DateTime?

When the participant had last spoken.

getter/setter pair, inherited

metadata ↔ String?

Client-assigned metadata, opaque to livekit.

getter/setter pair, inherited

name → String

Name of the participant (readonly).

no setter, inherited

permissions → ParticipantPermissions

no setter, inherited

room → Room

Reference to Room

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sid ↔ String

Server assigned unique id.

getter/setter pair, inherited

trackPublications → Map<String, LocalTrackPublication<LocalTrack>>

Map of track sid => published track

final, inherited

videoTrackPublications → List<LocalTrackPublication<LocalVideoTrack>>

A convenience property to get all video tracks.

no setter, override

Methods

addListener(VoidCallback listener) → void

Register a closure to be called when the object changes.

inherited

addTrackPublication(LocalTrackPublication<LocalTrack> pub) → void

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

getTrackPublicationByName(String name) → LocalTrackPublication<LocalTrack>?

get a TrackPublication by its name. returns null when not found.

override

getTrackPublicationBySid(String sid) → LocalTrackPublication<LocalTrack>?

get a TrackPublication by its sid. returns null when not found.

override

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.

override

getTrackPublications() → List<LocalTrackPublication<LocalTrack>>

get all TrackPublications.

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

isScreenShareAudioEnabled() → bool

Convenience property to check whether TrackSource.screenShareAudio 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

publishAdditionalCodecForPublication(LocalTrackPublication<LocalTrack> publication, String backupCodec) → Future<void>

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, {bool? reliable, List<String>? destinationIdentities, String? topic}) → Future<void>

Publish a new data payload to the room. @param reliable, when true, data will be sent reliably. @param destinationIdentities When empty, data will be forwarded to each participant in the room. @param topic, the topic under which the message gets published.

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

removePublishedTrack(String trackSid, {bool notify = true}) → Future<void>

rePublishAllTracks() → Future<void>

sendTrackSubscriptionPermissions() → void

setCameraEnabled(bool enabled, {CameraCaptureOptions? cameraCaptureOptions}) → Future<LocalTrackPublication<LocalTrack>?>

Shortcut for publishing a TrackSource.camera

setMetadata(String metadata) → void

Sets and updates the metadata of the local participant. Note: this requires CanUpdateOwnMetadata permission encoded in the token. @param metadata

setMicrophoneEnabled(bool enabled, {AudioCaptureOptions? audioCaptureOptions}) → Future<LocalTrackPublication<LocalTrack>?>

Shortcut for publishing a TrackSource.microphone

setName(String name) → void

Sets and updates the name of the local participant. Note: this requires CanUpdateOwnMetadata permission encoded in the token. @param name

setPermissions(ParticipantPermissions newValue) → ParticipantPermissions?

override

setScreenShareEnabled(bool enabled, {bool? captureScreenAudio, ScreenShareCaptureOptions? screenShareCaptureOptions}) → Future<LocalTrackPublication<LocalTrack>?>

Shortcut for publishing a TrackSource.screenShareVideo

setSourceEnabled(TrackSource source, bool enabled, {bool? captureScreenAudio, AudioCaptureOptions? audioCaptureOptions, CameraCaptureOptions? cameraCaptureOptions, ScreenShareCaptureOptions? screenShareCaptureOptions}) → 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, bool? stopOnUnpublish}) → Future<void>

Convenience method to unpublish all tracks.

updateConnectionQuality(ConnectionQuality quality) → void

inherited

updateFromInfo(ParticipantInfo info) → Future<bool>

inherited

updateName(String name) → void

inherited

Operators

operator ==(Object other) → bool

(Equality operator) Participant is considered equal when sid's are equal.

inherited