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)
no setterinherited
disposeFuncCount int
no setterinherited
enabled bool
no setter
encryptionType EncryptionType
no setterinherited
fps int
no setter
hashCode int
The hash code for this object.
no setterinherited
isDisposed bool
no setterinherited
isScreenShare bool
True when the track is published with source TrackSource.screenShareVideo.
no setterinherited
kind TrackType
finalinherited
latestInfo ↔ TrackInfo?
getter/setter pairinherited
mimeType String
The MIME type of the Track (readonly)
no setterinherited
muted bool
no setterinherited
name String
finalinherited
participant RemoteParticipant
The RemoteParticipant this RemoteTrackPublication belongs to.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sid String
finalinherited
simulcasted bool
If the Track is published with simulcast, only for video. (readonly)
no setterinherited
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.
no setter
subscribed bool
no setteroverride
subscriptionAllowed bool
no setter
subscriptionState TrackSubscriptionState
no setter
track → T?
The current Track for this publication (readonly).
no setterinherited
videoQuality VideoQuality
no setter

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