Skip to main content

Recording

The recording feature can save audio from calls to files, supporting wav and ogg formats.

The recording feature is configured in the recorder field in CallOption of the Invite/Accept commands, defaults to off.

Parameters​

recorder_file​

Recording file name. Defaults to session_id, automatically generated session_id format is s.{uuid} example:

s.b3d3dc88-0929-4678-81dc-e5adc40be9c9

If it's an absolute path, use it directly, otherwise create it in recorder_path.

recorder_path defaults to /tmp/recorders, can be set in the RustPBX configuration file:

config.toml
recorder_path = "/tmp/recorders"

samplerate​

Sample rate of saved file, default 16000. Needs to be configured the same as Track sample rate:

  • SIP calls default to 16000hz
  • WebRTC calls depend on codec:
    • G722 16000hz
    • Opus 48000hz
    • Others 8000hz

ptime​

Packet time, unit milliseconds, default 200. Mainly used with sample rate to calculate chunk size of saved file.

format​

Format of saved file, supports wav(default) and ogg.

Format can also be set in the RustPBX configuration file:

config.toml
recorder_format = "wav"

Event dump​

Recording configuration affects event dump.

Event dump is enabled by setting dump=true when connecting to RustPBX. See Connect to RustPBX.

Dump files will be in the same directory as recording files, file name is session_id.event.jsonl.