@twick/browser-render / Exports / UseBrowserRendererOptions
Interface: UseBrowserRendererOptions
Table of contents
Properties
- autoDownload
- downloadAudioSeparately
- downloadFilename
- fps
- height
- includeAudio
- onAudioReady
- projectFile
- quality
- range
- width
Properties
autoDownload
• Optional autoDownload: boolean
Automatically download the video when rendering completes
Defined in
hooks/use-browser-renderer.ts:37
downloadAudioSeparately
• Optional downloadAudioSeparately: boolean
Download audio separately as WAV file
Defined in
hooks/use-browser-renderer.ts:33
downloadFilename
• Optional downloadFilename: string
Default filename for downloads
Defined in
hooks/use-browser-renderer.ts:39
fps
• Optional fps: number
Frames per second
Defined in
hooks/use-browser-renderer.ts:25
height
• Optional height: number
Video height in pixels
Defined in
hooks/use-browser-renderer.ts:23
includeAudio
• Optional includeAudio: boolean
Include audio in rendered video (experimental)
Defined in
hooks/use-browser-renderer.ts:31
onAudioReady
• Optional onAudioReady: (audioBlob: Blob) => void
Callback when audio is ready
Type declaration
▸ (audioBlob): void
Parameters
| Name | Type |
|---|---|
audioBlob | Blob |
Returns
void
Defined in
hooks/use-browser-renderer.ts:35
projectFile
• Optional projectFile: any
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 (server renderer).
Example:
import myProject from './my-custom-project';
useBrowserRenderer({ projectFile: myProject })
Defined in
hooks/use-browser-renderer.ts:19
quality
• Optional quality: "medium" | "high" | "low"
Render quality
Defined in
hooks/use-browser-renderer.ts:27
range
• Optional range: [number, number]
Time range to render [start, end] in seconds
Defined in
hooks/use-browser-renderer.ts:29
width
• Optional width: number
Video width in pixels