RTCTrackEvent: RTCTrackEvent() constructor
BaselineWidely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
TheRTCTrackEvent()
constructor creates and returns a newRTCTrackEvent
object,configured to describe the track which has been added to theRTCPeerConnection
.
In general, you won't need to use this constructor, asRTCTrackEvent
objects are created by WebRTC and delivered to yourRTCPeerConnection
'sontrack
event handler as appropriate.
Syntax
new RTCTrackEvent(type, options)
Parameters
type
A string with the name of the event.It is case-sensitive and browsers always set it to
track
.options
An object that,in addition of the properties defined in
Event()
, can have the following properties:receiver
The
RTCRtpReceiver
which is being used to receive the track's media.streams
OptionalAn array of
MediaStream
objects representing each of the streams that comprise the event's corresponding track.It defaults to an empty array.track
The
MediaStreamTrack
the event is associated with.transceiver
The
RTCRtpTransceiver
associated with the event.
Return value
A newRTCTrackEvent
describing a track which has been added to theRTCPeerConnection
.
Specifications
Specification |
---|
WebRTC: Real-Time Communication in Browsers # dom-rtctrackevent-constructor |