Loading...
Pearl · Pearl-2 · Pearl Mini · Pearl Nano · Pearl Nexus
Control and monitor Epiphan encoders (Pearl-2, Pearl Mini, Pearl Nano, Pearl Nexus and newer models) from Companion. The action set matches the sibling Epiphan Encoders Stream Deck plugin one for one: Recorder, Stream, Layout, Single Touch, Bookmark, Preview, Output Source, Apply Preset, Event, System Status, Reboot / Shutdown, Audio and Storage.
/api/v2.0/...).admin account). Operator accounts cannot change settings.If you are upgrading a connection created before this module's 3.0.0 release, an upgrade script converts every action and feedback that still has a Stream Deck counterpart to its new id automatically (your buttons keep working, though a few option layouts changed — see the changelog). The actions Get layout data, Set layout data, Get Content Metadata and Set Content Metadata are kept exactly as they were; buttons that hold an action which no longer exists are left as they were and the connection log prints one warning per removed id the first time it starts, naming how many buttons carried it. The variable ids of 2.2.x (for example stream_1_0_state, system_status_cpuload, identity_name, channel_1_bitrate) still exist next to the new ones, so button text keeps working.
The setting names below are the labels shown in the connection's settings page.
| Setting | Meaning |
|---|---|
| Encoder | Encoders in the same network as Companion announce themselves (Bonjour) and are listed here by their device name. Select one and enter username and password; its address is then used instead of Host and Port. Manual (the default, and what every connection of earlier versions uses) keeps the address entered in Host and Port, e.g. for an encoder in another network or behind a VPN. |
| Host | IP address or DNS name of the encoder (default 192.168.255.250). Shown while Encoder is Manual. |
| Port | HTTP port of the encoder's web UI/API (default 80; becomes 443 automatically the first time you turn on Use HTTPS if you left it at 80). |
| Username | Device account name (default admin). |
| Password | Password for that account. Leave blank if the device has no password set. |
| Use HTTPS | Off by default. If HTTPS is enabled on the encoder, enable it here too. |
| Accept self-signed certificate | Shown only while Use HTTPS is ticked. Ticked by default: accept the encoder's own (self-signed) certificate without a trusted CA. Untick to require a certificate a public or internal CA has signed; an untrusted certificate then fails the connection instead of being accepted. |
| Poll interval (ms) | Milliseconds between state polls (500..300000, default 2000). Every poll refreshes channels, publishers, recorders, inputs, outputs, storage, single touch, system status and the CMS schedule. Firmware, device identity and the list of configuration presets are fetched on the first poll and then every 30th poll. If a poll fails, the next one waits longer (doubling each time, up to 15 s) until the device answers again. |
| Request timeout (ms) | Milliseconds a single request may take before it is aborted (1000..60000, default 5000). |
| Preview image refresh interval (s, 0 disables previews) | Seconds between preview image refreshes (0..300, default 2). 0 disables every preview (the audio meter has its own 500 ms level poll and is not affected). Only previews actually placed on a button are fetched, at most 3 at a time, so a page full of preview buttons does not overwhelm the encoder. |
| Preview image width (px) | Width in pixels requested from the encoder for preview images (72..720, default 144). Larger images look sharper on big surfaces but cost more bandwidth and CPU on the encoder. |
| Poll CMS schedule | Ticked (default): poll the upcoming and ongoing CMS event, plus the next 10 scheduled/recent events, every poll (Kaltura, Panopto, YuJa, Opencast...). Untick if the device is not connected to a CMS. |
| Enable verbose logging | Log every request and response at debug level. Useful when reporting a problem; leave off in normal use. |
| API version | Not a setting: the API is selected automatically from the encoder's firmware (API v2.0 from 4.24.1, the legacy API before). The one in use (and the firmware, when the encoder reports it) is shown at the bottom of this settings page, in the connection status and in the variable api_version (2.0 or legacy). If the encoder could not be reached when the module started, the check is repeated with every poll. With older firmware the connection shows a warning recommending a firmware update; everything that does not need v2.0 keeps working. |
| Preset categories to generate | Multi-select, default: every category. Controls which groups of ready-made buttons appear in the drag-and-drop preset list (see Presets below). Unchecking a group only hides its auto-generated buttons; the underlying actions and feedbacks stay available for a hand-built button, and anything already on a page keeps working. |
Actions never disable the connection when the encoder rejects a request: the device's own error message is
logged and written to the last_error variable. Text options that accept variables (Bookmark's Text, Event's
Event) are expanded with Companion's variable parser before being sent.
Start / Stop starts a stopped recorder and stops a running or paused one; Start and Stop send that one command whatever the recorder is doing (what the 2.x Control recording action did); Pause / Resume pauses a running recorder and resumes a paused one; "All recorders" controls every recorder on the device.
| Option | Values | Default |
|---|---|---|
| Recorder | "All recorders" or a specific recorder | All recorders |
| Action | Start / Stop, Start, Stop, Pause / Resume, Reset | Start / Stop |
Pause / Resume and "All recorders" require API v2.0. Start / Stop and Reset on a single recorder work on legacy firmware too — Reset automatically falls back to the legacy endpoint if the v2.0 one is unavailable. A Pause / Resume press while the recorder is stopped sends nothing and logs "nothing to pause or resume".
Feedback — Recorder state (recorder_state): true while the selected recorder — or, for "All
recorders", the aggregate of every recorder — is in the chosen state (Started, Starting, Paused, Error,
Stopped, Disabled). The aggregate reports the first of Started, Starting, Paused, Error found among all
recorders, otherwise Stopped. Style: red badge (used for Started/Error), amber for Paused/Starting.
Feedback — Recorder paused (blink) (recorder_blink): true during the "on" half of a 500 ms blink while
the selected recorder (or, for "All recorders", any recorder) is paused, false otherwise. Placed after a
Paused style on a button it makes that style flash. The blink runs only while something is paused.
Variables: recorder_ID_name, _state, _state_word (REC/PAUSED/ERR/OFF/?), _duration
(seconds), _duration_text (3:45/1:02:03), _duration_hms (HH:MM:SS); recorder_all_state_word,
recorders_active_count.
Presets — Recording: two buttons per recorder plus "All recorders", each with a state glyph at the top that follows the recorder. Start / Stop shows a record dot at rest, a red stop square while recording or in error, amber pause bars while paused and an amber dot while starting. Pause / Resume shows a green pause bar while recording and a blinking amber play triangle while paused; its text greys out while the recorder is stopped.
Start, stop or toggle a channel's stream (publisher). "All publishers" starts or stops every stream configured on the channel.
| Option | Values | Default |
|---|---|---|
| Channel | the encoder's channels | first channel |
| Publisher | "Channel – All publishers" or a specific "Channel – Name (type)" | first entry |
| Action | Toggle, Start, Stop | Toggle |
Feedback — Stream state (stream_state): true while the selected publisher — or, for "All
publishers", the aggregate of the channel's publishers — is in the chosen state (Started, Starting,
Listening, Error, Stopped). Green (Started), amber (Starting/Listening), red (Error).
Variables: channel_CID_publisher_PID_name, _type, _state, _state_word
(LIVE/STARTING/LISTEN/ERR/OFF/?), _error; channel_CID_publishers_state_word (aggregate);
channel_CID_name.
Presets — Streaming: one toggle button per publisher and per channel's "All publishers"; green LIVE, amber STARTING/LISTEN, red ERR.
Switch a channel to a layout. The key lights up while that layout is active.
| Option | Values | Default |
|---|---|---|
| Channel | the encoder's channels | first channel |
| Layout | layouts of that channel, labelled "Channel – Layout" | first entry |
Feedback — Layout active (layout_active): true while the selected layout is the active layout of its
channel. Amber.
Feedback — Layout preview (advanced, layout_preview): shows a live preview image of that specific
layout on its switch button, whether or not it is currently active. Uses an undocumented endpoint (not in
Epiphan's published REST API v2.0 specification, confirmed working by Epiphan) that renders a given layout
directly. Requires Preview image refresh interval > 0.
Variables: channel_CID_active_layout (name), _active_layout_id, _name.
Presets — Layouts: one button per layout, title = layout name, subtitle = channel name; amber while active, plus the live preview image.
Trigger a single-touch control of the encoder (start/stop recording and streaming together). Most devices have only control 0. Requires API v2.0.
| Option | Values | Default |
|---|---|---|
| Single touch control | the device's single touch controls | 0 when present, else the first one |
Feedback — Single touch state (singletouch_active): "On" is true while pressed; "Error" is true while
the control reports a failed start. Green (On), red (Error).
Variables: singletouch_ID_active, _status_ok, _summary (rec 1/3 · str 1/2), _state_word
(ON/ERR/'').
Presets — Single touch: one toggle button per control; green while pressed, red text while unhealthy.
Add a bookmark (marker) to a channel's recording. Bookmarks are only stored while the channel is recording.
| Option | Values | Default |
|---|---|---|
| Channel | the encoder's channels | first channel |
| Text | text, accepts variables | Marker |
| Append the current time (HH:MM:SS) | checkbox | off |
Text tooltip (verbatim): "Shown in the recording’s bookmark list. Keep it short."
No new feedback — the Bookmarks preset reuses Recorder state with Recorder set to the channel's own id, so no variables are added either.
Presets — Bookmarks: one button per channel, text Bookmark / Marker; grey text while the channel's
recorder is not recording (an inverted Recorder state feedback).
Kept from earlier versions (ids and options unchanged, existing buttons keep working). Always uses the legacy API, so they also work on firmware without API v2.0. Get layout data returns the layout settings as JSON as the action's result: choose where to keep it in the action's Store result setting (a custom variable or a local variable). Buttons that used the old Destination Variable are converted automatically.
| Option | Values | Default |
|---|---|---|
| Layout to get / set | every layout of every channel | first layout |
| Layout Data | Set only: the JSON text to write, e.g. one stored by Get; accepts variables | {} |
Read or write a channel's title, author and filename prefix (kept from earlier versions; ids unchanged). The values are read once per channel at start-up, and again by Get Content Metadata.
| Option | Values | Default |
|---|---|---|
| Channel | the encoder's channels | first channel |
| Title | text, accepts variables (Set only) | empty |
| Author | text, accepts variables (Set only) | empty |
| Filename Prefix | text, accepts variables (Set only) | empty |
Variables: channel_CID_metadata_title, _metadata_author, _metadata_rec_prefix.
Show a live thumbnail of a channel, video input or output on the key. Display-only — there is no dedicated action; place the feedback directly (or use a Previews preset).
Feedback — Preview (advanced, preview): Source type = Channel (default), Input or Output; Source
lists channels, video-capable inputs and outputs together (an audio-only input has no picture and is not
offered) — pick the entry matching Source type. Requires Preview image refresh interval > 0. Channel,
input and output previews require API v2.0 and stay blank without it; the Layout preview feedback (see
Layout above) works on legacy firmware too, since it uses the same legacy endpoint on both API versions.
Variables: channel_CID_name, input_ID_name, output_ID_name (used as the title line on the preview
presets).
Presets — Previews: one button per channel, per video-capable input and per output, showing the live image with the source's name.
Switch the source shown on an HDMI/SDI output of the encoder. Requires API v2.0.
| Option | Values | Default |
|---|---|---|
| Output | the device's outputs | first output |
| Source | Built-in: Multiview, Built-in: Device info, Built-in: Console, Channel: name, Input: name | first entry |
Feedback — Output source recently set (output_set): true while this connection set the selected
source on the selected output within the last 5 seconds. The API has no way to read the output source back,
so this only reflects what this connection itself last sent, not a value confirmed by the device. Green.
Variables: output_ID_name, _source (optimistic, empty until set, see Known limitations).
Presets: none — build Output Source buttons by hand from the action above (green Output set feedback).
Apply a configuration preset stored on the encoder. This can interrupt recordings and streams and the device may reboot. Requires API v2.0.
| Option | Values | Default |
|---|---|---|
| Preset | configuration presets stored on the device | first preset |
| Sections | multi-select: System, Network, Sources, EDID, Channels, AFU, CMS, AV Studio, Front screen, Displays | none (= whole preset) |
| Confirm with a second press | checkbox — see Confirm and hold | on |
Feedback — Confirm pending (confirm_pending): true while a confirm-gated action on this button is
armed, waiting for a second press. Red, with Press again in place of the label on that button only — see
Confirm and hold below.
Feedback — Action failed (recent) (action_failed): true for three seconds on the button whose last
device command failed — rejected (for example an Extend that would overlap the next event, 409), timed out
or unreachable. Red with Failed in place of the label; every ready-made preset that sends a command
carries it, so a refused command is visible on the key and not only in Companion's log. The message is in
last_error.
Variables: preset_names (comma-separated), preset_last_applied (optimistic), preset_status
(Rebooting… for 60 s when the device reports a reboot).
Presets — Configuration presets: one button per device preset, text preset name / Rebooting… after a
reboot-reporting apply, no icon (device preset names are long); Press again in red while confirm is armed.
Pause / resume, stop or extend the ongoing CMS event, start the upcoming one, or control a specific event. A command that does not apply to the event's state is not sent. Requires API v2.0.
| Option | Values | Default |
|---|---|---|
| Event | Upcoming (next scheduled), Ongoing (running or paused), Running, Paused, Completed (most recent), or a specific polled event (title (status), custom text also accepted) | Ongoing (running or paused) |
| Action | Ongoing, Running and Paused: Pause / Resume, Stop, Extend. Upcoming: Start, the only command that applies, so no choice is shown. A specific event: Start, Pause / Resume, Stop, Extend | Pause / Resume |
| Extend by | seconds, 30..21600, shown only for Extend | 300 |
Event tooltip (verbatim): ""Ongoing" always targets the event that is currently running or paused, "Upcoming" the next scheduled one. Picking a specific event ties the button to it." The event is resolved fresh from the device at press time, not from the last poll, so an alias can never fire on a stale event. Pause / Resume pauses a running event and resumes a paused one; it never starts one.
Feedback — Event state (event_state): true while the resolved event is in the selected state
(Running, Paused, Ongoing (running or paused), Scheduled, Finished, None). Green (Running), amber (Paused),
cms blue (Scheduled), grey (None).
Feedback — Event command applies (event_applies): true while the selected command (Start, Stop,
Pause, Resume, Extend) would actually be sent for the resolved event's current status — the same rule the
Event action itself uses. Cms blue.
Variables: event_upcoming_id/_title/_start/_start_time/_starts_in_hms/_time_text
(in 5:00/Starting…/No Upcoming Event)/_state_word (SCHED/—); event_ongoing_id/_title/
_status/_finish/_finish_time/_remaining_hms/_time_text (12:30 left/No Event Running)/
_state_word (LIVE/PAUSED/—); event_ongoing_toggle_command (PAUSE/RESUME/''); aliases
event_title, event_state, event_remaining (mirror the ongoing event).
Presets — CMS events: ongoing status (reads No Event Running while nothing runs), upcoming status
(No Upcoming Event while nothing is scheduled), Pause / Resume (green Pause while running, amber Resume
while paused, grey otherwise), Start upcoming, Stop and Extend +5:00. The status keys colour by state; the
three command keys grey out their text (an inverted Event command applies) when the command does not
currently apply.
Show CPU load and temperature, automatic file upload (AFU) state and device info. Display-only — polling replaces the Stream Deck's tap-to-refresh key (there is no dedicated action). CPU load/temperature and AFU data require API v2.0; on legacy firmware the feedback stays false and its variables stay empty.
Feedback — System condition (system): true while the selected condition holds — CPU load high, CPU
temperature high, AFU uploading, AFU paused, AFU error, AFU idle, AFU off (disabled or none). Amber
(CPU/paused), red (error), green (uploading).
Variables: cpu_load, cpu_temp, uptime_seconds, uptime (3d 4h), system_status_text
(47°C · up 3d 4h), afu_state (comma-separated states of every AFU destination), afu_text
(Uploading/Idle/Paused/Error/AFU off), afu_protocol, afu_queue_files, afu_error,
product_name, firmware, device_name.
Presets — System: CPU load / status button (amber while high or hot), AFU status button (green uploading, amber paused, red error), device info button.
Reboot or shut down the encoder. Shut down powers the device off completely; it must be switched back on at the device.
| Option | Values | Default |
|---|---|---|
| Action | Reboot, Shut down | Reboot |
| Confirm with a second press | checkbox — see Confirm and hold | on |
Feedback: Confirm pending (see Apply Preset above).
Variables: power_status (Command sent for 30 s).
Presets — Power: Reboot, Shut down; red while confirm is armed.
Nudge the capture gain (dB) of an analog input (XLR, TRS, 3.5 mm, RCA) or the audio delay (ms) of any audio input. Rotary ticks arriving within 150 ms are combined into one step — see Rotary below. Requires API v2.0.
| Option | Values | Default |
|---|---|---|
| Input | audio-capable inputs | first input |
| Adjusts | Gain, Delay — offered for analog inputs only; for any other input the choice is hidden and the action adjusts the delay | Gain |
| Direction | Up, Down | Up |
| Step | 1..100 | 1 |
Step tooltip (verbatim): "Gain steps are in dB (0–100), delay steps in milliseconds (−300..300)."
Feedback — Audio meter (advanced, audio): draws a stereo level meter for an audio input on the right
edge of the button — two vertical bars (left and right channel) with a light peak tick each, over a
−60..0 dBFS scale: green up to 62 % of the bar, amber to 82 %, red above. The bars are drawn over the
button, so its own text, colour and other feedbacks stay visible; a mono input gets a single bar, and an
input reporting no levels (no signal, or a device without the level endpoint) draws nothing at all.
Putting this feedback on a button starts a 500 ms level poll for the whole connection; taking the last one off stops it again. One poll covers every metered input (a single request lists them all), so ten meter buttons cost the encoder no more than one. The level variables below are filled by that poll only — while no meter is placed anywhere in the connection they read empty. If you want a text-only level readout, keep one meter button somewhere in the same connection.
Variables: input_ID_name (every input, incl. video-only), and for audio-capable inputs also
_peak_dbfs, _peak_left, _peak_right, _level_text (-18 dBFS/silent/No signal; all four empty
while no meter is subscribed), _gain, _delay (from the regular poll, always available).
Presets: none — build audio buttons by hand from the action, feedback and variables above (a rotary button works with the action on both rotate steps, see Rotary below).
Display only: there is no Storage action. The feedback, variables and presets below show each storage's free space and condition; ejecting removable media is done on the device itself.
Feedback — Storage level (storage_level): true while the selected storage is in the selected
condition — Low (≥ 90 % used), Full (≥ 97 % used), Read-only, No media, Not ready, Formatting, OK. Amber
(Low), red (Full), grey (No media).
Variables: storage_ID_state, _free (human bytes, e.g. 11 GB), _total, _used_pct, _text
(of 128 GB, read under _free as "11 GB of 128 GB"/No media/Not ready/Formatting…/No data),
_level_word (LOW/FULL/RO/'').
Presets — Storage: one button per storage showing free space and status; green OK, amber Low, red Full, grey No media.
Companion has no press-and-hold progress arc, so the actions the Stream Deck plugin gates behind a hold
(Apply Preset, Reboot / Shutdown) instead offer a Confirm with a second press
checkbox, ticked by default. With it ticked, the first press only arms the button — it sets the
confirm_hint variable to Press again and turns on the Confirm pending feedback (red) —
and sends nothing to the device; pressing the same button again within 3 seconds sends the command. If 3
seconds pass without a second press, the button quietly disarms. Untick the checkbox to send the command
immediately on every press, matching the old (pre-3.0.0) behaviour.
Only one confirm can be armed at a time: pressing a different confirm-gated button while one is already armed re-arms the new one and drops the first, rather than the two buttons confirming independently.
If you would rather reproduce the Stream Deck's actual hold gesture, use Companion's own press-duration button steps instead: put the action under Release after N ms (Companion's button step editor lets you add a step for "released after" a given hold time — use 2000 ms for Reboot / Shutdown, 1500 ms for Apply Preset, matching the Stream Deck plugin's own hold times) and untick Confirm with a second press on that copy of the action — the command then only fires when the button is held down for at least that long and then released, and a short tap does nothing.
Companion sends Rotate left / Rotate right (and, on push-capable surfaces, a separate Press) events for rotary controls. Put the Audio action on both rotate directions of a dial button (Down = decrease, Up = increase, both with Step 1) and leave the push step empty. Ticks that arrive within 150 ms of each other (a fast spin of the dial, or several quick presses of a Gain/Delay preset button) are combined into a single request carrying their summed step, rather than sending one request per tick — three quick clicks of a Step 1 gain dial send one change of +3, not three of +1.
Add the Audio meter feedback to a dial's button to see the bars next to the gain or delay readout.
| Feedback | Type | Colour(s) |
|---|---|---|
recorder_state | boolean | red (Started/Error), amber (Starting/Paused) |
recorder_blink | boolean | amber, true in the "on" half of a 500 ms blink while paused |
stream_state | boolean | green (Started), amber (Starting/Listening), red (Error) |
layout_active | boolean | amber |
layout_preview | advanced (image) | — |
singletouch_active | boolean | green (On), red (Error) |
preview | advanced (image) | — |
output_set | boolean | green |
event_state | boolean | green (Running), amber (Paused), cms blue (Scheduled), grey (None) |
event_applies | boolean | cms blue |
system | boolean | amber (CPU/paused), red (error), green (uploading) |
storage_level | boolean | amber (Low), red (Full), grey (No media) |
audio | advanced (image) | — |
confirm_pending | boolean | red, Press again on the key |
action_failed | boolean | red, Failed on the key for 3 s |
Use variables as $(encoder:variable_id) where encoder is the label you gave the connection (encoder is the default for a new connection, encoder_2 for a second one). Ids built from a
device id (recorders, channels, publishers, inputs, outputs, storages, single touch controls) have every
character other than letters, digits, _ and - replaced by _. Suffixes ending _hms are HH:MM:SS;
_text/_time suffixes are the ready-to-display forms described in each action's section above. Unknown
values are always empty, never missing.
| Prefix | Covered under |
|---|---|
recorder_*, recorders_active_count | Recorder |
channel_*_publisher_*, channel_*_publishers_state_word, channel_*_name, channel_*_active_layout* | Stream, Layout |
singletouch_* | Single Touch |
input_* | Audio |
output_* | Output Source |
preset_names, preset_last_applied, preset_status | Apply Preset |
event_* | Event |
cpu_*, uptime*, system_status_text, afu_*, product_name, firmware, device_name | System Status |
power_status | Reboot / Shutdown |
storage_* | Storage |
stream_*, channel_*_resolution/_fps/_bitrate, recorder_*_active, system_status_*, firmware_version, identity_* | Compatibility ids of 2.2.x (see below) |
confirm_hint | every confirm-gated action (see Confirm and hold) |
last_error | every action (the most recent failure's device message) |
channel_CID_signal (OK / No signal) and channel_CID_total_bitrate (kbit/s, video and audio): the
current values of the channel, from the legacy channel status.channel_CID_publisher_PID_duration (HH:MM:SS) and _reconnections.storage_ID_total_gb, _used_gb, _free_gb and _free_pct as numbers, storage_ID_remaining_time
(hh:mm) and _remaining_minutes: the recording time left, estimated from the bitrate of the recordings
running right now (empty while nothing is recorded; multi-source recorders are not counted).cpu_load_high and cpu_temp_high (true/false): the warnings, using the thresholds of the encoder.Button text written for module 2.2.x keeps working. These ids are defined under the same conditions as before and carry the same values; new buttons should use the ids of the new set:
| 2.2.x id | New id |
|---|---|
stream_CID_PID_name, _state | channel_CID_publisher_PID_name, _state |
stream_CID_PID_bitrate | — (send rate of the stream, if reported) |
channel_CID_resolution, _fps, _bitrate | — (current values of the video encoder) |
recorder_RID_active | — (active/total of a multi-source recorder) |
system_status_uptime, _cpuload, _cputemp | uptime_seconds, cpu_load, cpu_temp |
system_status_date | — |
firmware_version | firmware |
identity_name | device_name |
identity_location, identity_description | — |
Presets are generated from what the encoder reports, so they appear after the first successful poll. Which categories actually get generated is controlled by Preset categories to generate (see Connection settings above); all of them are on by default.
Every button follows the Stream Deck plugin's key layout, drawn with Companion's own renderer: a dark background with light text, no top bar, the state colour filling the background when a feedback is true, and one of two text recipes. A key with the category icon (small, at the top) puts at most two short lines of size 14 text below it, the plugin's own budget. A key whose text is a device-provided name or event title (stream, bookmark, configuration preset, the two CMS status keys and the CPU key) carries no icon and centres its text, so the whole key is there for the wrapped lines and a long name never hides the state line. The Single touch summary stands alone at size 22, and on the Previews and Layouts keys the live picture replaces the icon. The Recording keys carry a state glyph (record dot, stop square, pause bars, play triangle) that follows the recorder instead of a category icon. Labels and text size stay editable like any Companion button.
| Category | Buttons |
|---|---|
| Recording | Start / Stop and Pause / Resume per recorder, plus "All recorders"; state glyphs. |
| Streaming | Toggle per stream (channel, stream name, state), plus a "Streams" key per channel. |
| Layouts | Switch button per layout, live preview image. |
| Single touch | Toggle per control. |
| Bookmarks | One button per channel (channel name / Bookmark), greyed out while not recording. |
| Previews | Live thumbnail per channel, video-capable input and output. |
| Configuration presets | Apply button per device preset, confirm-gated. |
| CMS events | Ongoing/upcoming status, Pause / Resume, Start upcoming, Stop, Extend +5:00. |
| System | CPU load/status, AFU status, device info. |
| Power | Reboot, Shut down; both confirm-gated. |
| Storage | Status per storage, display only. |
$(encoder:recorder_1_state_word) $(encoder:recorder_1_duration_text)
or $(encoder:storage_main_free) updates every poll. Countdown variables such as
$(encoder:event_upcoming_starts_in_hms) are recomputed every poll too, corrected for the encoder's own clock.last_error variable.Channel – Layout, Channel – Publisher (type)). You never need to read or type these ids by hand./api/channels/{id}/layouts endpoints, which work
on all supported firmware versions.GET /channels/{cid}/layouts/{lid}/preview is not part
of Epiphan's published REST API v2.0 specification; it was confirmed working by Epiphan, but as an
unpublished endpoint it could change or be removed in a future firmware update without appearing in
Epiphan's release notes. If that happens the preview simply stops producing an image, like any other
unreachable preview.input_ID_peak_dbfs/_peak_left/_peak_right/_level_text and the Audio meter feedback are filled by
a 500 ms poll of the legacy GET /api/sources/status list (its ids carry a device-serial prefix the v2.0
/inputs ids lack; the module matches them with the prefix stripped). That poll runs only while at least
one Audio meter feedback is on a button of this connection, so the four level variables read empty
otherwise; the regular poll interval never fetches levels. On a device where the endpoint is unavailable
they stay empty rather than erroring.output_ID_source, preset_last_applied and the matching feedbacks therefore only reflect
the last value set through Companion — empty/false after a restart, and stale if changed from the encoder's
web UI or another controller.