Back to Remotion

getEncodableVideoCodecs()

packages/docs/docs/web-renderer/get-encodable-video-codecs.mdx

4.0.4571.6 KB
Original Source

:::warning Experimental feature - expect bugs and breaking changes at any time.
Track progress on GitHub and discuss in the #web-renderer channel on Discord. :::

Part of the @remotion/web-renderer package.

Returns the video codecs that the current browser can encode for a given container format.

Use this function to dynamically show users which video codecs are available in their browser.

tsx
import {getEncodableVideoCodecs} from '@remotion/web-renderer';

const codecs = await getEncodableVideoCodecs('mp4');
console.log(codecs); // e.g. ['h264', 'h265', 'av1']

Arguments

container

string <TsType type="WebRendererContainer" source="@remotion/web-renderer" /> - required

The container format: "mp4" or "webm".

options?

object <TsType type="GetEncodableVideoCodecsOptions" source="@remotion/web-renderer" />

Optional configuration object.

videoBitrate?

number | string <TsType type="WebRendererQuality" source="@remotion/web-renderer" />

A number (bits per second) or quality preset ("very-low", "low", "medium", "high", "very-high").

Return value

Returns a Promise<WebRendererVideoCodec[]> - an array of video codec identifiers that the browser can encode.

Possible values: "h264", "h265", "vp8", "vp9", "av1"

See also