MediaStream
charging?: boolean;
chargingTime?: number;
dischargingTime?: number;
level?: number;
dispatchEvent(event: Event): boolean;
active: boolean;
id: string;
onaddtrack: null | ((this: MediaStream, ev: MediaStreamTrackEvent) => any);
onremovetrack:
| null
| ((this: MediaStream, ev: MediaStreamTrackEvent) => any);
addTrack(track: MediaStreamTrack): void;
clone(): MediaStream;
getAudioTracks(): MediaStreamTrack[];
getTrackById(trackId: string): null | MediaStreamTrack;
getTracks(): MediaStreamTrack[];
getVideoTracks(): MediaStreamTrack[];
removeTrack(track: MediaStreamTrack): void;
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;
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;
}
Hierarchy
- EventTarget
- MediaStream
Index
Properties
Methods
Properties
Optionalcharging
Optionalcharging
Optionaldischarging
Optionallevel
Readonlyactive
Readonlyid
onaddtrack
onremovetrack
Methods
dispatch
add
addTrack(track: MediaStreamTrack): voidclone
clone(): MediaStreamReturns MediaStream
get
getAudioTracks(): MediaStreamTrack[]Returns MediaStreamTrack[]
get
getTrackById(trackId: string): null | MediaStreamTrackget
getTracks(): MediaStreamTrack[]Returns MediaStreamTrack[]
get
getVideoTracks(): MediaStreamTrack[]Returns MediaStreamTrack[]
remove
removeTrack(track: MediaStreamTrack): voidadd
addEventListener<K extends keyof MediaStreamEventMap>(
type: K,
listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any,
options?: boolean | AddEventListenerOptions,
): voidAppends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Type Parameters
- K extends keyof MediaStreamEventMap
Parameters
type: Klistener: (this: MediaStream, ev: MediaStreamEventMap[K]) => anyOptionaloptions: boolean | AddEventListenerOptions
Returns void
addEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | AddEventListenerOptions,
): voidAppends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Parameters
type: stringlistener: EventListenerOrEventListenerObjectOptionaloptions: boolean | AddEventListenerOptions
Returns void
remove
removeEventListener<K extends keyof MediaStreamEventMap>(
type: K,
listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any,
options?: boolean | EventListenerOptions,
): voidRemoves the event listener in target's event listener list with the same type, callback, and options.
Type Parameters
- K extends keyof MediaStreamEventMap
Parameters
type: Klistener: (this: MediaStream, ev: MediaStreamEventMap[K]) => anyOptionaloptions: boolean | EventListenerOptions
Returns void
removeEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | EventListenerOptions,
): voidRemoves the event listener in target's event listener list with the same type, callback, and options.
Parameters
type: stringlistener: EventListenerOrEventListenerObjectOptionaloptions: boolean | EventListenerOptions
A stream of media content. A stream consists of several tracks such as video or audio tracks. Each track is specified as an instance of MediaStreamTrack.
MDN Reference