Function: Recorder()

function Recorder(params: {
  fileOptions?: FilePickerAcceptType;
  recorderOptions?: MediaRecorderOptions;
  streamOptions?: {
    frameRequestRate: number;
  };
  defaultFilename?: string;
  onSuccess?: (filename: string) => void;
  onCancel?: () => void;
  children?: (props: { recordTime: number }) => ReactNode;
}): ReactNode;

Defined in: livelink.react/sources/components/utils/Recorder.tsx:28

Experimental

A React component that provides video recording functionality from a canvas element.

Parameters

Parameter	Type	Description
params	{ fileOptions?: FilePickerAcceptType; recorderOptions?: MediaRecorderOptions; streamOptions?: { frameRequestRate: number; }; defaultFilename?: string; onSuccess?: (filename: string) => void; onCancel?: () => void; children?: (props: { recordTime: number; }) => ReactNode; }
params.fileOptions?	FilePickerAcceptType	Configuration for the file picker when saving recordings
params.recorderOptions?	MediaRecorderOptions	Configuration options for the MediaRecorder
params.streamOptions?	{ frameRequestRate: number; }	Configuration for the canvas stream capture
params.streamOptions.frameRequestRate	number	Desired frame rate for video capture
params.defaultFilename?	string	Default filename for the recording. If not provided, generates a timestamped filename with scene name
params.onSuccess?	(filename: string) => void	Callback function executed when recording is successfully completed and saved
params.onCancel?	() => void	Callback function executed when recording is cancelled by the user
params.children?	(props: { recordTime: number; }) => ReactNode	Render function that receives recording state and returns React elements

Returns

ReactNode