1. buttonLabel

Sets a custom label for the Velt Recorder Tool.

<VeltRecorderTool buttonLabel="Your Label Text" />

2. enableRecordingCountdown

Controls whether to display a countdown timer before a recording starts.

Default: enabled

const recorderElement = client.getRecorderElement();
recorderElement.enableRecordingCountdown();
recorderElement.disableRecordingCountdown();

3. enableRecordingTranscription

Controls whether to enable AI transcription for recordings.

Default: enabled

const recorderElement = client.getRecorderElement();
recorderElement.enableRecordingTranscription();
recorderElement.disableRecordingTranscription();

4. getRecordingDataByRecorderId

Fetches recording data (transcript, summary, and URLs) for a recording ID and returns a RecorderData object.

Using Hook:

const recorderData = useRecordingDataByRecorderId('-O9yTMWmEe5u6YGX8EFV');

useEffect(() => {
    console.log('Recorder Data: ', recorderData);
}, [recorderData]);

Using API:

const recorderElement = client.getRecorderElement();

recorderElement.getRecordingDataByRecorderId("-O9yGiYS8lehOXMpQf4j").subscribe((recorderData) => {
    console.log('Recorder Data: ', recorderData);
});

5. mode

The Velt Recorder Control Panel has two display modes:

  • floating: Shows a preview in the bottom left corner of the page, regardless of component placement
  • thread: Displays the component at its placed location in the DOM

Default: "floating"

<VeltRecorderControlPanel mode="floating" />
<VeltRecorderControlPanel mode="thread" />

6. onDelete

When a recording is deleted by its creator, the Velt Recorder Player component emits an onDelete event containing the recorder ID. You can listen for this event to perform any necessary cleanup.

The event returns an object with the following field:

FieldTypeDescription
idstringThe ID of the deleted recorder
<VeltRecorderPlayer recorderId={RECORDER_ID} onDelete={(data) => yourDeleteMethod(data)} />

7. onRecordedData

The onRecordedData callback is triggered when a recording is completed. It provides the following data:

FieldTypeDescription
idstringUnique identifier for the recording
tagstringHTML tag to embed the recording player (e.g. <velt-recorder-player recorder-id="123"></velt-recorder-player>)

Using Hooks:

  const recorderAddEvent = useRecorderAddHandler();

  useEffect(() => {
    console.log('recorderAddEvent', recorderAddEvent);
  }, [recorderAddEvent]);

Using API:

  const recorderElement = client.getRecorderElement();
  recorderElement.onRecordedData().subscribe((recorderAddEvent) => {
    console.log(recorderAddEvent);
  });

Using Event Listener:

  const onRecordedData = (recorderAddEvent) => {
    console.log(recorderAddEvent);
  }
  return (
    <VeltRecorderControlPanel mode="thread" onRecordedData={onRecordedData} />
  )

8. summary

Controls whether to display a summary transcript of the recording. When enabled, an AI-generated summary of the recording’s content will be shown.

Default: true

<VeltRecorderPlayer summary={true}/>

9. type

Sets the recording mode for the Velt Recorder Tool.

Available modes:

  • all - Records audio, video and screen
  • audio - Records audio only
  • video - Records video only
  • screen - Records screen only

Default: audio

<VeltRecorderTool type='all' />
<VeltRecorderTool type='audio' />
<VeltRecorderTool type='video' />
<VeltRecorderTool type='screen' />