LocalVideoTrack class

A video track from the local device. Use static methods in this class to create video tracks.

Inheritance
Mixed-in types
Available extensions

Properties

codec ↔ String?
getter/setter pairinherited
currentBitrate → num?
no setter
currentOptions ↔ VideoCaptureOptions
Options used for this track
covariantgetter/setter pairoverride
disposeFuncCount → int
no setterinherited
encodingBackups ↔ Map<(String, int), RTCRtpEncoding>
getter/setter pair
events → EventsEmitter<TrackEvent>
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
isActive → bool
no setterinherited
isDisposed → bool
no setterinherited
isPublished → bool
no setterinherited
kind → TrackType
finalinherited
lastPublishOptions ↔ VideoPublishOptions?
getter/setter pair
mediaStream → MediaStream
no setterinherited
mediaStreamTrack → MediaStreamTrack
no setterinherited
mediaType → RTCRtpMediaType
no setterinherited
muted → bool
no setterinherited
prevStats ↔ Map<String, VideoSenderStats>?
getter/setter pair
processor → TrackProcessor<ProcessorOptions<TrackType>>?
no setterinherited
receiver ↔ RTCRtpReceiver?
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sender → RTCRtpSender?
no setterinherited
sid ↔ String?
getter/setter pairinherited
simulcastCodecs ↔ Map<String, SimulcastTrackInfo>
getter/setter pair
source → TrackSource
finalinherited
subscribedCodecs ↔ List<SubscribedCodec>
getter/setter pair
transceiver ↔ RTCRtpTransceiver?
getter/setter pairinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
addSimulcastTrack(String codec, List<RTCRtpEncoding> encodings) → SimulcastTrackInfo

Available on LocalVideoTrack, provided by the LocalVideoTrackExt extension

createListener({bool synchronized = false}) → EventsListener<TrackEvent>
inherited
disable() → Future<void>
inherited
dispose() → Future<bool>
Discards any resources used by the object.
inherited
enable() → Future<void>
inherited
getCid() → String
inherited
getSenderStats() → Future<List<VideoSenderStats>>
monitorStats() → Future<bool>
mute({bool stopOnMute = true}) → Future<bool>
Mutes this LocalTrack. This will stop the sending of track data and notify the RemoteParticipant with TrackMutedEvent. Returns true if muted, false if unchanged.
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
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
replaceTrackForMultiCodecSimulcast(MediaStreamTrack newTrack) → Future<void>

Available on LocalVideoTrack, provided by the LocalVideoTrackExt extension

restartTrack([LocalTrackOptions? options]) → Future<void>
Restarts the track with new options. This is useful when switching between front and back cameras.
inherited
setCameraPosition(CameraPosition position) → Future<void>

Available on LocalVideoTrack, provided by the LocalVideoTrackExt extension

setDegradationPreference(DegradationPreference preference) → Future<void>

Available on LocalVideoTrack, provided by the LocalVideoTrackExt extension

setProcessor(TrackProcessor<ProcessorOptions<TrackType>>? processor) → Future<void>
inherited
setPublishingCodecs(List<SubscribedCodec> codecs, LocalTrack track) → Future<List<String>>

Available on LocalVideoTrack, provided by the LocalVideoTrackExt extension

setPublishingLayersForSender(RTCRtpSender sender, List<RTCRtpEncoding> encodings, List<SubscribedQuality> layers, {bool isSVC = false}) → Future<void>

Available on LocalVideoTrack, provided by the LocalVideoTrackExt extension

start() → Future<bool>
Start this Track if not started. Returns true if started, false if already started
inherited
stop() → Future<bool>
Stop this Track if not stopped. Returns true if stopped, false if already stopped
inherited
switchCamera(String deviceId, {bool fastSwitch = false}) → Future<void>

Available on LocalVideoTrack, provided by the LocalVideoTrackExt extension

toString() → String
A string representation of this object.
inherited
unmute({bool stopOnMute = true}) → Future<bool>
Un-mutes this LocalTrack. This will re-start the sending of track data and notify the RemoteParticipant with TrackUnmutedEvent. Returns true if un-muted, false if unchanged.
inherited

Operators

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

Static Methods

createCameraTrack([CameraCaptureOptions? options]) → Future<LocalVideoTrack>
Creates a LocalVideoTrack from camera input.
createScreenShareTrack([ScreenShareCaptureOptions? options]) → Future<LocalVideoTrack>
Creates a LocalVideoTrack from the display.
createScreenShareTracksWithAudio([ScreenShareCaptureOptions? options]) → Future<List<LocalTrack>>
Creates a LocalTracks(audio/video) from the display.