> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeroruntime.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Recording & Audio
> JavaScript API reference for Recording & Audio.
## RecordingConfig
Configure session recording (audio, video, transcript, and upload). See RecordingConfigOptions.
### Constructor
```typescript theme={null}
new RecordingConfig(opts: RecordingConfigOptions)
```
Master switch for session recording. Defaults to `false`.
Start recording automatically when the session begins. Defaults to `true`.
Output audio format. Defaults to `'ogg_opus'`.
`'mixed'` for a single combined track, `'dual_channel'` to separate participants. Defaults to `'dual_channel'`.
Output sample rate in Hz. Defaults to `0` (use source rate).
Output bitrate in kbps for compressed formats. Defaults to `0` (codec default).
Where to upload the recording. Defaults to `null` (default storage). See S3StorageConfig.
Transcript settings. Defaults to `null` (no transcript). See RecordingTranscriptConfig.
Maximum recording length in seconds. Defaults to `0` (no limit).
Maximum recording file size in MB. Defaults to `0` (no limit).
Play a beep to indicate recording is active. Defaults to `false`.
Mute DTMF tones in the recording. Defaults to `false`.
Custom metadata stored with the recording.
Human-readable name for the recording. Defaults to `''`.
Group/label used to bucket related recordings. Defaults to `''`.
Apply denoising to recorded audio. Defaults to `false`.
Normalize recorded audio loudness. Defaults to `false`.
Trim leading/trailing silence. Defaults to `false`.
Record participant video. Defaults to `false`.
Record screen-share video. Defaults to `false`.
Record screen-share audio. Defaults to `false`.
***
## S3StorageConfig
Configure an S3 (or S3-compatible) destination for recording uploads. See S3StorageConfigOptions.
### Constructor
```typescript theme={null}
new S3StorageConfig(opts: S3StorageConfigOptions)
```
Target S3 bucket name.
AWS region of the bucket.
Key prefix prepended to uploaded objects.
AWS access key id. Leave empty to use the default configured credentials.
AWS secret access key.
Temporary session token for STS credentials.
Custom S3-compatible endpoint URL (for non-AWS providers).
S3 storage class (e.g. `STANDARD`, `STANDARD_IA`).
Server-side encryption mode (e.g. `AES256`, `aws:kms`).
KMS key id used when `serverSideEncryption` is `aws:kms`.
Canned ACL applied to uploaded objects.
Whether to use multipart upload for large objects. Defaults to `true`.
Part size in MB for multipart uploads. Defaults to `8`.
Per-upload timeout in seconds. Defaults to `0` (no limit).
Number of upload retry attempts. Defaults to `3`.
Object tags to attach to uploads.
Custom `x-amz-meta-*` metadata to attach to uploads.
Overrides the auto-detected `Content-Type`.
***
## RecordingTranscriptConfig
Configure transcript generation for a recording. See RecordingTranscriptConfigOptions.
### Constructor
```typescript theme={null}
new RecordingTranscriptConfig(opts: RecordingTranscriptConfigOptions)
```
Whether to produce a transcript alongside the recording. Defaults to `false`.
Transcript file format. Defaults to `'json'`.
Include per-word timestamps. Defaults to `false`.
Include per-segment confidence scores. Defaults to `false`.
Label each segment with its speaker. Defaults to `true`.
Transcript language hint (BCP-47 code). Defaults to `''` (auto-detect).
***
## RecordingOptions
Configure which media a room recording captures. See RecordingOptionsInit.
### Constructor
```typescript theme={null}
new RecordingOptions(init: RecordingOptionsInit)
```
Record participant video. Defaults to `false`.
Record screen-share. Defaults to `false`.
***
## RecordingFormat
Container/codec for a call recording.
```typescript theme={null}
enum RecordingFormat {
WAV = 'wav',
OGG_OPUS = 'ogg_opus',
MP3 = 'mp3',
FLAC = 'flac',
}
```
***
## RecordingChannelMode
Channel layout for a call recording.
```typescript theme={null}
enum RecordingChannelMode {
MIXED = 'mixed',
DUAL_CHANNEL = 'dual_channel',
}
```
***
## RecordingTranscriptFormat
Output format for a recording's transcript.
```typescript theme={null}
enum RecordingTranscriptFormat {
JSON = 'json',
SRT = 'srt',
VTT = 'vtt',
}
```
***
## RecordingState
Current state of a recording, reported via recording status events.
```typescript theme={null}
enum RecordingState {
IDLE = 'idle',
RECORDING = 'recording',
FINALIZING = 'finalizing',
UPLOADING = 'uploading',
COMPLETED = 'completed',
FAILED = 'failed',
}
```
***
## BackgroundAudioHandlerConfig
Create a BackgroundAudioHandlerConfig.
### Constructor
```typescript theme={null}
new BackgroundAudioHandlerConfig(opts: BackgroundAudioHandlerConfigOptions)
```
Path to the audio file to play. Default: `''`.
Playback volume multiplier, where 1.0 is the original level. Default: `1.0`.
Whether to loop the file continuously. Default: `false`.
Whether background audio is active. Default: `true`.
Playback vs. mixing behavior. Default: `'mixing'`.
Number of audio samples per processing chunk. Default: `320`.