Customize Behavior
1. buttonLabel
Sets a custom label for the Velt Recorder Tool
.
2. enableRecordingCountdown
Controls whether to display a countdown timer before a recording starts.
Default: enabled
3. enableRecordingTranscription
Controls whether to enable AI transcription for recordings.
Default: enabled
4. getRecordingDataByRecorderId
Fetches recording data (transcript, summary, and URLs) for a recording ID and returns a RecorderData object.
Using Hook:
Using API:
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 placementthread
: Displays the component at its placed location in the DOM
Default: "floating"
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:
Field | Type | Description |
---|---|---|
id | string | The ID of the deleted recorder |
7. onRecordedData
The onRecordedData
callback is triggered when a recording is completed. It provides the following data:
Field | Type | Description |
---|---|---|
id | string | Unique identifier for the recording |
tag | string | HTML tag to embed the recording player (e.g. <velt-recorder-player recorder-id="123"></velt-recorder-player> ) |
Using Hooks:
Using API:
Using Event Listener:
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
9. type
Sets the recording mode for the Velt Recorder Tool
.
Available modes:
all
- Records audio, video and screenaudio
- Records audio onlyvideo
- Records video onlyscreen
- Records screen only
Default: audio