@twick/browser-render / Exports / UseBrowserRendererReturn
Interface: UseBrowserRendererReturn
Table of contents
Properties
Properties
download
• download: (filename?: string) => void
Download the rendered video
Type declaration
▸ (filename?): void
Parameters
| Name | Type |
|---|---|
filename? | string |
Returns
void
Defined in
hooks/use-browser-renderer.ts:54
error
• error: null | Error
Error if rendering failed
Defined in
hooks/use-browser-renderer.ts:50
isRendering
• isRendering: boolean
Whether rendering is in progress
Defined in
hooks/use-browser-renderer.ts:48
progress
• progress: number
Current rendering progress (0-1)
Defined in
hooks/use-browser-renderer.ts:46
render
• render: (variables: { [key: string]: any; input: any ; playerId?: string }) => Promise<null | Blob>
Start rendering the video
Type declaration
▸ (variables): Promise<null | Blob>
Parameters
| Name | Type |
|---|---|
variables | Object |
variables.input | any |
variables.playerId? | string |
Returns
Promise<null | Blob>
Defined in
hooks/use-browser-renderer.ts:44
reset
• reset: () => void
Reset the renderer state
Type declaration
▸ (): void
Returns
void
Defined in
hooks/use-browser-renderer.ts:56
videoBlob
• videoBlob: null | Blob
The rendered video blob (available after rendering completes)