Recorder

The Recorder section configures the room’s recording device: which video and audio inputs it captures, the capture quality, how it behaves when the room shuts down, and the reminder prompts shown to users during a session. Configure it when a room has a hardware recorder (e.g. Echo360 or Epiphan) that captures lectures or presentations.

Field reference

Property	Description	Required	Default
`Device ID`	Identifier of the recorder device, as defined under Devices.	No	(empty)
`Disable`	If enabled, the recorder is turned off for this room. The recorder is also treated as disabled when `Device ID` is empty.	No	`false`
`Capture Profile`	Selects which inputs are recorded and at what quality. See the enum below.	Yes	`Audio/HDMI-1/HDMI-2 (High Quality)`
`Extension Time`	Seconds added to a recording when a user taps the extend button.	No	`0`
`Recording Paused Prompt Interval`	Minutes between reminders that a recording is paused. See the interval rules below.	No	`-1`
`No Audio Detected Prompt Interval`	Minutes between warnings that no audio is being detected. See the interval rules below.	No	`-1`
`Content Stream URL`	Preview URL for the content input, shown on the touch panel.	No	(empty)
`Camera Stream URL`	Preview URL for the camera input, shown on the touch panel.	No	(empty)
`Destination Type Recorded`	The destination type the recorder follows, so the UI can show what is being recorded. As the recorder tracks whatever source is routed to this destination type, the panel reflects the current recording content.	No	(empty)
`Recorder Audio Mute`	Object that points at a DSP channel used to mute the recorder’s audio feed. See fields below.	No	(none)

Capture Profile values

Capture Profile is required and must be one of the following. The name states which inputs are captured (audio only, audio plus one or both HDMI inputs) and the quality tier.

Value
`Audio (High Quality)`
`Audio (Highest Quality)`
`Audio (Standard Quality)`
`Audio/HDMI-1 (High Quality)`
`Audio/HDMI-1 (Highest Quality)`
`Audio/HDMI-1 (Standard Quality)`
`Audio/HDMI-1/HDMI-2 (High Quality)` (default)
`Audio/HDMI-1/HDMI-2 (Highest Quality)`
`Audio/HDMI-1/HDMI-2 (Standard Quality)`
`Audio/HDMI-2 (High Quality)`

Recorder Audio Mute fields

Recorder Audio Mute mutes the recorder’s audio via the DSP (Digital Signal Processor, the device that mixes and routes room audio) rather than at the recorder itself.

Field	Description
`Device ID`	The DSP device that owns the mute control.
`Block ID`	The DSP block (audio processing unit) that holds the mute.
`Channel ID`	The channel within the block (if applicable).

Prompt interval rules

Both Recording Paused Prompt Interval and No Audio Detected Prompt Interval are interpreted the same way:

A negative value such as -1 disables the prompt. The reminder never appears.
0 does not disable the prompt. It causes the prompt to appear immediately and stay shown for the whole condition, rather than waiting an interval.
A positive value is the number of minutes to wait before showing the reminder.

Use -1 to switch a reminder off, a positive number to remind at that cadence, and reserve 0 only when you deliberately want the prompt to show straight away.

Recording behaviour on room shutdown

The Recording Behaviour On Room Shutdown setting controls what happens to an active recording when the room shuts down.

Value	Behaviour
`Stop`	Recording ends and finalises.
`Pause`	Recording pauses.
`Remain Unchanged`	Recording continues unaffected. This is the default.

Supported recorders

Feature availability varies by recorder model.

Feature	Echo360	Epiphan
Start/Stop	Yes	Yes
Pause/Resume	Yes	No
Scheduled recordings	Yes	No
Recording timer	Counts down from preset duration	Counts up from 00:00

Worked example

A recorder capturing audio and both HDMI inputs at high quality, with paused and no-audio reminders every 5 minutes and audio muting routed through the DSP:

{
  "Disable": false,
  "Device ID": "recorder-1",
  "Capture Profile": "Audio/HDMI-1/HDMI-2 (High Quality)",
  "Destination Type Recorded": "Main",
  "No Audio Detected Prompt Interval": 5,
  "Recording Paused Prompt Interval": 5,
  "Recorder Audio Mute": { "Device ID": "dev.dsp.1", "Block ID": "Rec_GainMute", "Channel ID": "1" }
}