MediaStreamTrack

@native @JSType
Companion:
object
class Object
trait Any
class Object
trait Matchable
class Any

Value members

Concrete methods

def applyConstraints(constraints: MediaTrackConstraints): Promise[Unit]

Lets the application specify the ideal and/or ranges of acceptable values for any number of the available constrainable properties of the MediaStreamTrack.

Lets the application specify the ideal and/or ranges of acceptable values for any number of the available constrainable properties of the MediaStreamTrack.

override def clone(): MediaStreamTrack

Returns a duplicate of the MediaStreamTrack.

Returns a duplicate of the MediaStreamTrack.

Definition Classes
Object
def getCapabilities(): Any

Returns the a list of constrainable properties available for the MediaStreamTrack.

Returns the a list of constrainable properties available for the MediaStreamTrack.

Returns a MediaTrackConstraints object containing the currently set constraints for the track; the returned value matches the constraints last set using applyConstraints().

Returns a MediaTrackConstraints object containing the currently set constraints for the track; the returned value matches the constraints last set using applyConstraints().

def getSettings(): Any

Returns a MediaTrackSettings object containing the current values of each of the MediaStreamTrack's constrainable properties.

Returns a MediaTrackSettings object containing the current values of each of the MediaStreamTrack's constrainable properties.

def stop(): Unit

Stops playing the source associated to the track, both the source and the track are deassociated. The track state is set to ended.

Stops playing the source associated to the track, both the source and the track are deassociated. The track state is set to ended.

Inherited methods

def addEventListener[T <: Event](`type`: String, listener: Function1[T, _], options: EventListenerOptions): Unit

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

This implementation accepts a settings object of type EventListenerOptions.

Inherited from:
EventTarget
def addEventListener[T <: Event](`type`: String, listener: Function1[T, _], useCapture: Boolean): Unit

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

Inherited from:
EventTarget
def dispatchEvent(evt: Event): Boolean

Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().

Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().

Inherited from:
EventTarget
def hasOwnProperty(v: String): Boolean
Inherited from:
Object
def isPrototypeOf(v: Object): Boolean
Inherited from:
Object
def propertyIsEnumerable(v: String): Boolean
Inherited from:
Object
def removeEventListener[T <: Event](`type`: String, listener: Function1[T, _], options: EventListenerOptions): Unit

Removes the event listener previously registered with EventTarget.addEventListener.

Removes the event listener previously registered with EventTarget.addEventListener.

This implementation accepts a settings object of type EventListenerOptions.

Inherited from:
EventTarget
def removeEventListener[T <: Event](`type`: String, listener: Function1[T, _], useCapture: Boolean): Unit

Removes the event listener previously registered with EventTarget.addEventListener.

Removes the event listener previously registered with EventTarget.addEventListener.

Inherited from:
EventTarget
def toLocaleString(): String
Inherited from:
Object
def valueOf(): Any
Inherited from:
Object

Concrete fields

var enabled: Boolean

Is a Boolean value with a value of true if the track is enabled, that is allowed to render the media source stream; or false if it is disabled, that is not rendering the media source stream but silence and blackness. If the track has been disconnected, this value can be changed but has no more effect.

Is a Boolean value with a value of true if the track is enabled, that is allowed to render the media source stream; or false if it is disabled, that is not rendering the media source stream but silence and blackness. If the track has been disconnected, this value can be changed but has no more effect.

val id: String

Returns a DOMString containing a unique identifier (GUID) for the track; it is generated by the browser.

Returns a DOMString containing a unique identifier (GUID) for the track; it is generated by the browser.

val kind: String

Returns a DOMString 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 deassociated from its source.

Returns a DOMString 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 deassociated from its source.

val label: String

Returns a DOMString containing a user agent-assigned label that identifies the track source, as in "internal microphone". The string may be left empty and is empty as long as no source has been connected. When the track is deassociated from its source, the label is not changed.

Returns a DOMString containing a user agent-assigned label that identifies the track source, as in "internal microphone". The string may be left empty and is empty as long as no source has been connected. When the track is deassociated from its source, the label is not changed.

val muted: Boolean

Returns a Boolean value with a value of true if the track is muted, false otherwise.

Returns a Boolean value with a value of true if the track is muted, false otherwise.

var onended: Function1[Event, Any]

Is a EventHandler containing the action to perform when an ended event is fired on the object, that is when a MediaStreamTrack object is removed from it.

Is a EventHandler containing the action to perform when an ended event is fired on the object, that is when a MediaStreamTrack object is removed from it.

var onmute: Function1[Event, Any]

Is a EventHandler containing the action to perform when an mute event is fired on the object, that is when the streaming is terminating.

Is a EventHandler containing the action to perform when an mute event is fired on the object, that is when the streaming is terminating.

var onoverconstrained: Function1[Event, Any]

Is a EventHandler containing the action to perform when an overconstrained event is fired on the object, that is when a MediaStreamTrack object is removed from it.

Is a EventHandler containing the action to perform when an overconstrained event is fired on the object, that is when a MediaStreamTrack object is removed from it.

var onstarted: Function1[Event, Any]

Is a EventHandler containing the action to perform when an started event is fired on the object, that is when a new MediaStreamTrack object is added.

Is a EventHandler containing the action to perform when an started event is fired on the object, that is when a new MediaStreamTrack object is added.

var onunmute: Function1[Event, Any]

Is a EventHandler containing the action to perform when an unmute event is fired on the object, that is when a MediaStreamTrack object is removed from it.

Is a EventHandler containing the action to perform when an unmute event is fired on the object, that is when a MediaStreamTrack object is removed from it.

val readonly: Boolean

Returns a Boolean value with a value of true if the track is (such a video file source or a camera that settings can't be modified),false otherwise.

Returns a Boolean value with a value of true if the track is (such a video file source or a camera that settings can't be modified),false otherwise.

Returns an enumerated value giving the status of the track.It takes one of the following values:

Returns an enumerated value giving the status of the track.It takes one of the following values:

"live" which indicates that an input is connected and does its best-effort in providing real-time data. In that case, the output of data can be switched on or off using the MediaStreamTrack.enabled attribute.

"ended" which indicates that the input is not giving any more data and will never provide new data.

val remote: Boolean

Returns a boolean value with a value of true if the track is sourced by a RTCPeerConnection, false otherwise.

Returns a boolean value with a value of true if the track is sourced by a RTCPeerConnection, false otherwise.