| Both sides previous revision Previous revision Next revision | Previous revision |
| onairscreen:manual-en [27.09.2026 02:22] – external edit 127.0.0.1 | onairscreen:manual-en [22.10.2026 19:07] (current) – external edit 127.0.0.1 |
|---|
| # OnAirScreen – User Manual | # OnAirScreen – User Manual |
| |
| **Version:** 1.0.10 | **Version:** 1.1.0 |
| **Author:** Sascha Ludwig, [astrastudio.de](http://www.astrastudio.de) | **Author:** Sascha Ludwig, [astrastudio.de](http://www.astrastudio.de) |
| **Project:** [OnAirScreen](https://www.astrastudio.de/en/onairscreen/) | **Project:** [OnAirScreen](https://www.astrastudio.de/en/onairscreen/) |
| | ---------------- | --------------------------------------------------------------------------- | | | ---------------- | --------------------------------------------------------------------------- | |
| | **General** | Instance name, station, LEDs, clock, logo, fullscreen start | | | **General** | Instance name, station, LEDs, clock, logo, fullscreen start | |
| | **Updates** | Update check, update key, hardware activation | | | **Updates** | Update check, license key, hardware activation | |
| | **Network** | UDP, HTTP, multicast, MQTT, OSC, SNMP | | | **Network** | UDP, HTTP, multicast, MQTT, OSC, SNMP | |
| | **Links** | Discover other OnAirScreens; replicas (1→n full status) and source mappings | | | **Links** | Discover other OnAirScreens; replicas (1→n full status) and source mappings | |
| | Setting | Key | Default | Description | | | Setting | Key | Default | Description | |
| | --------------------- | --------------------------- | --------- | --------------------------------------------- | | | --------------------- | --------------------------- | --------- | --------------------------------------------- | |
| | Check for updates | `General/updatecheck` | `false` | Automatic update check on startup | | | Check for updates | `General/updatecheck` | `false` | Report a new version on startup | |
| | Update Key | `General/updatekey` | *(empty)* | Update key for paid versions (see note below) | | | License Key | `General/updatekey` | *(empty)* | License key for paid versions (see note below) | |
| | Include Beta Versions | `General/updateincludebeta` | `false` | Include beta versions | | | Include Beta Versions | `General/updateincludebeta` | `false` | Include beta versions | |
| |
| |
| > The update feature is intended for **precompiled (paid) versions**. | > Update notices are intended for **precompiled (paid) versions**. |
| > | > |
| > To use update checking in the paid version, an **Update Key** must be entered. You can find it in the customer portal at [customer.astrastudio.de](https://customer.astrastudio.de) after placing your order. One license covers one PC or one Raspberry Pi. The field is masked; use the slashed-eye icon to show it. | > The **License Key** activates this computer. You can find it in the customer portal at [customer.astrastudio.de](https://customer.astrastudio.de) after placing your order. One license covers one PC or one Raspberry Pi. The field is always editable and masked; use the slashed-eye icon to show it. A new version is reported only when **Check for updates** is on. On a paid install, **Install and restart** downloads the package, checks it, quits OnAirScreen, and lets the system installer finish. Windows shows the MSI installer. macOS mounts the downloaded DMG and replaces the app folder. The dialog shows a progress bar while the file downloads. Linux and Raspberry Pi install the `.deb` or `.rpm`, including OnAirScreen that was flashed from the SD-card image. A source checkout only offers the download. Set the environment variable `OAS_FORCE_UPDATE` to offer the newest package again when that version is already installed. |
| |
| |
| Shop builds must be activated. Self-built OpenSource builds are not. | Shop builds must be activated. Self-built OpenSource builds are not. |
| |
| 1. Copy the update key from the customer portal into **Update Key**. | 1. Copy the license key from the customer portal into **License Key**. |
| 2. **Activate** (needs internet) or copy the **Hardware ID**, download a license file in the portal, and **Import license file**. | 2. **Activate** (needs internet) or copy the **Hardware ID**, download a license file in the portal, and **Import license file**. Either success turns **Check for updates** on and saves that. |
| 3. The activation is valid for one year unless your order is set differently. The Updates tab shows whether this computer can renew online now. If the license server is not reachable, download a new license file in the portal and import it before the activation expires. The update key stays the same. You do not buy a new key. | 3. The activation is valid for one year unless your order is set differently. The Updates tab shows whether this computer can renew online now. If the license server is not reachable, download a new license file in the portal and import it before the activation expires. The license key stays the same. You do not buy a new key. |
| 4. To move the license, choose **Return license**, then redeem the return code in the portal (or it is redeemed automatically when this computer is online). Activate the new computer. A dead computer can only be released by astrastudio support. | 4. To move the license, choose **Return license**, then redeem the return code in the portal (or it is redeemed automatically when this computer is online). Activate the new computer. A dead computer can only be released by astrastudio support. |
| 5. Without a license, OnAirScreen runs fully for 14 days. After that it stays visible but cannot go fullscreen, use GPIO or audio meters, or save settings. The window is limited to 1280×800 and the app closes after 15 minutes. The same limits apply when a license has expired. | 5. Without a license, OnAirScreen runs fully for 14 days. After that it stays visible but cannot go fullscreen, use GPIO or audio meters, or save settings. The window is limited to 1280×800 and the app closes after 15 minutes. The same limits apply when a license has expired. |
| 6. At startup the update key is checked with the license server even when **Check for Updates** is off. If the server rejects the key, the license on this computer is removed at once and the same limits apply. Later starts do not repeat that automatic check or the notice. **Check now** still runs. A missing network connection does not remove the license. A new activation checks the key again. | 6. At startup and every 24 hours the license key is checked with the license server, even when **Check for Updates** is off. A new version is reported only when that option is on. If the server rejects the key, the license on this computer is removed at once and the same limits apply. Later automatic checks and the notice are skipped. **Check now** still runs while **Check for Updates** is on. A missing network connection does not remove the license. A new activation checks the key again. |
| |
| If this activation does not fit your use case, contact us via the [contact form](https://www.astrastudio.de/kontakt/). We will work out a custom solution. | If this activation does not fit your use case, contact us via the [contact form](https://www.astrastudio.de/kontakt/). We will work out a custom solution. |
| |
| |
| **Available text clock languages:** English, German, Dutch, French | **Available text clock languages:** English, German, Dutch, French, Spanish |
| |
| **Date format placeholders** (Qt notation, excerpt): | **Date format placeholders** (Qt notation, excerpt): |
| | Enable NTP-Check | `NTP/ntpcheck` | `true` | Warning if time diverges from the NTP server or the server is unreachable | | | Enable NTP-Check | `NTP/ntpcheck` | `true` | Warning if time diverges from the NTP server or the server is unreachable | |
| | NTP Server | `NTP/ntpcheckserver` | `pool.ntp.org` | NTP server for NTP as time source **and** for the optional NTP check | | | NTP Server | `NTP/ntpcheckserver` | `pool.ntp.org` | NTP server for NTP as time source **and** for the optional NTP check | |
| | PTP Interface | `TimeSource/ptp_iface` | *(empty)* | IPv4 address of the PTP network interface (independent of AoIP) | | | PTP Interface | `TimeSource/ptp_iface` | *(empty)* | Interface name (for example `eth0`); the join uses its current IPv4. Independent of AoIP | |
| | PTP Domain | `TimeSource/ptp_domain` | `0` | IEEE 1588 domain (0–255) | | | PTP Domain | `TimeSource/ptp_domain` | `0` | IEEE 1588 domain (0–255) | |
| | LTC Input | `TimeSource/ltc_input` | `serial` | `serial` (LBE-1110) or `audio` (local PortAudio decode) | | | LTC Input | `TimeSource/ltc_input` | `serial` | `serial` (LBE-1110) or `audio` (local PortAudio decode) | |
| | Audio Input | `Audio/input_device` | *(empty)* | PortAudio device name (when source = Local Input) | | | Audio Input | `Audio/input_device` | *(empty)* | PortAudio device name (when source = Local Input) | |
| | Livewire Channel | `Audio/livewire_channel` | `1` | Livewire channel 1–32767 (also via Livewire Source combo) | | | Livewire Channel | `Audio/livewire_channel` | `1` | Livewire channel 1–32767 (also via Livewire Source combo) | |
| | AoIP Interface | `Audio/livewire_iface` | *(empty)* | IPv4 for Livewire/AES67 IGMP join; empty = default | | | AoIP Interface | `Audio/livewire_iface` | *(empty)* | Interface name for the Livewire/AES67 IGMP join; empty = default. The current IPv4 is used | |
| | AES67 Stream ID | `Audio/aes67_id` | *(empty)* | SDP origin hash of the selected stream | | | AES67 Stream ID | `Audio/aes67_id` | *(empty)* | SDP origin hash of the selected stream | |
| | AES67 Address | `Audio/aes67_addr` | *(empty)* | Multicast address used for RTP capture | | | AES67 Address | `Audio/aes67_addr` | *(empty)* | Multicast address used for RTP capture | |
| | Port | `GPIO/lw_port` | `93` | LWRP TCP port | | | Port | `GPIO/lw_port` | `93` | LWRP TCP port | |
| | Password | `GPIO/lw_password` | *(empty)* | Optional LWRP `LOGIN` password | | | Password | `GPIO/lw_password` | *(empty)* | Optional LWRP `LOGIN` password | |
| | AoIP interface | `Audio/livewire_iface` | *(empty)* | IPv4 interface for IGMP (multicast mode; same as Audio Meters) | | | AoIP interface | `Audio/livewire_iface` | *(empty)* | Interface name for IGMP (multicast mode; same as Audio Meters). The current IPv4 is used | |
| | Debounce | `GPIO/lw_debounce_ms` | `50` | Ignore bounce shorter than this (ms) | | | Debounce | `GPIO/lw_debounce_ms` | `50` | Ignore bounce shorter than this (ms) | |
| | GPI*n* Enable | `GPIO/lw_gpiN_enabled` | rows 1–2 on | Use this mapping row | | | GPI*n* Enable | `GPIO/lw_gpiN_enabled` | rows 1–2 on | Use this mapping row | |
| "lra": null, | "lra": null, |
| "instance": "Studio-1", | "instance": "Studio-1", |
| "version": "1.0.10", | "version": "1.1.0", |
| "distribution": "OpenSource", | "distribution": "OpenSource", |
| "link": { "enabled": false, "follow": null, "replicas": [], "peers": 0 } | "link": { "enabled": false, "follow": null, "replicas": [], "peers": 0 } |
| Drag presets for LED1–4 (toggle + colour), AIR1–4 with live caption and time on the button (MIC = AIR1), TOTH, Reset AIR3/4, NOW / NEXT / WARN, Silence, Loudness I+LRA, and Reset I+LRA. | Drag presets for LED1–4 (toggle + colour), AIR1–4 with live caption and time on the button (MIC = AIR1), TOTH, Reset AIR3/4, NOW / NEXT / WARN, Silence, Loudness I+LRA, and Reset I+LRA. |
| |
| Variables such as `$(oas:air1_time)`, `$(oas:lufs_i)`, and `$(oas:lra)` and feedbacks (LED on, AIR running, TOTH, Silence, WARN, Loudness I+LRA) update from WebSocket or the status poll. Set the connection Label to `oas` so those examples match. The connection status shows instance name and version, for example `Studio-1 · 1.0.10`. The module `HELP.md` lists every action, feedback, and variable. | Variables such as `$(oas:air1_time)`, `$(oas:lufs_i)`, and `$(oas:lra)` and feedbacks (LED on, AIR running, TOTH, Silence, WARN, Loudness I+LRA) update from WebSocket or the status poll. Set the connection Label to `oas` so those examples match. The connection status shows instance name and version, for example `Studio-1 · 1.1.0`. The module `HELP.md` lists every action, feedback, and variable. |
| |
| If you cannot load a custom module, **Generic OSC** remains available (next section). Status push over OSC is slower (every 5 seconds) than the HTTP poll / WebSocket. | If you cannot load a custom module, **Generic OSC** remains available (next section). Status push over OSC is slower (every 5 seconds) than the HTTP poll / WebSocket. |
| | `CONF:Audio:input_device=DEVICE_NAME` | Local input device | | | `CONF:Audio:input_device=DEVICE_NAME` | Local input device | |
| | `CONF:Audio:livewire_channel=N` | Livewire channel | | | `CONF:Audio:livewire_channel=N` | Livewire channel | |
| | `CONF:Audio:livewire_iface=IP_OR_EMPTY` | AoIP interface IP | | | `CONF:Audio:livewire_iface=NAME_OR_EMPTY` | AoIP interface name; the join uses that interface's current IPv4 | |
| | `CONF:Audio:aes67_id=ORIGIN_HASH` | AES67 stream id | | | `CONF:Audio:aes67_id=ORIGIN_HASH` | AES67 stream id | |
| | `CONF:Audio:aes67_addr=MULTICAST` | AES67 multicast | | | `CONF:Audio:aes67_addr=MULTICAST` | AES67 multicast | |