Returns node's node document's document base URL.
Whether to capture a PNG HTMLImageElement instead of ImageData
(the default).
How often to capture the stream in ms, where 0 represents never.
Note that you can cause performance issues if captureRate is higher than
the speed at which the captured pixels can be processed.
The sample scale, intended to go between 0 and 1 (though clamped only
to 0 in case you wish to sample at a larger scale).
Returns the children.
Returns the child elements.
Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.
Returns the value of element's class content attribute. Can be set to change it.
Returns the first child.
Returns the first child that is an element, and null otherwise.
Whether to flip the stream's image.
Returns the value of element's id content attribute. Can be set to change it.
Returns true if node is connected and false otherwise.
Returns the last child.
Returns the last child that is an element, and null otherwise.
Returns the local name.
Returns the namespace.
Returns the first following sibling that is an element, and null otherwise.
Returns the next sibling.
Returns a string appropriate for the type of node, as follows: Element Its HTML-uppercased qualified name. Attr Its qualified name. Text "#text". CDATASection "#cdata-section". ProcessingInstruction Its target. Comment "#comment". Document "#document". DocumentType Its name. DocumentFragment "#document-fragment".
Fires when the user aborts the download.
Fires when the object loses the input focus.
Occurs when playback is possible, but would require further buffering.
Fires when the contents of the object or selection have changed.
Fires when the user clicks the left mouse button on the object
Fires when the user clicks the right mouse button in the client area, opening the context menu.
Fires when the user double-clicks the object.
Fires on the source object continuously during a drag operation.
Fires on the source object when the user releases the mouse at the close of a drag operation.
Fires on the target element when the user drags the object to a valid drop target.
Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
Fires on the target element continuously while the user drags the object over a valid drop target.
Fires on the source object when the user starts to drag a text selection or selected object.
Occurs when the duration attribute is updated.
Occurs when the media element is reset to its initial state.
Occurs when the end of playback is reached.
Fires when an error occurs during object loading.
Fires when the object receives focus.
Fires when the user presses a key.
Fires when the user presses an alphanumeric key.
Fires when the user releases a key.
Fires immediately after the browser loads the object.
Occurs when media data is loaded at the current playback position.
Occurs when the duration and dimensions of the media have been determined.
Occurs when Internet Explorer begins looking for media data.
Fires when the user clicks the object with either mouse button.
Fires when the user moves the mouse over the object.
Fires when the user moves the mouse pointer outside the boundaries of the object.
Fires when the user moves the mouse pointer into the object.
Fires when the user releases a mouse button while the mouse is over the object.
Occurs when playback is paused.
Occurs when the play method is requested.
Occurs when the audio or video has started playing.
Occurs to indicate progress while downloading media data.
Occurs when the playback rate is increased or decreased.
Fires when the user resets a form.
Fires when the user repositions the scroll box in the scroll bar on the object.
Occurs when the seek operation ends.
Occurs when the current playback position is moved.
Fires when the current selection changes.
Occurs when the download has stopped.
Occurs if the load operation has been intentionally halted.
Occurs to indicate the current playback position.
Occurs when the volume is changed, or playback is muted or unmuted.
Occurs when playback stops because the next frame of a video resource is not available.
Returns the node document. Returns null for documents.
Returns the parent element.
Returns the parent.
Whether to pause the frame.
Returns the namespace prefix.
Returns the first preceding sibling that is an element, and null otherwise.
Returns the previous sibling.
Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.
Returns the value of element's slot content attribute. Can be set to change it.
Returns the HTML-uppercased qualified name.
The StreamCapture's default tag name for registering with
customElements.define.
Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Creates a shadow root for element and returns it.
Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Manually captures a frame. Intended to be used when captureRate is 0.
Returns a copy of node. If deep is true, the copy also includes the node's descendants.
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.
Returns true if other is an inclusive descendant of node, and false otherwise.
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.
Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.
Returns the qualified names of all element's attributes. Can contain duplicates.
Returns node's shadow-including root.
Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.
Returns true if element has an attribute whose namespace is namespace and local name is localName.
Returns true if element has attributes, and false otherwise.
Returns whether node has children.
Returns whether node and otherNode have the same properties.
Returns true if matching selectors against element's root yields element, and false otherwise.
Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Returns the first element that is a descendant of node that matches selectors.
Returns all element descendants of node that match selectors.
Removes node.
Removes element's first attribute whose qualified name is qualifiedName.
Removes element's attribute whose namespace is namespace and local name is localName.
Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Displays element fullscreen and resolves promise when done.
Sets the value of element's first attribute whose qualified name is qualifiedName to value.
Sets the value of element's attribute whose namespace is namespace and local name is localName to value.
Starts the capture of the stream.
Stops the stream.
If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName. Returns true if qualifiedName is now present, and false otherwise.
Generated using TypeDoc
Provides an element that abstracts the capture of stream frames. For example, given a
getUserMediavideo stream, this will -- if desired -- capture an image from the stream, downsample it, and emit an event with the pixel data.Note that, due to the internal reliance on
requestAnimationFrame, the capture element must be attached to the DOM, and the tab visible.const capture = new StreamCapture(); // Capture every 600ms at 50% scale. capture.captureRate = 600; capture.captureScale = 0.5; // Attempt to get the camera's stream and start monitoring. const stream = await navigator.mediaDevices.getUserMedia({ video: true}); capture.start(stream); // Append and listen to captures. document.body.appendChild(capture); capture.addEventListener(StreamCapture.frameEvent, (e) => { const { imgData } = e.detail; // Process the ImageData. });