WebCodecs APIwindow_and_dedicated
The configure() method of the VideoEncoder interface changes the VideoEncoder.state of the encoder to "configured" and asynchronously prepares the encoder to accept VideoEncoders for encoding with the specified parameters. If the encoder doesn't support the specified parameters or can't be initialized for other reasons an error will be reported via the error callback provided to the VideoEncoder constructor.
If the VideoEncoder has been previously configured, the new configuration will not be applied until all previous tasks have completed.
Syntax
configure(config)
Parameters
config- : A dictionary object containing the following members:
codec- : A string containing a valid codec string. See "codecs" parameter for details on codec string construction.
width- : An integer representing the width of each output EncodedVideoChunk in pixels, before any ratio adjustments.
height- : An integer representing the height of each output EncodedVideoChunk in pixels, before any ratio adjustments.
displayWidth- : An integer representing the intended display width of each output EncodedVideoChunk in pixels when displayed.
displayHeight- : An integer representing the vertical dimension of each output EncodedVideoChunk in pixels when displayed.
hardwareAcceleration- : A hint that configures the hardware acceleration method of this codec. One of:
"no-preference""prefer-hardware""prefer-software"
- : A hint that configures the hardware acceleration method of this codec. One of:
bitrate- : An integer containing the average bitrate of the encoded video in units of bits per second.
framerate- : An integer containing the expected frame rate in frames per second.
alpha- : A string indicating whether the alpha component of the
VideoFrameinputs should be kept or discarded prior to encoding. One of:"discard"(default)"keep"
- : A string indicating whether the alpha component of the
scalabilityMode- : A string containing an encoding scalability mode identifier as defined in WebRTC.
bitrateMode- : A string containing a bitrate mode. One of:
"constant"- : The encoder will target constant bitrate.
"variable"(default)- : The encoder will target a variable bitrate, allowing more space to be used for complex signals and less space for less complex signals.
"quantizer"- : The encoder will disregard the
bitrateoption and instead it will use codec-specific quantizer values specified for each frame in theoptionsparameter to VideoEncoder.encode().
- : The encoder will disregard the
- : A string containing a bitrate mode. One of:
latencyMode- : A string containing a value that configures the latency behavior of this codec. One of:
"quality"(default)- : The encoder should optimize for encoding quality.
"realtime"- : The encoder should optimize for low latency and may even drop frames to honor
framerate.
- : The encoder should optimize for low latency and may even drop frames to honor
- : A string containing a value that configures the latency behavior of this codec. One of:
- : A dictionary object containing the following members:
Return value
None (undefined).
Exceptions
- TypeError
- : Thrown if the provided
configis invalid.
- : Thrown if the provided
InvalidStateErrorDOMException- : Thrown if the VideoEncoder.state is
"closed".
- : Thrown if the VideoEncoder.state is
NotSupportedErrorDOMException- : Thrown if the provided
configis valid but the user agent cannot provide a codec that can decode this profile.
- : Thrown if the provided
Examples
The following example creates a new VideoEncoder and configures it with some of the available options.
const init = {
output: handleChunk,
error(e) {
console.log(e.message);
},
};
let config = {
codec: "vp8",
width: 640,
height: 480,
bitrate: 2_000_000, // 2 Mbps
framerate: 30,
};
let encoder = new VideoEncoder(init);
encoder.configure(config);
Specifications
Browser compatibility
See also
- VideoEncoder.isConfigSupported()
- Codec String Support Table
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
