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?
read / writeinherited
currentBitrate → dynamic
read-only
currentOptions VideoCaptureOptions
Options used for this track
covariantread / writeoverride
disposeFuncCount int
read-onlyinherited
events EventsEmitter<TrackEvent>
finalinherited
hashCode int
The hash code for this object.
read-onlyinherited
hasListeners bool
Whether any listeners are currently registered.
read-onlyinherited
isActive bool
read-onlyinherited
isDisposed bool
read-onlyinherited
isPublished bool
read-onlyinherited
kind TrackType
finalinherited
mediaStream MediaStream
read-onlyinherited
mediaStreamTrack MediaStreamTrack
read-onlyinherited
mediaType RTCRtpMediaType
read-onlyinherited
muted bool
read-onlyinherited
name String
finalinherited
onVideoViewBuild ↔ (dynamic Function(Key)?)
read / writeinherited
prevStats Map<String, VideoSenderStats>?
read / write
receiver RTCRtpReceiver?
read / writeinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
sender RTCRtpSender?
read-onlyinherited
sid String?
read / writeinherited
simulcastCodecs Map<String, SimulcastTrackInfo>
read / write
source TrackSource
finalinherited
subscribedCodecs List<SubscribedCodec>
read / write
transceiver RTCRtpTransceiver?
read / writeinherited
viewKeys List<GlobalKey<State<StatefulWidget>>>
finalinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
addViewKey() GlobalKey<State<StatefulWidget>>
inherited
createListener({bool synchronized = false}) EventsListener<TrackEvent>
inherited
disable() Future<void>
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
enable() Future<void>
inherited
getCid() String
inherited
getSenderStats() Future<List<VideoSenderStats>>
monitorStats() Future<bool>
override
mute() 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
onPublish() Future<bool>
inherited
onUnpublish() Future<bool>
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
removeViewKey(GlobalKey<State<StatefulWidget>> key) → void
inherited
restartTrack([LocalTrackOptions? options]) Future<void>
Restarts the track with new options. This is useful when switching between front and back cameras.
inherited
start() Future<bool>
Start this Track if not started. Returns true if started, false if already started
inherited
startMonitor() → void
inherited
stop() Future<bool>
Stop this Track if not stopped. Returns true if stopped, false if already stopped
inherited
stopMonitor() → void
inherited
toString() String
A string representation of this object.
inherited
unmute() 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
updateMediaStreamAndTrack(MediaStream stream, MediaStreamTrack track) → void
inherited
updateMuted(bool muted, {bool shouldNotify = true, bool shouldSendSignal = false}) → void
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.