Interface MediaStream
active: boolean;
id: string;
onaddtrack: ((this: MediaStream, ev: MediaStreamTrackEvent) => any) | null;
onremovetrack:
| ((this: MediaStream, ev: MediaStreamTrackEvent) => any)
| null;
addEventListener<K extends keyof MediaStreamEventMap>(
type: K,
listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any,
options?: boolean | AddEventListenerOptions,
): void;
addEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | AddEventListenerOptions,
): void;
addTrack(track: MediaStreamTrack): void;
clone(): MediaStream;
dispatchEvent(event: Event): boolean;
getAudioTracks(): MediaStreamTrack[];
getTrackById(trackId: string): MediaStreamTrack | null;
getTracks(): MediaStreamTrack[];
getVideoTracks(): MediaStreamTrack[];
removeEventListener<K extends keyof MediaStreamEventMap>(
type: K,
listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any,
options?: boolean | EventListenerOptions,
): void;
removeEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | EventListenerOptions,
): void;
removeTrack(track: MediaStreamTrack): void;
}
Hierarchy
- EventTarget
- MediaStream
Properties
Readonlyactive
The active read-only property of the true if the stream is currently active; otherwise, it returns false.
Readonlyid
The id read-only property of the MediaStream interface is a string containing 36 characters denoting a unique identifier (GUID) for the object.
onaddtrack
onremovetrack
Methods
addEventListener
- addEventListener<K extends keyof MediaStreamEventMap>(
type: K,
listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any,
options?: boolean | AddEventListenerOptions,
): voidThe
addEventListener()method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.Type Parameters
- K extends keyof MediaStreamEventMap
Parameters
- type: K
- listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any
Optionaloptions: boolean | AddEventListenerOptions
Returns void
- addEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | AddEventListenerOptions,
): voidThe
addEventListener()method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | AddEventListenerOptions
Returns void
addTrack
The
addTrack()method of the MediaStream interface adds a new track to the stream.Parameters
- track: MediaStreamTrack
Returns void
clone
The
clone()method of the MediaStream interface creates a duplicate of theMediaStream.Returns MediaStream
dispatchEvent
The
dispatchEvent()method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.Parameters
- event: Event
Returns boolean
getAudioTracks
The
getAudioTracks()method of the stream's track set where MediaStreamTrack.kind isaudio.Returns MediaStreamTrack[]
getTrackById
The
getTrackById()method of the MediaStream interface returns a MediaStreamTrack object representing the track with the specified ID string.Parameters
- trackId: string
Returns MediaStreamTrack | null
getTracks
The
getTracks()method of the stream's track set, regardless of MediaStreamTrack.kind.Returns MediaStreamTrack[]
getVideoTracks
The
getVideoTracks()method of thejs-nolint getVideoTracks()None.Returns MediaStreamTrack[]
removeEventListener
- removeEventListener<K extends keyof MediaStreamEventMap>(
type: K,
listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any,
options?: boolean | EventListenerOptions,
): voidThe
removeEventListener()method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.Type Parameters
- K extends keyof MediaStreamEventMap
Parameters
- type: K
- listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any
Optionaloptions: boolean | EventListenerOptions
Returns void
- removeEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | EventListenerOptions,
): voidThe
removeEventListener()method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | EventListenerOptions
Returns void
removeTrack
The
removeTrack()method of the MediaStream interface removes ajs-nolint removeTrack(track)-track- : A MediaStreamTrack that will be removed from the stream.Parameters
- track: MediaStreamTrack
Returns void
The
MediaStreaminterface of the Media Capture and Streams API represents a stream of media content.MDN Reference