ContextQMD
Back to Content

VideoEncoder: isConfigSupported() static method

files/en-us/web/api/videoencoder/isconfigsupported_static/index.md

latest2.0 KB
Original Source

{{APIRef("WebCodecs API")}}{{SecureContext_Header}}{{AvailableInWorkers("window_and_dedicated")}}

The isConfigSupported() static method of the {{domxref("VideoEncoder")}} interface checks if {{domxref("VideoEncoder")}} can be successfully configured with the given config.

Syntax

js-nolint
VideoEncoder.isConfigSupported(config)

Parameters

  • config
    • : The dictionary object accepted by {{domxref("VideoEncoder.configure")}}

Return value

A {{jsxref("Promise")}} that resolves with an object containing the following members:

  • supported
    • : A boolean value which is true if the given config is supported by the encoder.
  • config
    • : A copy of the given config with all the fields recognized by the encoder.

Exceptions

  • {{jsxref("TypeError")}}
    • : Thrown if the provided config is invalid; that is, if doesn't have required values (such as an empty codec field) or has invalid values (such as a negative width)

Examples

The following example tests if the browser supports accelerated and un-accelerated versions of several video codecs.

js
const codecs = [
  "avc1.420034",
  "hvc1.1.6.L123.00",
  "vp8",
  "vp09.00.10.08",
  "av01.0.04M.08",
];
const accelerations = ["prefer-hardware", "prefer-software"];

const configs = [];
for (const codec of codecs) {
  for (const acceleration of accelerations) {
    configs.push({
      codec,
      hardwareAcceleration: acceleration,
      width: 1280,
      height: 720,
      bitrate: 2_000_000,
      bitrateMode: "constant",
      framerate: 30,
      not_supported_field: 123,
    });
  }
}

for (const config of configs) {
  const support = await VideoEncoder.isConfigSupported(config);
  console.log(
    `VideoEncoder's config ${JSON.stringify(support.config)} support: ${
      support.supported
    }`,
  );
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also