kotlin-browser/web.mediastreams/MediaStream

MediaStream

open class MediaStream : EventTarget(source)

The MediaStream interface of the Media Capture and Streams API represents a stream of media content.

MDN Reference

Constructors

MediaStream

constructor()

constructor(stream: MediaStream)

constructor(tracks: ReadonlyArray<MediaStreamTrack>)

Properties

active

val active: Boolean

The active read-only property of the MediaStream interface returns a Boolean value which is true if the stream is currently active; otherwise, it returns false.

val id: String

The id read-only property of the MediaStream interface is a string containing 36 characters denoting a unique identifier (GUID) for the object.

onaddtrack

var onaddtrack: EventHandler<MediaStreamTrackEvent, MediaStream, MediaStream>?

MDN Reference

onremovetrack

var onremovetrack: EventHandler<MediaStreamTrackEvent, MediaStream, MediaStream>?

MDN Reference

Functions

addTrack

fun addTrack(track: MediaStreamTrack)

The addTrack() method of the MediaStream interface adds a new track to the stream.

clone

fun clone(): MediaStream

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

dispatchEvent

open fun dispatchEvent(event: Event): Boolean

getAudioTracks

fun getAudioTracks(): ReadonlyArray<MediaStreamTrack>

The getAudioTracks() method of the MediaStream interface returns a sequence that represents all the MediaStreamTrack objects in this stream's track set where MediaStreamTrack.kind is audio.

getTrackById

fun getTrackById(trackId: String): MediaStreamTrack?

The getTrackById() method of the MediaStream interface returns a MediaStreamTrack object representing the track with the specified ID string.

getTracks

fun getTracks(): ReadonlyArray<MediaStreamTrack>

The getTracks() method of the MediaStream interface returns a sequence that represents all the MediaStreamTrack objects in this stream's track set, regardless of MediaStreamTrack.kind.

getVideoTracks

fun getVideoTracks(): ReadonlyArray<MediaStreamTrack>

The getVideoTracks() method of the MediaStream interface returns a sequence of MediaStreamTrack objects representing the video tracks in this stream.

removeTrack

fun removeTrack(track: MediaStreamTrack)

The removeTrack() method of the MediaStream interface removes a MediaStreamTrack from a stream.

when

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