RemoteTrackPublication<T extends RemoteTrack> class

Represents a track publication from a RemoteParticipant. Provides methods to control if we should subscribe to the track, and its quality (for video).

Inheritance

Constructors

RemoteTrackPublication({required RemoteParticipant participant, required TrackInfo info, T? track})

Properties

dimensions VideoDimensions?
The video dimensions of the Track, reported by publisher. Only available for VideoTracks. (readonly)
read-onlyinherited
disposeFuncCount int
read-onlyinherited
enabled bool
read / write
encryptionType EncryptionType
read-onlyinherited
fps int
read-only
hashCode int
The hash code for this object.
read-onlyinherited
isDisposed bool
read-onlyinherited
isScreenShare bool
True when the track is published with source TrackSource.screenShareVideo.
read-onlyinherited
kind TrackType
finalinherited
latestInfo ↔ TrackInfo?
read / writeinherited
mimeType String
The MIME type of the Track (readonly)
read-onlyinherited
muted bool
read-onlyinherited
name String
finalinherited
participant RemoteParticipant
The RemoteParticipant this RemoteTrackPublication belongs to.
final
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
sid String
finalinherited
simulcasted bool
If the Track is published with simulcast, only for video. (readonly)
read-onlyinherited
source TrackSource
finalinherited
streamState StreamState
The server may pause the track when they are bandwidth limitations and resume when there is more capacity. This property will be updated when the track is paused / resumed by the server. See TrackStreamStateUpdatedEvent for the relevant event.
read-only
subscribed bool
read / writeoverride-getter
subscriptionAllowed bool
read-only
subscriptionState TrackSubscriptionState
read-only
track → T?
The current Track for this publication (readonly).
read-onlyinherited
videoQuality VideoQuality
read / write

Methods

disable() Future<void>
dispose() Future<bool>
inherited
enable() Future<void>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onDispose(OnDisposeFunc func) → void
inherited
sendUpdateTrackSettings() → void
setVideoFPS(int newValue) Future<void>
Set desired FPS, server will do its best to return FPS close to this. It's only supported for video codecs that support SVC currently.
setVideoQuality(VideoQuality newValue) Future<void>
subscribe() Future<void>
toString() String
A string representation of this object.
inherited
unsubscribe() Future<void>
updateFromInfo(TrackInfo info) → void
override
updateStreamState(StreamState streamState) Future<void>
updateSubscriptionAllowed(bool allowed) Future<bool>
updateTrack(covariant T? newValue) Future<bool>
override

Operators

operator ==(Object other) bool
The equality operator.
inherited