VideoEncoder extension type

@AvailableInWorkers("window_and_dedicated")

The VideoEncoder interface of the WebCodecs API encodes VideoFrame objects into EncodedVideoChunks.

API documentation sourced from MDN Web Docs.

on
Implemented types
Available extensions

Constructors

VideoEncoder(VideoEncoderInit init)
factory

Properties

encodeQueueSize → int
@AvailableInWorkers("window_and_dedicated")
no setter
hashCode → int
The hash code for this object.
no setterinherited
ondequeue ↔ EventHandler?
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → CodecState
@AvailableInWorkers("window_and_dedicated")
no setter

Methods

addEventListener(String type, EventListener? callback, [JSAny options]) → void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
inherited
close() → void
@AvailableInWorkers("window_and_dedicated")
configure(VideoEncoderConfig config) → void
@AvailableInWorkers("window_and_dedicated")
dispatchEvent(Event event) → bool
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
inherited
encode(VideoFrame frame, [VideoEncoderEncodeOptions options]) → void
@AvailableInWorkers("window_and_dedicated")
flush() → JSPromise<JSAny?>
@AvailableInWorkers("window_and_dedicated")
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeEventListener(String type, EventListener? callback, [JSAny options]) → void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
inherited
reset() → void
@AvailableInWorkers("window_and_dedicated")
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

isConfigSupported(VideoEncoderConfig config) → JSPromise<VideoEncoderSupport>
@AvailableInWorkers("window_and_dedicated")