class MediaStreamTrack
package js.html
extends EventTarget
extended by AudioStreamTrack, VideoStreamTrack
Available on js
The MediaStreamTrack
interface represents a single media track within a stream; typically, these are audio or video tracks, but other track types may exist as well.
Documentation MediaStreamTrack by Mozilla Contributors, licensed under CC-BY-SA 2.5.
See also:
Variables
enabled:Bool
A Boolean whose 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.
Note: You can implement standard "mute" functionality by setting enabled
to false
. The muted
property refers to a condition in which there's no media because of a technical issue.
read onlyid:String
Returns a DOMString
containing a unique identifier (GUID) for the track; it is generated by the browser.
read onlykind: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.
read onlylabel: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.
onended:Function
An EventHandler
containing the action to perform when an ended_(MediaStream)
event is fired on the object, that is when a MediaStreamTrack
object is removed from it.
onmute:Function
An EventHandler
containing the action to perform when an mute
event is fired on the object, that is when the streaming is terminating.
onunmute:Function
An 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.
read onlyreadyState:MediaStreamTrackState
Returns an enumerated value giving the status of the track. This will be 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.
Methods
applyConstraints(?constraints:Null<MediaTrackConstraints>):Promise<Void>
Lets the application specify the ideal and/or ranges of acceptable values for any number of the available constrainable properties of the MediaStreamTrack
.
Throws:
null | DOMError |
---|
getConstraints():MediaTrackConstraints
Returns a MediaTrackConstraints
object containing the currently set constraints for the track; the returned value matches the constraints last set using MediaStreamTrack.applyConstraints
.
getSettings():MediaTrackSettings
Returns a MediaTrackSettings
object containing the current values of each of the MediaStreamTrack
's constrainable properties.