Audio Recorder
| Property | Type | Access | Description |
|---|---|---|---|
OperatorStatus |
OperatorStatus |
get |
Current operator state (read-only). Reflects whether the recorder is idle, listening for the volume threshold, actively recording, or saving. Useful from a script for chaining actions (e.g. log a message when recording starts, or send an alert when it stops unexpectedly). |
RecordingDuration |
string |
get |
Length of the current recording, formatted as HH:MM:SS (read-only). Updates while recording is in progress. |
AutoStartCheckBox |
bool |
get/set |
When true, the recorder starts automatically when the project loads. [default=true]. Combined with VolumeThresholdCheckBox, this gives unattended capture: load the project and walk away — recording begins as soon as audio is detected. |
ReportErrorOnAudioFailure |
bool |
get/set |
When true, raises an error in the log if no audio is received during a recording session. [default=false]. Useful for unattended setups where a silent recording usually means something upstream is broken (mic disconnected, source down, routing issue) rather than "nothing happened to record". |
MaxRecordingTime |
string |
get/set |
Maximum recording length in seconds — the recorder stops automatically once this is reached. Leave empty for no time limit (recording continues until manually stopped). Useful for fixed-length captures (e.g. 60-second voice memos) and as a safety cap on unattended recordings. |
VolumeThresholdCheckBox |
bool |
get/set |
When true, recording only starts once the input level rises above VolumeThreshold. [default=true]. Avoids capturing long stretches of silence — the recorder waits, listening, and triggers when actual sound is detected. Disable for "always-on" recording that starts the instant the recorder is started. |
VolumeThreshold |
int |
get/set |
Volume level (0–100) above which the recorder triggers. [min=0, max=100, default=0]. Only used when VolumeThresholdCheckBox is true. Higher values require a louder signal before recording starts, helping ignore room noise or hum. Low values trigger on faint sound — useful when the source is quiet to begin with. |
TrimAudioSilenceCheckBox |
bool |
get/set |
When true, silence at the start and end of the recording is removed before saving. [default=true]. Tidies up the file when triggering on volume threshold — typically there's a small gap before the talker actually starts speaking, and a tail after they stop. Disable to keep the recording exactly as captured. |
SaveFolder |
SaveLocation |
get/set |
Folder that recorded files are written to. Pick a location that has enough free space for long recordings, and that the process running Composer has permission to write to. |
StartRecordingCommand |
Command |
get |
Start recording. If VolumeThresholdCheckBox is enabled, the recorder waits for the threshold to be crossed before actually capturing. |
StopRecordingCommand |
Command |
get |
Stop recording and save the captured audio to a file in SaveFolder. |
OpenFolderCommand |
Command |
get |
Open the save folder in the operating system's file browser, so the recorded files can be played back, copied, or shared. |
See also: Audio Recorder in Operators — user-facing introduction, screenshots, and section summaries.