CanvasCaptureMediaStreamTrack extension type
The CanvasCaptureMediaStreamTrack
interface of the
Media Capture and Streams API
represents the video track contained in a
MediaStream being generated from a canvas
following a call to
HTMLCanvasElement.captureStream.
API documentation sourced from MDN Web Docs.
- on
- Implemented types
- Available extensions
Properties
- canvas → HTMLCanvasElement
-
The
canvas
read-only property of the CanvasCaptureMediaStreamTrack interface returns the HTMLCanvasElement from which frames are being captured.no setter - contentHint ↔ String
-
The
contentHint
property of the MediaStreamTrack interface is a string that hints at the type of content the track contains. Allowable values depend on the value of the MediaStreamTrack.kind property.getter/setter pairinherited - enabled ↔ bool
-
The
enabled
property of the MediaStreamTrack interface is a Boolean value which istrue
if the track is allowed to render the source stream orfalse
if it is not. This can be used to intentionally mute a track.getter/setter pairinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
The
id
read-only property of the MediaStreamTrack interface returns a string containing a unique identifier (GUID) for the track, which is generated by the .no setterinherited - kind → String
-
The
kind
read-only property of the MediaStreamTrack interface returns a string set to"audio"
if the track is an audio track and to"video"
if it is a video track. It doesn't change if the track is disassociated from its source.no setterinherited - label → String
-
The
label
read-only property of the MediaStreamTrack interface returns a string containing a -assigned label that identifies the track source, as in"internal microphone"
.no setterinherited - muted → bool
-
The
muted
read-only property of the MediaStreamTrack interface returns a boolean value indicating whether or not the track is currently unable to provide media output.no setterinherited - onended ↔ EventHandler?
-
getter/setter pairinherited
- onmute ↔ EventHandler?
-
getter/setter pairinherited
- onunmute ↔ EventHandler?
-
getter/setter pairinherited
- readyState → MediaStreamTrackState
-
The
readyState
read-only property of the MediaStreamTrack interface returns an enumerated value giving the status of the track.no setterinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addEventListener(
String type, EventListener? callback, [JSAny options]) → void -
The
addEventListener()
method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.inherited -
applyConstraints(
[MediaTrackConstraints constraints]) → JSPromise< JSAny?> -
The
applyConstraints()
method of the MediaStreamTrack interface applies a set of constraints to the track; these constraints let the website or app establish ideal values and acceptable ranges of values for the constrainable properties of the track, such as frame rate, dimensions, echo cancellation, and so forth.inherited -
clone(
) → MediaStreamTrack -
The
clone()
method of the MediaStreamTrack interface creates a duplicate of theMediaStreamTrack
. This newMediaStreamTrack
object is identical except for its unique MediaStreamTrack.id.inherited -
dispatchEvent(
Event event) → bool -
The
dispatchEvent()
method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually withdispatchEvent()
.inherited -
getCapabilities(
) → MediaTrackCapabilities -
The
getCapabilities()
method of the MediaStreamTrack interface returns aMediaTrackCapabilities
object which specifies the values or range of values which each constrainable property, based upon the platform and .inherited -
getConstraints(
) → MediaTrackConstraints -
The
getConstraints()
method of the MediaStreamTrack interface returns a MediaTrackConstraints object containing the set of constraints most recently established for the track using a prior call to MediaStreamTrack.applyConstraints. These constraints indicate values and ranges of values that the website or application has specified are required or acceptable for the included constrainable properties.inherited -
getSettings(
) → MediaTrackSettings -
The
getSettings()
method of the MediaStreamTrack interface returns a MediaTrackSettings object containing the current values of each of the constrainable properties for the currentMediaStreamTrack
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeEventListener(
String type, EventListener? callback, [JSAny options]) → void -
The
removeEventListener()
method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.inherited -
requestFrame(
) → void -
The
requestFrame()
method of the CanvasCaptureMediaStreamTrack interface requests that a frame be captured from the canvas and sent to the stream. -
stop(
) → void -
The
stop()
method of the MediaStreamTrack interface stops the track.inherited -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited