LocalVideoTrack class

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

Inheritance

• Object
• ChangeNotifier
• Track
• LocalTrack
• LocalVideoTrack

Mixed in types

• VideoTrack

Available Extensions

• LocalVideoTrackExt

Properties

codec ↔ String?

getter/setter pair, inherited

currentBitrate → dynamic

no setter

currentOptions ↔ VideoCaptureOptions

Options used for this track

covariant, getter/setter pair, override

disposeFuncCount → int

no setter, inherited

events → EventsEmitter<TrackEvent>

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hasListeners → bool

Whether any listeners are currently registered.

no setter, inherited

isActive → bool

no setter, inherited

isDisposed → bool

no setter, inherited

isPublished → bool

no setter, inherited

kind → TrackType

final, inherited

lastPublishOptions ↔ VideoPublishOptions?

getter/setter pair

mediaStream → MediaStream

no setter, inherited

mediaStreamTrack → MediaStreamTrack

no setter, inherited

mediaType → RTCRtpMediaType

no setter, inherited

muted → bool

no setter, inherited

onVideoViewBuild ↔ (dynamic Function(Key)?)

getter/setter pair, inherited

prevStats ↔ Map<String, VideoSenderStats>?

getter/setter pair

receiver ↔ RTCRtpReceiver?

getter/setter pair, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sender → RTCRtpSender?

no setter, inherited

sid ↔ String?

getter/setter pair, inherited

simulcastCodecs ↔ Map<String, SimulcastTrackInfo>

getter/setter pair

source → TrackSource

final, inherited

subscribedCodecs ↔ List<SubscribedCodec>

getter/setter pair

transceiver ↔ RTCRtpTransceiver?

getter/setter pair, inherited

viewKeys → List<GlobalKey<State<StatefulWidget>>>

final, inherited

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.