RemoteParticipant class
Represents other participant in the Room.
- Inheritance
-
- Object
- ChangeNotifier
- Participant<
RemoteTrackPublication< RemoteTrack> > - RemoteParticipant
Constructors
- RemoteParticipant({required Room room, required String sid, required String identity, required String name})
- RemoteParticipant.fromInfo({required Room room, required ParticipantInfo info})
Properties
- audioLevel ↔ double
-
Audio level between 0-1, 1 being the loudest.
getter/setter pairinherited
-
audioTrackPublications
→ List<
RemoteTrackPublication< RemoteAudioTrack> > -
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
- firstTrackEncryptionType → EncryptionType
-
no setterinherited
- 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
- isEncrypted → bool
-
no setterinherited
- isMuted → bool
-
true if Participant is publishing an AudioTrack and is muted.
no setterinherited
- isSpeaking ↔ bool
-
if Participant is currently speaking.
getter/setter pairinherited
- 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.
getter/setter pairinherited
-
subscribedTracks
→ List<
RemoteTrackPublication< RemoteTrack> > -
no setter
-
trackPublications
→ Map<
String, RemoteTrackPublication< RemoteTrack> > -
Map of track sid => published track
finalinherited
-
videoTrackPublications
→ List<
RemoteTrackPublication< RemoteVideoTrack> > -
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
-
addSubscribedMediaTrack(
MediaStreamTrack mediaTrack, MediaStream stream, String trackSid, {RTCRtpReceiver? receiver, AudioOutputOptions audioOutputOptions = const AudioOutputOptions()}) → Future< void> -
addTrackPublication(
RemoteTrackPublication< RemoteTrack> 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) → RemoteTrackPublication< RemoteTrack> ? -
get a TrackPublication by its name.
returns null when not found.
override
-
getTrackPublicationBySid(
String sid) → RemoteTrackPublication< RemoteTrack> ? -
get a TrackPublication by its sid.
returns null when not found.
override
-
getTrackPublicationBySource(
TrackSource source) → RemoteTrackPublication< RemoteTrack> ? -
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< RemoteTrackPublication< RemoteTrack> > -
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
-
Convenience property to check whether TrackSource.screenShareAudio is published or not.
inherited
-
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
-
participantTracks(
) → ParticipantTracks -
removeAllPublishedTracks(
{bool notify = true}) → Future< void> -
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> -
setPermissions(
ParticipantPermissions newValue) → ParticipantPermissions? -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateConnectionQuality(
ConnectionQuality quality) → void -
inherited
-
updateFromInfo(
ParticipantInfo info) → Future< bool> -
override
-
updateName(
String name) → void -
inherited
Operators
-
operator ==(
Object other) → bool -
(Equality operator) Participant is considered equal when sid's are equal.
inherited