kotlin-browser/web.mediastreams/CanvasCaptureMediaStreamTrack

CanvasCaptureMediaStreamTrack

class CanvasCaptureMediaStreamTrack : MediaStreamTrack(source)

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().

MDN Reference

Properties

canvas

val canvas: HTMLCanvasElement

The canvas read-only property of the CanvasCaptureMediaStreamTrack interface returns the HTMLCanvasElement from which frames are being captured.

contentHint

var contentHint: String

The contentHint property of the MediaStreamTrack interface is a string that hints at the type of content the track contains.

enabled

var enabled: Boolean

The enabled property of the true if the track is allowed to render the source stream or false if it is not.

val 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 user agent.

kind

val 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.

label

val label: String

The label read-only property of the MediaStreamTrack interface returns a string containing a user agent-assigned label that identifies the track source, as in 'internal microphone'.

muted

val muted: Boolean

The muted read-only property of the indicating whether or not the track is currently unable to provide media output.

onended

var onended: EventHandler<Event, MediaStreamTrack, MediaStreamTrack>?

MDN Reference

onmute

var onmute: EventHandler<Event, MediaStreamTrack, MediaStreamTrack>?

MDN Reference

onunmute

var onunmute: EventHandler<Event, MediaStreamTrack, MediaStreamTrack>?

MDN Reference

readyState

val readyState: MediaStreamTrackState

The readyState read-only property of the MediaStreamTrack interface returns an enumerated value giving the status of the track.

Functions

applyConstraints

suspend fun applyConstraints(constraints: MediaTrackConstraints = definedExternally)

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.

applyConstraintsAsync

fun applyConstraintsAsync(constraints: MediaTrackConstraints = definedExternally): Promise<Void>

clone

fun clone(): MediaStreamTrack

The clone() method of the MediaStreamTrack interface creates a duplicate of the MediaStreamTrack.

dispatchEvent

fun dispatchEvent(event: Event): Boolean

getCapabilities

fun getCapabilities(): MediaTrackCapabilities

The getCapabilities() method of the MediaStreamTrack interface returns an object detailing the accepted values or value range for each constrainable property of the associated MediaStreamTrack, based upon the platform and user agent.

getConstraints

fun getConstraints(): MediaTrackConstraints

The getConstraints() method of the MediaStreamTrack interface returns a recently established for the track using a prior call to constraints indicate values and ranges of values that the website or application has specified are required or acceptable for the included constrainable properties.

getSettings

fun getSettings(): MediaTrackSettings

The getSettings() method of the object containing the current values of each of the constrainable properties for the current MediaStreamTrack.

requestFrame

fun requestFrame()

The requestFrame() method of the CanvasCaptureMediaStreamTrack interface requests that a frame be captured from the canvas and sent to the stream.

stop

fun stop()

The stop() method of the MediaStreamTrack interface stops the track.

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>