client-export-api

Client-side video exporting generates MP4 or WebM files directly in the browser. It uses the built-in VideoEncoder via WebCodecs to process Helios compositions, eliminating the need for a server-side rendering pipeline.

Browser-based video export allows configurable settings such as format, resolution, and caption options. You can specify width, height, and export-caption-mode directly through the Helios Player API to customize the output.

Client-side video export supports cross-origin asset handling within the browser. This ensures that Helios compositions referencing external resources can be processed by the WebCodecs VideoEncoder without server-side intervention.

The best way to trigger a video download is by calling the export method programmatically on the Helios Player element. You can pass configuration objects including filename, format, and an onProgress callback to monitor the export.

You should avoid client-side video exporting if your application lacks WebCodecs support or requires heavy processing beyond demos, offline previews, and educational content, as it relies entirely on the browser's built-in VideoEncoder.