@twick/browser-render / Exports / BrowserRenderConfig

Interface: BrowserRenderConfig

Browser rendering configuration

Table of contents

Properties

• projectFile
• settings
• variables

Properties

projectFile

• Optional projectFile: Project

Custom Project object If not provided, defaults to @twick/visualizer project

Note: Must be an imported Project object, not a string path. String paths only work in Node.js environments (server renderer).

Example:

import myProject from './my-custom-project';

await renderTwickVideoInBrowser({
  projectFile: myProject,
  variables: { input: {...} }
});

Defined in

browser-renderer.ts:455

---

settings

• Optional settings: Object

Render settings

Type declaration

Name	Type	Description
downloadAudioSeparately?	boolean	-
fps?	number	-
height?	number	-
includeAudio?	boolean	-
onAudioReady?	(audioBlob: Blob) => void	-
onComplete?	(videoBlob: Blob) => void	-
onError?	(error: Error) => void	-
onProgress?	(progress: number) => void	-
preset?	"standard" | "high" | "draft"	Optional preset to hint performance vs. quality behaviour. "draft" may trade some quality for faster renders.
quality?	"medium" | "high" | "low"	-
range?	[number, number]	-
signal?	AbortSignal	Optional AbortSignal to cancel an in-progress render
width?	number	-

Defined in

browser-renderer.ts:463

---

variables

• variables: Object

Input variables containing project configuration

Index signature

▪ [key: string]: any

Type declaration

Name	Type
input	any
playerId?	string

Defined in

browser-renderer.ts:457