CLI-Befehlsreferenz

Lese den Projekt-Datensatz und dessen verbleibendes Guthaben.

project show

Keine Parameter.

screenrig project show

data.credit_remaining ist eine ganze Ganzzahl der Guthaben. Unter 1000 kann der Umschlag eine credits_low-Warnung tragen. Bis zum 1. Januar 2027 ist die Nutzung im Rahmen vernünftig kostenlos, sodass das verbleibende Guthaben ein ganzzahliger Zähler ist, den ein Agent lesen kann, keine Abschaltanweisung.

Legen Sie den Namen fest, den Personen im Dashboard-Projektumschalter sehen.

project rename NAME

Lese den Plan des Projekts, unabhängige screens und advertiser Feature-Flags sowie den effektiven Funktionsumfang. Eine Routenverweigerung hat Vorrang vor einer veralteten Funktionslesung.

project capabilities

Lese die tägliche Bildschirmverfügbarkeit des Projekts über UTC-Tage.

project uptime [--day-from YYYY-MM-DD] [--day-to YYYY-MM-DD]

screenrig project uptime
screenrig project uptime --day-from 2026-09-01 --day-to 2026-09-30

Bereich und Standardwerte entsprechen denen von screen uptime. data.items listet eine Zeile pro UTC-Tag, älteste zuerst: online_s und offline_s summiert über die Bildschirme mit an diesem Tag aufgezeichnetem Status, availability, coverage (der Anteil der Tageszeit dieser Bildschirme mit aufgezeichnetem Status) und screens (wie viele einen Status hatten). Die heutige Zeile umfasst bisher beendete Intervalle; screen list zeigt, wer jetzt online ist.

Lese den Gesundheitszustand der Flotte nach UTC-Stunden: meldende Bildschirme, heiß, Display getrennt, Abstürze.

project health-trend [--from TIME] [--to TIME]

screenrig project health-trend
screenrig project health-trend --from 7d

data.items listet den Zustand der Flotte nach UTC-Stunden: hour, screens_reporting, hot (Spitzentemperatur bei oder über 80 °C), display_disconnected und crashing (3 oder mehr Abstürze in 24 Stunden). Die CLI folgt next_cursor bis zum Ende und antwortet jede Stunde mit next_cursor null. Stunden folgen Berichten um bis zu etwa 5 Minuten.

Erstellen, auflisten oder widerrufen Sie Einladungen für Projektmitglieder und Anzeigenkäufer.

invitations create --email ADDRESS[,ADDRESS] [--kind member|ad-buyer]
invitations create --link
    [--screen-id ID] [--slot-id ID] [--policy trusted|review_required]
invitations list [--kind member|ad-buyer] [--status STATUS]
invitations revoke ID

--kind verwendet standardmäßig member. E-Mail-Zustellung ist Standard und läuft nach sieben Tagen ab. --email akzeptiert durch Kommas getrennte Empfänger, bis zu fünfzig pro Anfrage. --link ist nur für Mitglieder, erfordert genau einen vorgesehenen Empfänger und gibt eine 24-Stunden-Einladungs-URL einmalig für direkte Übergabe zurück. Geben Sie diese URL niemals in Protokolle, Notizen oder ein geteiltes Transkript ein. Listen geben sie nie zurück.

Werbekäufer verwenden nur E-Mail und benötigen einen eigenen Bildschirm- oder Slot-Bereich (oder beides). --screen-id und --slot-id akzeptieren durch Kommas getrennte IDs; --policy wählt trusted oder review_required. Statusfilter sind queued, sent, issued, accepted, revoked, expired und failed.

screenrig invitations create --email teammate@example.com
screenrig invitations create --kind ad-buyer --email buyer@example.com --screen-id scr_LOBBY --policy review_required

Agenten akzeptieren keine Einladungen. Die eingeladene Person öffnet die E-Mail, meldet sich an oder erstellt eine Passkey und akzeptiert im Dashboard. Die Link-Anmeldung überprüft zuerst ihre E-Mail. Das Widerrufen einer akzeptierten Einladung hebt keine Mitgliedschaft auf; verwenden Sie die Käufer-Mitgliedschaftskontrollen, um den Werbezugang zu widerrufen.

Melden, ob diese Installation eine verwendbare Anmeldeinformation enthält.

agent status

Keine Parameter.

screenrig agent status

Nur lesend. Ändert niemals lokalen oder Serverzustand und kostet nichts. Das Ergebnis enthält die Sitzung access, deren effective_access und, wenn die Projektbewertungseinstellung oder ein Mitglied, das nicht genehmigen kann, sie niedriger hält, access_limited_by (project oder person).

Diese Installation mit einem bestehenden Konto anmelden, mit Zustimmung einer Person im Dashboard.

login [--project ID] [--access read|propose|manage] [--name NAME] [--no-wait] [--resume ID]

screenrig login --access read

Gibt die Dashboard-Adresse und einen achtstelligen Code auf stderr aus, wartet dann bis zu 24 Stunden. Die Person prüft, ob der Code übereinstimmt, und drückt einmal Verbinden, ohne dass nach einer Dashboard-Anmeldung in der letzten Stunde eine zweite Passkey-Abfrage erfolgt. Der Umschlag meldet status: signed_in, das Projekt, die Organisation und access. Ein erneutes Ausführen auf einer angemeldeten Installation fügt ein Projekt hinzu oder erhöht von Nur-Lesen oder Vorschlagen auf Verwalten. Ablehnung ist login_denied und Ablauf ist login_expired.

Anmeldung dieser Installation beenden und deren Tokens entfernen.

logout

Keine Parameter.

screenrig logout

Widerruft die Anmeldung auf dem Server, entfernt dann die gespeicherten Tokens und meldet status: signed_out. Ein Fehler, der den Server möglicherweise nicht erreicht hat, behält sie, sodass ein erneutes Ausführen sicher ist. Führen Sie screenrig login aus, um sich erneut anzumelden.

Öffnen Sie die gewöhnliche Dashboard-URL. Dieser Befehl erstellt keinen Anmeldelink, keine Sitzung und benötigt keine Agenten-Anmeldeinformationen.

dashboard [open]

screenrig dashboard

Das Dashboard zeigt die Projekte der Person nach der Anmeldung an. Die Browser-Projektauswahl ändert nicht das an einen Agenten gebundene Projekt.

Anmelderücksetzungs-E-Mail ohne Agenten-Anmeldeinformationen anfordern.

dashboard reset-sign-in --email ADDRESS

Die Bestätigung verrät nicht, ob die E-Mail eine Anmeldung hat. Die per E-Mail gesendete Zurücksetzung läuft nach einer Stunde ab; die Person erstellt einen neuen Passkey. Die Fertigstellung ersetzt ihre Anmeldeinformationen und widerruft andere Sitzungen.

Prüfen Sie diese Installation und melden Sie jede Prüfung mit Namen.

doctor [--repair-config]

screenrig doctor

data.checks benennt jede Prüfung und ihren Status: die Node-Laufzeit, den aufgelösten Konfigurationspfad und dessen Berechtigungen, die Steuerungsebene und ihre Service-Routen, die beworbene feedback-Fähigkeit und die optionale Medientoolkette (ffmpeg, ffprobe, encoder_libx264, encoder_libx265, encoder_libwebp, cwebp, filter_hdr_tonemap).

Jede fehlgeschlagene Prüfung lässt doctor mit einem Nicht-Null-Exit enden, lesen Sie also die einzelnen Namen, bevor Sie die Installation als nicht gesund markieren. Eine fehlende Medientoolchain betrifft nur media upload.

Drucken Sie die gebündelte CLI-Version und ihren Protokolladapter.

version

Keine Parameter.

screenrig version

Führen Sie dies zuerst in einer Sitzung aus. Ein erfolgreiches Envelope beweist, dass der Launcher die gebündelte CLI aufgelöst hat. --version und -V machen dasselbe von überall in der Befehlszeile.

Service-Clients dieses Projekts auflisten, aktiv und widerrufen, mit ihren Schlüsseln, geheimen IDs und Nutzung.

service-client list

Keine Parameter.

screenrig service-client list

Gibt niemals ein Geheimnis zurück.

Einen Service-Client anzeigen.

service-client show ID

screenrig service-client show scl_ID

Jeden Schlüssel kid und jede geheime css_ ID für die Rotation auflisten.

Erstellen Sie einen Service-Client, der diesem Projekt gehört.

service-client create --name NAME [--capability NAME]... [--access read|propose|manage] [--key-file PATH] [--secret-file PATH]

screenrig service-client create --name "Nightly report" --access read --capability reports --key-file screenrig-client.pem

Erfordert die oben beschriebenen Berechtigungen für Identität, Projekt und Organisationsverwaltung. Höchstens 50 aktive Clients pro Organisation, gezählt über alle ihre Projekte. Ein Schlüssel ohne eigenes kid wird durch seinen RFC-7638-Fingerabdruck identifiziert.

Registrieren Sie einen zweiten öffentlichen Schlüssel für eine Rotation ohne Ausfallzeiten.

service-client add-key ID --key-file PATH

screenrig service-client add-key scl_ID --key-file new.pem

Ein Client hält höchstens zwei Schlüssel.

Ein zweites Geheimnis für eine Rotation ohne Ausfallzeit erzeugen.

service-client add-secret ID --secret-file PATH

screenrig service-client add-secret scl_ID --secret-file new-secret

Ein Client hält höchstens zwei Geheimnisse. Das aktuelle funktioniert weiter, bis Sie es entfernen.

Schlüssel entfernen; damit ausgestellte Tokens funktionieren innerhalb von Sekunden nicht mehr.

service-client remove-key ID --kid KID

screenrig service-client remove-key scl_ID --kid KID

Ein Client behält mindestens einen Schlüssel oder ein Geheimnis.

Geheimnis entfernen; damit ausgestellte Tokens funktionieren innerhalb von Sekunden nicht mehr.

service-client remove-secret ID --secret-id css_ID

screenrig service-client remove-secret scl_ID --secret-id css_ID

Einen Service-Client dauerhaft widerrufen.

service-client revoke ID --yes

screenrig service-client revoke scl_ID --yes

Löscht seine Schlüssel und Geheimnisse; seine Tokens funktionieren innerhalb von Sekunden nicht mehr. Der Datensatz bleibt zur Prüfung erhalten.

Ein präsentierbares Vollseiten-Standbild im Medienarchiv des Projekts erzeugen.

media generate --prompt TEXT [--aspect-ratio RATIO] [--quality low|medium|high] [--tag TAG]
               [--no-progress]

screenrig media generate --prompt "A 16:9 restaurant menu poster for North Lobby Cafe. Dark walnut, gold type. Title NORTH LOBBY CAFE. Items: Espresso $4, Cortado $4.50, House Blend $3. Footer Open 7am to 7pm. Typeset every line of copy in the image." --aspect-ratio 16:9 --quality high --tag LobbyMenu

Der Befehl speichert ein verlustbehaftetes WebP im Projekt-Medien-Store und gibt data.media_id (med_…) zurück. Laden Sie die Bytes nicht erneut hoch. Drucken Sie niemals Pixel oder den Prompt. Der Autorbaum und der Prompt-Vertrag befinden sich auf Compose.

Eine lokale Datei in Lieferbytes konvertieren, hochladen und warten, bis das Objekt bereit ist.

media upload <file> [--content-type TYPE] [--tag TAG] [--folder ID] [--no-wait] [--poll-ms MS]
             [--timeout MS] [--no-transcode] [--codec h264|hevc] [--max-fps N]
             [--max-edge PIXELS] [--webp-quality 1-100] [--no-progress]
             [--preset signage-1080p30|signage-4k30] [--no-audio]

screenrig media upload ./lobby-welcome-loop.mp4 --tag LobbyLoop

Video wird standardmäßig zu MP4: H.264 High Profile Level 4.2 oder H.265 mit --codec hevc in yuv420p getaggtem Rec. 709. Eine HDR-Quelle wird auf Rec. 709 tonemapped. Audio, falls vorhanden, ist AAC mit 192 kbit/s, 48 kHz, Stereo.

Standbilder werden bei Qualität 90 zu verlustbehaftetem WebP, wobei Alpha erhalten bleibt, wenn die Quelle es hat. Eine animierte Quelle läuft endlos. Ein WebP, das bereits die Größenbeschränkung erfüllt, wird durchgereicht statt neu codiert.

Audio wird zu einer MP3 für den Playlist-Soundtrack. Eine MP3-Quelle wird unverändert hochgeladen; WAV-, AAC-, M4A-, OGG- und FLAC-Quellen werden in eine 128 kb/s MP3 konvertiert, wofür ein ffmpeg-Build mit libmp3lame benötigt wird. Ein Track läuft von 1 Sekunde bis 3 Stunden. playlist init wandelt Audioeingaben in Soundtrack-Tracks statt Seiten um. Das fertige Objekt ist ein audio Medienobjekt mit einer Dauer. Es kann nicht auf einer Seite platziert werden; benennen Sie es stattdessen in der Playlist audio soundtrack.

Die fertige Objekt-ID ist data.media_id. Derselbe Wert ist data.id und data.operation.result.media_id. Diese ID nimmt ein Playlist-Selektor.

Ein informationsarmer Dateiname wie video.mp4 fügt dem Umschlag eine beratende generic_filename-Warnung hinzu. Der Upload gelingt trotzdem, und die CLI benennt die Datei nie um; wählen Sie den Namen vor dem Ausführen des Befehls.

Konvertierung führt ffmpeg und ffprobe von PATH aus oder von den absoluten Pfaden in SCREENRIG_FFMPEG und SCREENRIG_FFPROBE. Standbilder bevorzugen den ffmpeg libwebp-Encoder und fallen auf cwebp bei PATH oder SCREENRIG_CWEBP zurück. Führen Sie doctor vor dem ersten Upload einer Sitzung aus.

--preset signage-1080p30 begrenzt die lange Kante auf 1920, die kurze Kante auf 1080 und die Rate auf konstante 30 fps. signage-4k30 begrenzt die lange Kante auf 3840, die kurze Kante auf 2160 und die Rate auf konstante 30 fps. Beide funktionieren mit Landschaft, Hochformat und quadratischen Inhalten. --no-audio lässt die Audio-Codierung für stille Clips weg. Diese Optionen gelten nur für Video.

screenrig media upload ./lobby.mov --preset signage-1080p30 --no-audio

screenrig media upload ./menu.png --folder mfd_01EXAMPLEFOLDER000000000

Der Upload landet im Bibliotheksstamm und wird in den Ordner verschoben, sobald er bereit ist. media upload-batch --folder verschiebt jedes hochgeladene Element auf dieselbe Weise.

Unter Vorschlagszugang oder wenn das Projekt eine Überprüfung für Agentenänderungen erfordert, wartet ein neuer Upload auf die Überprüfung durch eine Person, bevor ein Tag, ein Ordner oder ein all-Selektor ihn abspielt; siehe Überprüfungen.

Viele lokale Dateien aus einem Manifest hochladen, Fortsetzung aus einer erforderlichen Statusdatei.

media upload-batch <manifest.json> [--state FILE] [--concurrency N] [--tag TAG] [--folder ID]
                   [--poll-ms MS] [--timeout MS] [--no-transcode] [--codec h264|hevc]
                   [--max-fps N] [--max-edge PIXELS] [--webp-quality 1-100] [--no-progress]
                   [--preset signage-1080p30|signage-4k30] [--no-audio]

screenrig media upload-batch ./images.json --state ./upload-state.json

Der Umschlag enthält data.items[] in Manifestreihenfolge, jeweils mit path, source_filename, sha256, outcome (accepted oder resumed) und media_id. data.failed[] enthält Elemente, die nicht angekommen sind.

Die Datei eines Mediums an Ort und Stelle ersetzen. Seine ID, Playlists und Zeitpläne funktionieren weiter.

media replace <id> <file> [--expect-rev REVISION] [--note TEXT] [--content-type TYPE] [--no-wait]
              [--poll-ms MS] [--timeout MS] [--no-transcode] [--codec h264|hevc] [--max-fps N]
              [--max-edge PIXELS] [--webp-quality 1-100] [--no-progress]
              [--preset signage-1080p30|signage-4k30] [--no-audio]

screenrig media replace med_01EXAMPLEIMAGE0000000000 ./menu-v2.png
screenrig media replace med_01EXAMPLEVIDEO0000000000 ./intro.mp4 --expect-rev 3 --note "Spring cut"

Das Medium behält seine ID, seine Tags und seinen Ordner, sodass jede Playlist und jeder Zeitplan, die es nennen, die neue Datei beim nächsten Manifest abspielen und auch die Selektoren für Tag, Ordner und all sie übernehmen. Nichts wird neu geplant. Der Befehl führt dieselben Schritte aus wie media upload (Konvertierung, Video-Bytelimit des Tarifs, Größenlimits, Speicherkontingent, signierte Übertragung) und ersetzt dann, statt neues Medium hinzuzufügen. Er akzeptiert weder --tag noch --folder.

Standardmäßig wartet der Befehl auf die Verarbeitung. data.media_id und data.id sind die Medien-ID, data.version ist die Nummer der neuen Datei in media versions und data.revision ist die neue Revision des Mediums. data.warnings, data.operation, data.upload, data.transcode und die Zeitangaben werden wie bei media upload gemeldet, und die Operations-ID steht in der Antwort. Mit --no-wait ist data.operation die akzeptierte Operation, und data.version und data.warnings fehlen.

Ein geändertes Seitenverhältnis ist erlaubt. Die Antwort enthält eine Warnung aspect_ratio_changed, und data.warnings[].playlists nennt die Playlists, die das Medium verwenden; prüfen Sie also, wie sie aussehen. Eine Datei mit denselben Bytes wie die aktuelle wird mit resource_conflict abgelehnt (Exit-Code 13).

Jede frühere Datei bleibt im Verlauf des Mediums und zählt zu den gespeicherten Bytes, bis ihre Version gelöscht wird; siehe media versions.

Unter Propose-Zugang oder wenn das Projekt eine Überprüfung für Agentenänderungen verlangt, wartet der Austausch auf eine Person, und der Befehl ist erfolgreich (Exit-Code 0): data.status ist pending_review, data.review_id nennt die Überprüfung, die Warnung pending_review nennt ihre URL, und data.next ist screenrig reviews show ID. Das Medium spielt seine aktuelle Datei weiter ab, bis eine Person freigibt; sagen Sie ihr also, dass es wartet, und wiederholen Sie den Schreibvorgang nicht. Ein neuerer Austausch desselben Mediums ersetzt den wartenden. Siehe Überprüfungen.

Die Dateien auflisten, die ein Medium hatte, die Datei im Einsatz zuerst.

media versions <id> [--limit N] [--cursor CURSOR]

screenrig media versions med_01EXAMPLEIMAGE0000000000

data.items enthält einen Eintrag für jede Datei, die das Medium hatte: number, current, filename, content_type, sha256, bytes, width, height, duration_ms, codecs, source (upload, replace, sync oder restore), note, by (Art person, agent, client oder sync, mit ID und Name) und restored_from. Die Datei im Einsatz steht zuerst (current: true), danach die übrigen, neueste zuerst. Version 1 ist der erste Upload; jeder Austausch, jede Wiederherstellung und jede Änderung durch die Mediensynchronisierung vergibt die nächste Nummer.

Ohne --limit und --cursor werden alle Seiten gelesen, und data.next_cursor ist null. Mit einem von beiden wird eine Seite gelesen: Solange data.next_cursor ein String ist, führen Sie den Befehl erneut aus, wobei --cursor darauf gesetzt wird. Schreibgeschützter Zugang genügt. Die Bytes einer früheren Version bleiben gespeichert und zählen zu den gespeicherten Bytes des Projekts, bis media version delete sie entfernt; es gibt kein Limit, wie viele Versionen aufbewahrt werden, und gespeicherte Bytes über dem kostenlosen Speicher des Tarifs werden wie jeder andere Speicher abgerechnet.

Eine frühere Version als neue Version wieder in Einsatz bringen.

media restore <id> --number N [--expect-rev REVISION] [--note TEXT]

screenrig media restore med_01EXAMPLEIMAGE0000000000 --number 2
screenrig media restore med_01EXAMPLEIMAGE0000000000 --number 2 --expect-rev 5 --note "Back to the winter menu"

Das Medium behält seine ID und erhält eine neue Revision, und jede Playlist und jeder Zeitplan, die es nennen, spielen diese Datei wieder ab. Die kopierte Version bleibt im Verlauf und teilt ihre Bytes; die neue Version zählt wie jede andere zu den gespeicherten Bytes. data.media ist das Medium, und data.warnings enthält aspect_ratio_changed, das die Playlists nennt, die das Medium verwenden, wenn die wiederhergestellte Datei ein anderes Seitenverhältnis hat.

Die Version im Einsatz kann nicht wiederhergestellt werden (resource_conflict, Exit-Code 5), und eine unbekannte Version ist not_found (Exit-Code 4). Unter Propose-Zugang oder wenn das Projekt eine Überprüfung für Agentenänderungen verlangt, wartet die Wiederherstellung auf eine Person, und der Befehl ist erfolgreich (Exit-Code 0): data.status ist pending_review mit data.review, die Warnung pending_review nennt ihre URL, und data.next ist screenrig reviews show ID. Das Medium spielt seine aktuelle Datei weiter ab, bis eine Person freigibt; wiederholen Sie den Schreibvorgang daher nicht.

Eine frühere Version und ihre gespeicherten Bytes löschen.

media version delete <id> --number N

screenrig media version delete med_01EXAMPLEIMAGE0000000000 --number 2

Der Datensatz der Version verschwindet, und ihre Bytes werden sofort von den gespeicherten Bytes des Projekts abgezogen. Das gespeicherte Objekt wird nach 24 Stunden entfernt, sofern nicht eine andere Version oder die Datei im Einsatz dieselbe Datei hält. Eine gelöschte Version kann nicht wiederhergestellt werden. Die Version im Einsatz kann nicht gelöscht werden, und keine Version kann gelöscht werden, solange ein Austausch des Mediums auf Überprüfung wartet; beides ist resource_conflict (Exit-Code 5), und media versions ID zeigt, welche Version im Einsatz ist. Eine unbekannte Version ist not_found (Exit-Code 4). Das Löschen erfordert Manage-Zugang: Ein Propose-Zugangsdatensatz wird mit insufficient_access abgelehnt, und das Löschen wird nie zur Überprüfung vorgeschlagen.

Ein Medienobjekt lesen, einschließlich seiner aktuellen Revision.

media show <id>

screenrig media show med_01EXAMPLEIMAGE0000000000

Schreiben Sie eine gespeicherte Wiedergabe auf die Festplatte zur Inspektion. Drucken Sie niemals die Bytes aus.

media download <id> [--output FILE]

screenrig media download med_01EXAMPLEIMAGE0000000000 --output ./lobby.webp

Der Umschlag meldet media_id, path, bytes, sha256, content_type, primitive, filename, optional source_filename und width / height. Er enthält nie Pixel. Verwenden Sie dies, um ein generiertes Standbild zu prüfen, bevor es auf dem Bildschirm erscheint.

Medienobjekte auflisten, optional gefiltert nach Tag und Typ.

media list [--tag TAG] [--primitive image|video|audio] [--folder ID|root] [--library]

screenrig media list --tag LobbyLoop --primitive video
screenrig media list --folder mfd_01EXAMPLEFOLDER000000000
screenrig media list --library

Jede Zeile trägt folder_id, das an der Bibliothekswurzel fehlt.

Ändern oder löschen Sie das Tag eines Objekts. Seine Verfügbarkeitsregel setzen Sie mit media availability.

media update <id> (--tag TAG | --tags TAG1,TAG2 | --clear-tag) [--expect-rev REVISION]

screenrig media update med_01EXAMPLEIMAGE0000000000 --tag LobbyLoop

Unter Vorschlagszugang oder wenn das Projekt eine Überprüfung für Agentenänderungen erfordert, beantwortet das erneute Taggen genehmigter Medien ok mit der Warnung media_review_pending: Bildschirme spielen es mit seinen genehmigten Tags weiter ab, bis eine Person die Änderung genehmigt, und eine Ablehnung setzt die Tags zurück. Die Überprüfung erscheint innerhalb weniger Sekunden in reviews list; ein erneutes Taggen, das keine genehmigte Playlist und keine Playlist, die auf Überprüfung wartet, ändert, wird automatisch angewendet. Siehe Überprüfungen.

Legt fest oder löscht, wann dynamische Selektoren eine Datei auswählen dürfen.

media availability <id> (--file FILE | --clear) [--expect-rev REVISION]

screenrig media availability med_01EXAMPLEIMAGE0000000000 --file rule.json

Die Bestandteile und das Verhalten der Regel stehen unter Medienverfügbarkeit.

Ein Medienobjekt löschen.

media delete <id> [--expect-rev REVISION]

screenrig media delete med_01EXAMPLEIMAGE0000000000

Mediendateien und Ordner in einen Ordner verschieben oder zurück zum Bibliotheksstamm.

media move <id>... (--folder ID | --root)

screenrig media move med_01EXAMPLEIMAGE0000000000 med_01EXAMPLEVIDEO0000000000 --folder mfd_01EXAMPLEFOLDER000000000
screenrig media move mfd_01EXAMPLEFOLDER000000000 --root

Der Vorgang ist eine Alles-oder-Nichts-Anfrage. Ein Ordner kann nicht in sich selbst oder einen darin enthaltenen Ordner verschoben werden, und Ordner verschachteln sich höchstens 10 Ebenen tief. Elemente, die sich bereits im Ziel befinden, bleiben unverändert. data.media und data.folders zählen, was verschoben wurde.

Das Verschieben von Dateien ändert, was die by:folder-Selektoren ihrer alten und neuen Ordner abspielen, ab der nächsten Auflösung des Selektors jedes Bildschirms; das Verschieben eines Ordners ändert keine Dateien des Ordners selbst. Unter Vorschlag Zugriff oder wenn das Projekt eine Überprüfung für Agentenänderungen erfordert, wartet jede verschobene Datei auf die Überprüfung durch eine Person (reviews list) und genehmigte Playlists spielen sie weiterhin über den Ordner ab, mit dem sie genehmigt wurden; siehe Reviews.

Medienordner des Projekts auflisten.

media folder list [--library]

screenrig media folder list
screenrig media folder list --library

Gibt jeden Ordner des Projekts zurück, höchstens 1000, sortiert nach Name: data.items mit id, name, parent_id (null im Bibliotheksstamm) und revision. Bauen Sie den Baum aus parent_id auf. Der Ordner einer Datei ist folder_id auf media list und media show; er fehlt im Bibliotheksstamm.

Einen Medienordner lesen.

media folder show <id>

screenrig media folder show mfd_01EXAMPLEFOLDER000000000

Der Umschlag enthält die name, parent_id und revision des Ordners.

Erstellen Sie einen Medienordner im Bibliotheksstamm oder in einem anderen Ordner.

media folder create --name NAME [--parent ID]

screenrig media folder create --name Menus
screenrig media folder create --name Lunch --parent mfd_01EXAMPLEFOLDER000000000

Eine Organisation enthält höchstens 1000 Ordner über alle ihre Projekte, verschachtelt bis zu 10 Ebenen tief. Eine Playlist spielt die Dateien eines Ordners mit einem by:folder-Selektor ab.

Einen Medienordner umbenennen oder ihn mit allem Inhalt in einen anderen Ordner verschieben.

media folder update <id> [--name NAME] [--parent ID | --root] [--expect-rev REVISION]

screenrig media folder update mfd_01EXAMPLEFOLDER000000000 --name Archive
screenrig media folder update mfd_01EXAMPLEFOLDER000000000 --root

Ein Ordner kann nicht in sich selbst oder einen darin enthaltenen Ordner verschoben werden, und ein Verschieben muss alle Ordner innerhalb von 10 Ebenen halten. Das Senden der aktuellen Werte ist eine No-Op.

Einen Medienordner löschen. Seine Dateien und Ordner werden eine Ebene höher verschoben.

media folder delete <id> [--expect-rev REVISION]

screenrig media folder delete mfd_01EXAMPLEFOLDER000000000

Löscht nur den Ordner. Seine Dateien und Ordner werden in den übergeordneten Ordner oder in die Bibliothekswurzel verschoben, wenn keiner vorhanden ist. Ein by:folder-Selector, der ihn benennt, trifft dann auf nichts, also weisen Sie diese Playlists zuerst neu zu.

Fügt Ihre eigene Microsoft-Entra-App oder eine Microsoft-Verbindung des Projekts hinzu, damit eine Synchronisierung einen SharePoint- oder OneDrive-for-Work-Ordner lesen kann.

media sync account add microsoft365 --name NAME
    (--tenant-id TENANT --client-id ID --secret-file FILE | --connection-id ID)

screenrig media sync account add microsoft365 --name Contoso --tenant-id contoso.onmicrosoft.com --client-id 0b1d2f3a-4c5e-4f60-8a7b-9c0d1e2f3a4b --secret-file secret.txt
screenrig media sync account add microsoft365 --name Contoso --connection-id pcn_01EXAMPLECONNECTION0000

Registrieren Sie im Microsoft-Entra-Admin-Center eine App mit nur einem Mandanten ohne Weiterleitungs-URI, fügen Sie ein Client-Secret hinzu (kopieren Sie seinen Wert, nicht die Secret-ID), fügen Sie die Microsoft-Graph-Anwendungsberechtigung Sites.Selected hinzu (erteilen Sie der App dann Lesezugriff auf jede Site) oder Files.Read.All und erteilen Sie die Administratorzustimmung. Die App gehört zu diesem Projekt. Führen Sie als Nächstes media sync account test aus.

Fügt ein Dropbox-Konto hinzu und gibt den einmaligen Link aus, den die Person, der das Konto gehört, bei Dropbox angemeldet öffnet, um es zu verbinden.

media sync account add dropbox --name NAME [--app-key KEY]

screenrig media sync account add dropbox --name "Marketing Dropbox"
screenrig media sync account add dropbox --name "Marketing Dropbox" --app-key YOURAPPKEY

data.authorize_url ist der Link und data.authorize_expires_at sein Ablauf. Die CLI öffnet nie einen Browser: Senden Sie den Link an die Person, der das Dropbox-Konto gehört und die den Lesezugriff erlaubt (files.metadata.read, files.content.read, account_info.read). Führen Sie media sync account show aus, bis data.state den Wert ready hat (zu Beginn ist es pending_consent), und dann media sync create dropbox. Ihre eigene Dropbox-App braucht diese aktivierten Berechtigungen und die Redirect-URI, die die Ausgabe nennt.

Fügt ein Google-Drive-Konto hinzu, sofort bereit, und gibt die Dienstkonto-Adresse aus, für die Ordner freigegeben werden.

media sync account add google-drive --name NAME [--key-file FILE]

screenrig media sync account add google-drive --name "Marketing Drive"
screenrig media sync account add google-drive --name "Marketing Drive" --key-file key.json

data.config.service_account_email ist die Adresse, für die jeder Ordner freigegeben wird; Viewer genügt. Über das Dienstkonto von screenRIG wird ein Ordner nur synchronisiert, wenn ein Mitglied dieses Projekts mit verifizierter E-Mail ihn freigegeben hat oder besitzt (sonst media_sync_sharer_not_member). Mit Ihrem eigenen Schlüssel wird jeder für das Dienstkonto freigegebene Ordner synchronisiert.

Listet die Konten der Mediensynchronisierung dieses Projekts mit Art, Zustand und letztem Test auf; es wird kein Secret zurückgegeben.

media sync account list

Keine Parameter.

screenrig media sync account list

Zeigt ein Konto: seinen Mandanten und die Client-ID, den Zustand, das maskierte Secret und den letzten Test.

media sync account show <id>

screenrig media sync account show msa_01EXAMPLEACCOUNT0000000

Ein Dropbox-Konto zeigt zusätzlich, wer es verbunden hat, sowie app_key; ein Google-Drive-Konto zeigt zusätzlich service_account_email.

Benennt ein Konto um, ändert Mandant, Anwendungs-ID oder Client-Secret einer Microsoft-App oder ersetzt den eigenen Schlüssel eines Google-Drive-Kontos.

media sync account update <id> [--name NAME] [--tenant-id TENANT] [--client-id ID]
    [--secret-file FILE | --key-file FILE] [--expect-rev REVISION]

screenrig media sync account update msa_01EXAMPLEACCOUNT0000000 --secret-file new-secret.txt
screenrig media sync account update msa_01EXAMPLEACCOUNT0000000 --name "Contoso tenant" --expect-rev 2

Mindestens eine Änderung ist erforderlich. Eine Änderung der Zugangsdaten löscht last_test: Testen Sie das Konto erneut. Client-Secrets von Entra laufen ab, ersetzen Sie das Secret hier also, bevor es so weit ist.

Erzeugt einen neuen einmaligen Link, um ein Dropbox-Konto zu verbinden oder erneut zu verbinden.

media sync account connect <id>

screenrig media sync account connect msa_01EXAMPLEACCOUNT0000000

data.authorize_url und data.authorize_expires_at tragen den Link, der den früheren ersetzt. Senden Sie ihn an die Person, der das Dropbox-Konto gehört. Verwenden Sie ihn, wenn die Person den Vorgang nicht abgeschlossen hat oder das Konto reconnect_required ist (Dropbox erkennt die Verbindung nicht mehr an). Ein verbundenes Konto bleibt verbunden, bis die neue Zustimmung abgeschlossen ist, und ein anderes Dropbox-Konto, das sich anmeldet, übernimmt die Verbindung.

Prüft ein Konto: die Anmeldung und die Graph-Berechtigungen einer Microsoft-App oder die Verbindung oder den Schlüssel eines Dropbox- oder Google-Drive-Kontos.

media sync account test <id>

screenrig media sync account test msa_01EXAMPLEACCOUNT0000000

Die Antwort wird als last_test gespeichert. Bei einer Microsoft-App meldet der Test credentials (Microsoft hat ein Token ausgestellt; eine Ablehnung trägt den AADSTS-Code, etwa AADSTS7000215 für ein Secret, das die ID statt des Werts ist) und permissions (die Graph-Anwendungsberechtigungen, die das Token trägt). Sites.Selected allein ist eine Warnung: Jede Site braucht weiterhin ihre Freigabe, und ein Freigabelink braucht Files.Read.All. Der Test beurteilt weder die Freigabe einer Site noch einen Ordner: media sync create liest den Ordner, den Sie nennen. Eine fehlgeschlagene Prüfung ist data.ok false mit Exit 0.

Löscht ein Konto, das keine Synchronisierung nutzt.

media sync account delete <id> [--expect-rev REVISION]

screenrig media sync account delete msa_01EXAMPLEACCOUNT0000000

Solange Synchronisierungen das Konto nutzen, lautet die Antwort resource_conflict (Exit 5) und nennt sie: Löschen Sie diese zuerst.

Synchronisiert einen SharePoint- oder OneDrive-for-Work-Ordner in einen Medienordner.

media sync create sharepoint --account-id ID --url URL [--folder-id ID] [--every DURATION] [--name NAME]

screenrig media sync create sharepoint --account-id msa_01EXAMPLEACCOUNT0000000 --url https://contoso.sharepoint.com/sites/Marketing/Shared%20Documents/Lobby%20Signs
screenrig media sync create sharepoint --account-id msa_01EXAMPLEACCOUNT0000000 --url "https://contoso.sharepoint.com/:f:/s/Marketing/EabcDEF" --folder-id mfd_01EXAMPLEFOLDER000000000 --every 1h --name "Lobby signs"

Ein Ordner, den Microsoft ablehnt, ist media_sync_source_refused (Exit 5), mit der zu erteilenden Berechtigung; es wird nichts gespeichert.

Synchronisiert einen Dropbox-Ordner in einen Medienordner.

media sync create dropbox --account-id ID --url URL|PATH [--folder-id ID] [--every DURATION] [--name NAME]

screenrig media sync create dropbox --account-id msa_01EXAMPLEACCOUNT0000000 --url https://www.dropbox.com/home/Marketing/Lobby%20Signs
screenrig media sync create dropbox --account-id msa_01EXAMPLEACCOUNT0000000 --url /Marketing/Lobby --folder-id mfd_01EXAMPLEFOLDER000000000 --every 1h --name "Lobby signs"

Jeder Lauf setzt an der von Dropbox gespeicherten Position im Ordner fort und liest nur, was sich geändert hat. Ein Ordner, den das Konto nicht öffnen kann, ist media_sync_source_refused, und eine Verbindung, die Dropbox nicht mehr anerkennt, ist dropbox_reconnect_required (media sync account connect): beide mit Exit 5, nichts wird gespeichert.

Synchronisiert einen Google-Drive-Ordner, der für das Dienstkonto eines Kontos freigegeben ist, in einen Medienordner.

media sync create google-drive --account-id ID --url URL|ID [--folder-id ID] [--every DURATION] [--name NAME]

screenrig media sync create google-drive --account-id msa_01EXAMPLEACCOUNT0000000 --url https://drive.google.com/drive/folders/1AbCdEfGhIjKlMnOpQrStUvWxYz --folder-id mfd_01EXAMPLEFOLDER000000000 --every 1h
screenrig media sync create google-drive --account-id msa_01EXAMPLEACCOUNT0000000 --url 1AbCdEfGhIjKlMnOpQrStUvWxYz

Über das Dienstkonto von screenRIG wird der Ordner nur synchronisiert, wenn ein Mitglied dieses Projekts mit verifizierter E-Mail ihn freigegeben hat oder besitzt (media_sync_sharer_not_member, Exit 3, nichts wird gespeichert). Jeder Lauf prüft das erneut, und ein Ordner, der einen solchen Freigeber verliert, stoppt die Synchronisierung im Zustand error, wobei ihre Medien erhalten bleiben: Geben Sie ihn erneut über das Google-Konto eines Mitglieds frei und führen Sie dann media sync update ID --resume aus. Dateien aus Google Docs, Sheets und Slides werden als unsupported_type übersprungen. Ein Ordner, den die Adresse nicht öffnen kann, ist media_sync_source_refused (Exit 5): Geben Sie ihn für das Dienstkonto frei.

Listet die Mediensynchronisierungen dieses Projekts mit Medienordner, Rhythmus, Zustand und Status des letzten Laufs auf.

media sync list

Keine Parameter.

screenrig media sync list

Zeigt eine Synchronisierung und die Zusammenfassung ihres letzten Laufs.

media sync show <id>

screenrig media sync show msy_01EXAMPLESYNC000000000

data.last_run enthält status (ok, partial oder error), added, updated, removed, pending_delete (entfernte Dateien, die ein Bildschirm noch hält und die im Ordner Removed warten) und skipped mit dem Grund jeder Datei (unsupported_type, too_large, storage, subfolder, download_failed, unreadable, in_use); ein fehlgeschlagener Lauf enthält error mit einem code und einem detail, die die Behebung nennen. data.source fügt path für Dropbox und shared_by für Google Drive hinzu.

Eine Synchronisierung im Zustand error muss repariert werden. Ihr Medienordner wurde gelöscht: Richten Sie sie mit media sync update --folder-id auf einen anderen aus. Ihr Quellordner wurde gelöscht oder verschoben: Löschen Sie die Synchronisierung und legen Sie eine neue an. Bei Google Drive über das Dienstkonto von screenRIG hat der Ordner seinen verifizierten Freigeber verloren (sharer_not_member): Geben Sie ihn erneut über das Google-Konto eines Projektmitglieds frei und führen Sie dann media sync update ID --resume aus. Ein Dropbox-Lauf schlägt mit reconnect_required fehl, wenn Dropbox die Verbindung nicht mehr anerkennt (media sync account connect).

Ändert Name, Rhythmus oder Medienordner einer Synchronisierung oder pausiert und setzt sie fort.

media sync update <id> [--name NAME] [--every DURATION] [--folder-id ID]
    [--pause | --resume] [--expect-rev REVISION]

screenrig media sync update msy_01EXAMPLESYNC000000000 --every 1h
screenrig media sync update msy_01EXAMPLESYNC000000000 --pause
screenrig media sync update msy_01EXAMPLESYNC000000000 --folder-id mfd_01EXAMPLEFOLDER000000000 --expect-rev 3

Mindestens eine Änderung ist erforderlich.

Führt eine Synchronisierung jetzt statt zu ihrem nächsten Zeitpunkt aus.

media sync run <id>

screenrig media sync run msy_01EXAMPLESYNC000000000

Die Synchronisierung läuft innerhalb von etwa 30 Sekunden, und media sync show zeigt dann ihren letzten Lauf. Eine pausierte Synchronisierung muss zuerst fortgesetzt werden.

Stoppt eine Synchronisierung; ihre Medien und ihr Ordner bleiben erhalten.

media sync delete <id> [--expect-rev REVISION]

screenrig media sync delete msy_01EXAMPLESYNC000000000

Die Synchronisierung vergisst, welche Quelldatei zu welchem Medium wurde. Die importierten Medien und der Medienordner bleiben erhalten, und nichts wird entfernt.

Packen Sie ein statisches Verzeichnis in ein deterministisches Archiv, ohne es hochzuladen.

app pack <directory> [--output FILE]

screenrig app pack ./lobby-board --output ./lobby-board.tgz

Der Umschlag meldet sha256, compressed_bytes, expanded_bytes, file_count, die Eintragsliste und ob die SDK-Laufzeit injiziert wurde. app upload packt das Verzeichnis selbst, greifen Sie also nur zu diesem Befehl, wenn Sie das Archiv zuerst inspizieren wollen.

Anwendungen laufen unter einer Content-Security-Policy, die Inline-Code blockiert. Packing verschiebt Inline-Style- und Script-Blöcke in Dateien unter _screenrig/inline/ und verlinkt sie. Inline-Event-Handler wie onclick= und javascript: URLs können nicht verschoben werden; Packing lehnt sie ab und nennt Datei und Zeile.

Packen Sie ein Verzeichnis, veröffentlichen Sie es als neue Anwendungsfreigabe und warten Sie, bis die Veröffentlichung erfolgreich ist.

app upload <directory> [--name NAME] [--no-wait] [--poll-ms MS] [--timeout MS]

screenrig app upload ./lobby-board --name "Lobby board"

Lese drei Felder: data.operation.state ist succeeded, data.application.release_id ist die rel_ ID, ein application Primitive pinnt, und data.application.id ist die app_ ID, die kv Befehle verwenden. Ein erfolgreicher Vorgang, nicht eine Release-ID allein, bedeutet, dass die Veröffentlichung nutzbar ist.

Jede app upload erstellt eine neue Anwendung und eine erste unveränderliche Version. Um eine spätere Version derselben App zu veröffentlichen, verwenden Sie app update. Eine Playlist bedient weiterhin die Version, die sie bereits festhält, bis Sie dieses Primitive bearbeiten.

Eine neue Version einer bestehenden Anwendung veröffentlichen und dabei Identität, Namen und Anwendungsschlüssel/Wert erhalten.

app update <id> <directory> [--expect-rev REVISION] [--no-wait] [--poll-ms MS]

screenrig app update app_01EXAMPLEAPP00000000000 ./lobby-board

Warten Sie auf data.operation.state: "succeeded" und verwenden Sie dann playlist replace-release, um die genaue Seite, das Primitive, die neue Version und die betroffenen Bildschirme zu überprüfen. Wenden Sie dies mit dem zurückgegebenen Impact-Token und einer optionalen Revisionssperre wie im Playlist-Workflow beschrieben an. Bestehende Playlist-Pins bleiben bis zur Anwendung unverändert. Bei einem Revisionskonflikt lesen Sie die App erneut, bevor Sie entscheiden, ob Sie es erneut versuchen; erstellen Sie keine Ersatzanwendung, nur um den Konflikt zu umgehen.

Anwendungen des Projekts auflisten.

app list

Keine Parameter.

screenrig app list

Eine Anwendung lesen.

app show <id>

screenrig app show app_01EXAMPLEAPP00000000000

latest_ready_release fehlt, bis eine erste Veröffentlichung bereit ist. Der Veröffentlichungsstatus lebt auf der Operation und der Version, nicht auf der Anwendung.

Eine Anwendung und alle ihre Releases löschen.

app delete <id> [--expect-rev REVISION]

screenrig app delete app_01EXAMPLEAPP00000000000

Es gibt kein Löschverfahren pro Release. Solange ein Bildschirm eine der Releases der Anwendung zeigt, antwortet das Löschen mit application_in_use: Geben Sie diesen Bildschirmen zuerst andere Inhalte. Das Löschen prüft keine Playlists, die eine Release anheften, ohne sie anzuzeigen, aktualisieren oder löschen Sie daher auch diese Playlists.

Für eine Anwendung gespeicherte Schlüssel auflisten.

kv list --app-id ID

screenrig kv list --app-id app_01EXAMPLEAPP00000000000

Einen Schlüssel lesen.

kv get --app-id ID <key>

screenrig kv get --app-id app_01EXAMPLEAPP00000000000 menu

Schreiben Sie einen Schlüssel aus JSON, einer Datei oder Base64-Bytes.

kv set --app-id ID <key> --json-value JSON [--expect-rev REVISION]
kv set --app-id ID <key> --file FILE [--content-type TYPE] [--expect-rev REVISION]
kv set --app-id ID <key> --value-base64 BASE64 [--content-type TYPE] [--expect-rev REVISION]

screenrig kv set --app-id app_01EXAMPLEAPP00000000000 menu --json-value '{"soup":"lentil"}'

Einen Schlüssel löschen.

kv delete --app-id ID <key> [--expect-rev REVISION]

screenrig kv delete --app-id app_01EXAMPLEAPP00000000000 menu

Erstellen Sie einen Webhook, der einen Schlüssel schreibt, und erhalten Sie dessen URL und Geheimnis einmalig.

kv webhook create <key> --app-id ID [--description TEXT]

screenrig kv webhook create menu --app-id app_01EXAMPLEAPP00000000000 --description "Point of sale menu feed"

Der Umschlag ist der Webhook: data.id (kvw_…), data.key, data.url (https://api.screenrig.ai/api/applications/<app_id>/kv-webhooks/<id>/write) und data.secret (srkw_…). Geben Sie die URL und das Geheimnis jetzt im sendenden System ein. Kein späterer Befehl zeigt dieses Geheimnis erneut an.

Webhooks einer Anwendung auflisten, älteste zuerst.

kv webhook list --app-id ID

screenrig kv webhook list --app-id app_01EXAMPLEAPP00000000000

Jedes Element hat id, key, description, url, created_at und, sobald es geschrieben wurde, last_used_at. Eine Liste enthält niemals ein Geheimnis.

Einen Webhook löschen. Seine URL funktioniert sofort nicht mehr, der Schlüssel behält seinen Wert.

kv webhook delete <webhook_id> --app-id ID

screenrig kv webhook delete kvw_01EXAMPLEWEBHOOK00000 --app-id app_01EXAMPLEAPP00000000000

Geheimnis eines Webhooks ersetzen und das neue einmal erhalten.

kv webhook rotate-secret <webhook_id> --app-id ID

screenrig kv webhook rotate-secret kvw_01EXAMPLEWEBHOOK00000 --app-id app_01EXAMPLEAPP00000000000

Der Umschlag enthält das neue Geheimnis in data.secret. Das alte Geheimnis funktioniert sofort nicht mehr, daher geben Sie das neue im sendenden System ein.

Einen Karten-Webhook ändern: Beschreibung, Mapping, Aktivierungsstatus oder Signierung.

kv webhook update <webhook_id> --card CARD_ID [--description TEXT] [--map FILE|-] [--clear-map]
                   [--enable|--disable] [--signing|--no-signing]

screenrig kv webhook update kvw_01EXAMPLEWEBHOOK00000 --card crd_01EXAMPLEBOARD0000000000 --map alert-map.json

Der Umschlag ist der Webhook. data.signing_secret erscheint einmal, in der Antwort, die die Signierung eingeschaltet hat.

Das Zustellungsprotokoll eines Karten-Webhooks lesen, neueste zuerst, für die letzten sieben Tage.

kv webhook deliveries <webhook_id> --card CARD_ID [--limit N]

screenrig kv webhook deliveries kvw_01EXAMPLEWEBHOOK00000 --card crd_01EXAMPLEBOARD0000000000

Jeder Eintrag hat at, outcome (written, unchanged, refused, invalid oder handshake), reason (zum Beispiel credentials, signature, disabled, body, mapping, card_data_invalid oder rate_limited), detail, status, bytes, revision und request_id. Weder Body noch Header noch Zugangsdaten werden gespeichert, und eine Zustellung an eine falsche Adresse hinterlässt keine Zeile.

Eine bearbeitbare Vollbild-Playlist aus lokalen Mediendateien, fertigen Medien-IDs, Anwendungsfreigabe-IDs oder HTTP- oder HTTPS-URLs vorbereiten.

playlist init <inputs...> --name NAME --output FILE [--overwrite] [--screen-id ID]
              [--target-width PX --target-height PX] [--duration-ms MS] [--fit contain|cover|fill]
              [--no-transcode] [--no-progress] [--poll-ms MS]

screenrig playlist init med_POSTER med_VIDEO --name "Lobby loop" --screen-id scr_LOBBY --output lobby.json

Die Vorbereitung schreibt das lokale Dokument und kann Medien hochladen; sie erstellt weder eine entfernte Playlist noch weist sie einen Bildschirm zu. Dokument prüfen, dann screen publish. Siehe Playlists vorbereiten, veröffentlichen und bearbeiten.

Validieren Sie ein Playlist-Dokument lokal vor Erstellung oder Aktualisierung. Kein Netzwerk erforderlich.

playlist validate <file>

screenrig playlist validate ./lobby-loop.json

Fehler benennen exakte JSON-Pfade. Ein Bestehen bedeutet, dass lokale Form und feldübergreifende Semantik gültig sind; Autorisierung, Medienbereitschaft, dynamische Selektoranzahlen, Dauern und entfernte Verfügbarkeit erfordern weiterhin Serverprüfungen. Erstellen und Aktualisieren führen diese Prüfung vor dem Schreiben aus. Das Ergebnis enthält außerdem lint-Befunde zur Geometrie, die die Prüfung nicht fehlschlagen lassen: motion_overuse, collision, safe_margin und adjacent_repeat. Um zu sehen, wie eine Seite aussieht, veröffentlichen Sie sie und führen Sie screen screenshot aus.

Eine Playlist aus einem JSON-Dokument, aus einer Vorlage oder aus der integrierten Vorlage „Dringende Mitteilung“ erstellen.

playlist create [file] [--from-template ID --name NAME [--set NAME=VALUE...] [--dry-run]] [--starter KEY [--name NAME]] [--format-region REGION --format-orientation ORIENTATION] [--note TEXT]

screenrig playlist create ./lobby-loop.json

screenrig playlist create --from-template pl_01EXAMPLETEMPLATE00000 --name "Monday notice" --set headline="Open late"

data.id der Antwort ist die pl_-ID, die screen assign erwartet. Wartet die Änderung auf Prüfung, ist data gleich {status: pending_review, review, playlist}: Die Playlist existiert mit approved_revision: 0, und kein Bildschirm kann sie zeigen, bis eine Person genehmigt (playlist_not_approved). Eine Vorlage ist eine Playlist, die fields deklariert; sie wird nie auf einem Bildschirm gezeigt (playlist_is_template), und eine daraus erstellte Playlist ist eine gewöhnliche, die sich zuweisen, planen und überarbeiten lässt.

Ein Playlist-Dokument ersetzen.

playlist update <id> <file> [--format-region REGION --format-orientation ORIENTATION] [--expect-rev REVISION] [--note TEXT]

screenrig playlist update pl_01EXAMPLEPLAYLIST000000 ./lobby-loop.json

Wenn die Änderung auf Überprüfung wartet, wird die Live-Playlist unverändert weiter abgespielt, bis eine Person den Vorschlag genehmigt.

Eine Playlist lesen, einschließlich ihrer aktuellen Revision.

playlist show <id>

screenrig playlist show pl_01EXAMPLEPLAYLIST000000

Sie gibt die Live-Version zurück. approved_revision ist 0 für eine Playlist, die noch keine Person genehmigt hat, und approval nennt die offene Überprüfung, während eine Änderung wartet; reviews show ID gibt den Vorschlag zurück.

Playlists des Projekts auflisten.

playlist list [--templates] [--library]

screenrig playlist list --templates
screenrig playlist list --library

Die Felder einer Vorlage oder die Werte einer Kopie anzeigen, oder die Werte ändern und die Kopie auf den neuesten Stand bringen.

playlist fields <id> [--set NAME=VALUE...] [--clear NAME...] [--refresh] [--expect-rev REVISION] [--note TEXT]

screenrig playlist fields pl_01EXAMPLECOPY00000000 --set headline="Closed today"

Ohne Optionen zeigt es die Felder einer Vorlage und wie viele Playlists daraus erstellt wurden, oder die Werte einer Kopie, die Vorlagenversion, aus der sie erstellt wurde, und ob die Vorlage eine neuere hat. Jede Änderung und --refresh allein erstellt die Seiten der Kopie neu aus der aktuellen Version der Vorlage; so erreicht eine Markenänderung an der Vorlage bestehende Kopien, nichts wird automatisch übertragen. Werte werden wie beim Erstellen geprüft. Mit Propose-Zugriff wird eine Änderung zur Prüfung.

Die aus einer Vorlage erstellten Playlists und die Vorlagenversion, aus der jede erstellt wurde, auflisten.

playlist instances <id>

screenrig playlist instances pl_01EXAMPLETEMPLATE00000

outdated kennzeichnet eine Playlist, die aus einer älteren Version der Vorlage erstellt wurde; playlist fields ID --refresh bringt sie auf den neuesten Stand.

Die Revisionen einer Playlist auflisten, die neueste zuerst.

playlist revisions <id> [--after CURSOR]

screenrig playlist revisions pl_01EXAMPLEPLAYLIST000000

Jede Revision nennt, was sie erzeugt hat (created, edited, promoted mit der kopierten Revision oder baseline, die Revision, die die Playlist hatte, als ihr Verlauf begann), wer sie erstellt hat, wann, wie viele Seiten sie enthält und ob sie aktuell ist. Eine Seite enthält 50 Revisionen; next_cursor liest die nächste.

Eine Revision lesen und die Playlist, wie sie zu diesem Zeitpunkt war.

playlist revision show <id> --revision N

screenrig playlist revision show pl_01EXAMPLEPLAYLIST000000 --revision 3

Eine frühere Revision wieder aktuell machen, indem sie als neue Revision übernommen wird.

playlist promote <id> --revision N --expect-rev CURRENT

screenrig playlist promote pl_01EXAMPLEPLAYLIST000000 --revision 3 --expect-rev 9

Seiten, Soundtrack und Format der Revision werden zur nächsten Revision. Der Name bleibt, frühere Revisionen bleiben in der Liste, und jeder Bildschirm, der die Playlist zeigt, wird aktualisiert. Das Hochstufen braucht eine Berechtigung, die live veröffentlicht; eine, deren Änderungen auf eine Prüfung warten, erhält forbidden. Eine Revision, deren Inhalt bereits aktuell ist, ändert nichts.

Eine Playlist löschen.

playlist delete <id> [--expect-rev REVISION]

screenrig playlist delete pl_01EXAMPLEPLAYLIST000000

Bild- und Videodateien, Soundtrack-Audio und iframe-URLs als portables Playlist-Bundle exportieren.

playlist export <id> --output DIRECTORY [--skip-applications]

screenrig playlist export pl_01EXAMPLEPLAYLIST000000 --output ./lobby-bundle

Das Bundle enthält ein Manifest, das Playlist-Dokument und inhaltsadressierte Bild-, Video- und Soundtrack-Audiodateien. Dynamische Selektoren all, tag und folder werden als exakte IDs festgehalten, iframe-URLs bleiben erhalten und Kommentare sind ausgeschlossen.

Karten, Streams und adslot-Seiten stoppen den Export vor dem Download der Medien. Anwendungen stoppen ihn ebenfalls standardmäßig; --skip-applications entfernt Anwendungsprimitive sowie leere oder von Anwendungen gesteuerte Seiten und meldet die IDs der übersprungenen Primitive und Seiten. Mindestens eine Seite muss übrig bleiben. Karten, Streams und adslot-Seiten stoppen den Export auch mit dieser Option.

Für ein bearbeitbares Dokument, das Karten- und Anwendungsreferenzen beibehält, verwenden Sie screenrig playlist show pl_01EXAMPLEPLAYLIST000000 --output playlist.json. Das Dokument verwendet vorhandene Ressourcen desselben Projekts.

Erstellen Sie eine Playlist aus einem Bundle-Verzeichnis oder aktualisieren Sie eine bestehende daraus.

playlist import <directory> [--name NAME] [--update ID [--expect-rev REVISION] [--note TEXT]]

screenrig playlist import ./lobby-bundle
screenrig playlist import ./lobby-bundle --name "Lobby loop (copy)"

Anzeigenamen von Playlists können sich wiederholen. Import erstellt eine separate Playlist, auch wenn der Name übereinstimmt; verwenden Sie --update mit einer ID, um eine vorhandene Playlist zu ersetzen.

Import validiert das gesamte Bundle lokal, bevor es das Projekt berührt: Manifest, Dokument, Pfade, Medientypen, Längen und Hashes. Bestehende Medien werden bei exaktem Dateinamen-, Medientyp-, Byte-Längen-, Hash- und Tag-Abgleich wiederverwendet; der Rest wird ohne Konvertierung hochgeladen, und die Playlist wird erst geschrieben, wenn jedes Objekt bereit ist.

Import löscht oder kürzt entfernte Medien niemals. Wenn ein späterer Schritt nach Beginn eines Uploads fehlschlägt, listet der Fehler die bestätigten bereiten Objekte auf und gibt an, ob der Playlist-Schreibvorgang begonnen hat. Ein erneuter Versuch desselben Bundles verwendet diese Objekte wieder.

Koppeln Sie einen Player mit dem auf seinem Bildschirm angezeigten Code.

screenrig screen pair "$PAIRING_CODE" --name "Lobby"

Bildschirme auflisten. Archivierte Bildschirme werden ausgelassen, es sei denn, Sie fordern sie an.

screen list [--state archived] [--tag TAG] [--folder ID|root]

screenrig screen list --tag Lobby
screenrig screen list --folder sfd_01EXAMPLEFOLDER000000000

Jede Zeile trägt die tags des Bildschirms. Mit --human fügt die Tabelle eine TAGS-Spalte hinzu, wenn ein aufgelisteter Bildschirm Tags hat.

Einen Bildschirm lesen, einschließlich Revision, Zuordnung und Aktivität.

screen show <id>

screenrig screen show scr_01EXAMPLESCREEN00000000

tags listet die Flotten-Tags des Bildschirms. effective_playlist, takeover und playlist_schedule berichten, was der Bildschirm abspielt und warum; siehe Zeitpläne und Übernahmen. health und die Host-Fähigkeiten des Players sind in Gerätezustand und Stromversorgung. online ist wahr, solange ein Player verbunden ist, einschließlich eines kurzen Wiederverbindungsfensters. Optionale last_online_at und last_ip erscheinen nach der ersten Verbindung. Optionales observation meldet die Oberflächen, die ein Player gezeichnet hat: id, width, height, pixel_ratio und presentation. Alle diese sind schreibgeschützt; screen update kann sie nicht senden, und ein archivierter Bildschirm liefert seine Zeile weiterhin zurück.

commands listet die letzten 10 Neustarts, Neuladevorgänge, Cache-Leerungen, App-Neustarts und Updates des Bildschirms auf, den ältesten zuerst, jeweils mit seinem type, seinem state (queued, sent, done, failed, expired, cancelled oder superseded), seinem source (schedule für einen Neustart, den ein Neustartplan ausgelöst hat; fehlt bei einem, den eine Person angefordert hat), seinem expires_at und wann er gesendet oder ausgeführt wurde. reboot_schedule und next_reboot_at melden den Neustartplan des Bildschirms und den Beginn seines nächsten Neustartfensters. Eine Cache-Leerung, ein App-Neustart oder ein Update, die der Player beendet hat, enthält außerdem cause und eine kurze detail, die --human als Spalte CAUSE und als Zeile unter der Tabelle ausgibt. suspension enthält message und since eines ausgesetzten Bildschirms. Ein von screen replace archivierter Bildschirm meldet replaced_by, den Bildschirm, auf den sein Gerät umgezogen ist. Mit --human gibt screen show jeden davon aus.

last_outage meldet den letzten Ausfall des Bildschirms: offline_since, back_at und duration_s und, sobald ein Zustandsbericht sie festlegt, eine likely_cause aus device_restart, app_crash, app_restart, network oder platform; sie fehlt, wenn screenRIG sie nicht bestimmen kann. Ein Neustart wird festgelegt, sobald der Bildschirm zurückkehrt, während eine Netzwerk- oder screenRIG-Ursache auf den nächsten Zustandsbericht des Players wartet, was bis zu fünfzehn Minuten dauern kann. glass enthält die Urteile, die screenRIG aus den Wiedergabeberichten und Screenshots des Bildschirms gezogen hat. Mit --human gibt screen show Last outage und Likely cause sowie Playlist stalled, Blank screen oder Frozen picture für ein Urteil aus, das ein Problem gefunden hat; Benachrichtigungen sagt, was die Urteile nicht beurteilen.

Ändern Sie den Namen, die Playlist-Zuweisung oder die Zeitzone eines Bildschirms in einem Aufruf.

screen update <id> [--name NAME] [--playlist-id ID] [--timezone ZONE] [--expect-rev REVISION]

screenrig screen update scr_01EXAMPLESCREEN00000000 --name "Lobby"

Unter Überprüfung wird eine Änderung von --playlist-id allein wie screen assign vorgeschlagen; eine Vorschlags-Sitzung kann die anderen Felder nicht ändern.

Erstellen Sie eine neue Playlist aus einer vorbereiteten Datei und weisen Sie sie einem Bildschirm zu.

screen publish <id> <file> [--expect-rev REVISION] [--note TEXT]

screenrig screen publish scr_LOBBY lobby.json

Dies erstellt eine neue Playlist und weist sie zu. Es aktualisiert keine bestehende Playlist nach Namen. Prüfen Sie zuerst das vorbereitete Dokument. Wiederholen Sie identische Eingaben, um einen mehrdeutigen Fehler fortzusetzen. Die Rückmeldung der Zuweisung beweist keine Wiedergabe; fordern Sie einen Screenshot separat an. Bei Überprüfung gibt es stage: pending_review mit beiden Bewertungen zurück. Siehe Playlists vorbereiten, veröffentlichen und bearbeiten.

Weisen Sie einem Bildschirm oder einer Flotte von Bildschirmen eine Playlist zu.

screen assign (<id>... | --tag TAG) --playlist-id ID [--expect-rev REVISION] [--note TEXT]

screenrig screen assign scr_01EXAMPLESCREEN00000000 --playlist-id pl_01EXAMPLEPLAYLIST000000
screenrig screen assign --tag Lobby --playlist-id pl_01EXAMPLEPLAYLIST000000

Wenn die Playlist eine Seite plant und der Bildschirm keine Zeitzone hat, verweigert die CLI das Senden und nennt den screen set-timezone-Befehl zum Ausführen. Keine Revision wird durch diese Verweigerung verbraucht. In einer Flotte wendet jeder Bildschirm diese Regel selbst an: Ein Bildschirm ohne Zeitzone schlägt im Ergebnis fehl, die anderen werden zugewiesen.

Um in eine Flotte zu veröffentlichen, erstellen Sie die Playlist einmal mit playlist create und führen dann screen assign --tag TAG --playlist-id ID aus. screen publish richtet sich an einen Bildschirm.

Legen Sie die zivile Zeitzone fest, in der eine geplante Playlist gelesen wird.

screen set-timezone <id> --timezone ZONE [--expect-rev REVISION]

screenrig screen set-timezone scr_01EXAMPLESCREEN00000000 --timezone America/Los_Angeles

Seitenpläne sind bürgerliche Zeiten, daher ohne Zeitzone bedeutungslos. Eine Änderung der Zeitzone erneuert die Manifestrevision.

Einen Bildschirm ausblenden und das Glas abdunkeln.

screen archive <id> [--expect-rev REVISION]

screenrig screen archive scr_01EXAMPLESCREEN00000000

Archivieren blendet den Bildschirm aus der Standardliste aus und verdunkelt das Glas. Die Bindung des Players wird nicht aufgehoben.

Archivierten Bildschirm in die Standardliste zurückführen.

screen unarchive <id> [--expect-rev REVISION]

screenrig screen unarchive scr_01EXAMPLESCREEN00000000

Ein Player kann auch seinen eigenen Bildschirm archivieren: ein bestätigtes Zurücksetzen auf einem Player, der einen Schlüssel besitzt, oder das Entkoppeln eines per Cookie gekoppelten Browser-Players. screen show meldet dann archive_reason als device_reset oder device_unpair (project für ein von Ihnen angefordertes Archiv) mit archived_at. Der Bildschirm behält seine Gerätebindung aus allen Gründen, sodass ein Player, der diesen Schlüssel oder Geräte-Cookie noch besitzt, dunkel bleibt und beim Entarchivieren ohne erneutes Koppeln fortsetzt. Der zurückgesetzte oder entkoppelte Player verwirft seinen Schlüssel oder Cookie und koppelt sich als neuer Bildschirm erneut. Ein durch eine bestätigte Bildschirmwiederherstellung ersetzter Schlüssel bleibt außer Dienst.

Ein als replaced durch screen replace archivierter Bildschirm behält keine Gerätebindung, daher lehnt das Entarchivieren ihn ab, und screen delete entfernt ihn.

Eine Mitteilung auf einem Bildschirm anstelle seines Inhalts anzeigen, bis er fortgesetzt wird.

screen suspend <id> --message TEXT [--expect-rev REVISION]

screenrig screen suspend scr_01EXAMPLESCREEN00000000 --message "Closed for stocktake. Back at 9am."

Ein ausgesetzter Bildschirm zeigt die Nachricht anstelle seines Inhalts. Sonst ändert sich nichts: Playlist, Zeitplan, Übernahme und Display-Steuerung bleiben bestehen und entwickeln sich weiter, und screen resume zeigt, was der Bildschirm jetzt anzeigen würde. screen show meldet suspension mit message und since; das erneute Aussetzen eines ausgesetzten Bildschirms ersetzt die Nachricht und behält since. Das Aussetzen erhöht die Bildschirmrevision, und der Player ruft sofort erneut ab. Ein archivierter Bildschirm antwortet mit screen_archived.

Die Aussetzung eines Bildschirms beenden, damit er wieder seinen eigenen Inhalt zeigt.

screen resume <id> [--expect-rev REVISION]

screenrig screen resume scr_01EXAMPLESCREEN00000000

Fortsetzen zeigt wieder den eigenen Inhalt des Bildschirms an, ausgehend von dem, was der Bildschirm jetzt anzeigen würde, und der Player ruft sofort erneut ab. Ein Bildschirm, der nicht ausgesetzt ist, antwortet unverändert und ohne Revisionsänderung. Ein archivierter Bildschirm antwortet mit screen_archived.

Einen Bildschirm löschen.

screen delete <id> [--expect-rev REVISION]

screenrig screen delete scr_01EXAMPLESCREEN00000000

Löschen entfernt einen Bildschirm nur, solange ihm kein Player-Schlüssel zugeordnet ist, und screen show meldet deletable: true für diesen Bildschirm. Ein Player, der sich per Code koppelt, ob nativ oder als Browser-Player, besitzt einen Schlüssel, und der Schlüssel bleibt an seinen Bildschirm gebunden: Das Löschen dieses Bildschirms antwortet mit 409 screen_archive_required (Exit-Code 5), archivieren Sie ihn stattdessen. Nur ein per Cookie gekoppelter Browser-Player besitzt keinen Schlüssel, und sein Bildschirm lässt sich löschen, ob er gekoppelt ist oder noch aussteht.

Das als anderer Bildschirm gekoppelte Gerät auf diesen Bildschirm verschieben und dabei die Einstellungen und den Verlauf dieses Bildschirms behalten.

screen replace <id> --with ID [--expect-rev REVISION]

screenrig screen replace scr_01EXAMPLESCREEN00000000 --with scr_01EXAMPLENEWSCREEN000000

Koppeln Sie die neue Hardware zuerst als eigenen Bildschirm und führen Sie dann den Austausch durch. Der Schlüssel des Geräts oder die Anmeldedaten eines Browser-Players öffnen nun <id>; dabei bleiben Name, Tags, Zeitzone, Playlist, Zeitpläne, Übernahme, Display-Zeitplan samt Überschreibung, Videowand, Kommentare, Felder, Standort und Verlauf erhalten, und Host und Player des Ersatzgeräts werden übernommen. Gerätezustand, Status, Speicher und Befehle in der Warteschlange beginnen von vorn. Der durch --with benannte Bildschirm wird mit archive_reason replaced archiviert, und replaced_by benennt <id>. Er behält keine Gerätebindung, daher kann screen unarchive ihn nicht wiederherstellen und screen delete entfernt ihn. Der Schlüssel, den <id> besaß, wird nach einem fünfzehnminütigen Kulanzfenster zurückgezogen, danach wird das alte Gerät abgelehnt. Beide Bildschirme müssen aktiv sein und einen gekoppelten Player haben: Ein Bildschirm, der noch auf die Kopplung wartet, antwortet mit resource_conflict, ein archivierter mit screen_archived, und eine Videowand benötigt einen Ersatz-Player, der display.wall meldet (wall_unsupported). Die Anfrage trägt immer einen Idempotenzschlüssel, und eine exakte Wiederholung gibt die ursprüngliche Antwort zurück.

Eine neue öffentliche ID für einen Bildschirm ausgeben.

screen rotate-public-id <id> [--expect-rev REVISION]

screenrig screen rotate-public-id scr_01EXAMPLESCREEN00000000

Den Link eines Bildschirms erstellen oder ersetzen und seine Player-URL ausgeben.

screen link create <id> [--expect-rev REVISION]

screenrig screen link create scr_01EXAMPLESCREEN00000000

Gibt data.url aus, die Player-URL (https://play.screenrig.ai/player/#screen=…), die als URL einer Browserquelle in vMix oder OBS eingefügt wird; diese behält keinen Speicher und würde sonst bei jedem Laden ihre Kopplung verlieren. Der Player läuft bei jedem Laden aus der URL: Die URL ist die gesamte Kopplung. Den Link erneut zu erstellen ersetzt ihn (data.replaced ist true): Die alte URL funktioniert sofort nicht mehr, und der daraus geöffnete Player zeigt einen Hinweis ohne Inhalt. Die URL ist eine Anmeldeinformation, die den Bildschirm öffnet: Sie wird unter einem sensiblen Label ausgegeben, aus dem Betriebsprotokoll herausgehalten und von screen link show erneut angezeigt. Öffnen Sie sie an einer einzigen Stelle. Ein Bildschirm, der nicht gekoppelt ist, antwortet mit resource_conflict (Exit-Code 5), und ein archivierter Bildschirm antwortet mit screen_archived. Wiederholen Sie nach einer unterbrochenen Anfrage denselben Befehl: Er verwendet den gespeicherten Idempotenzschlüssel und liefert denselben Link.

Den Link eines Bildschirms und seine Player-URL ausgeben.

screen link show <id>

screenrig screen link show scr_01EXAMPLESCREEN00000000

Gibt data.url unter einem sensiblen Label aus, mit data.hint (die letzten vier Zeichen des Geheimnisses), data.created_at und data.last_used_at, sobald ein Player den Link geöffnet hat. Eine Nur-Lese-Anmeldeinformation erhält url leer mit url_redacted true, und die menschliche Ausgabe sagt, dass die URL zurückgehalten wird; eine Manage-Anmeldung erhält sie. Ein Bildschirm ohne Link antwortet mit screen_link_not_found (Exit-Code 4) und nennt den Befehl, der einen erstellt. screen show gibt Screen link: on (…HINT) für einen Bildschirm mit Link aus, nie dessen URL.

Den Link eines Bildschirms deaktivieren.

screen link delete <id> [--expect-rev REVISION]

screenrig screen link delete scr_01EXAMPLESCREEN00000000

Die URL funktioniert sofort nicht mehr, und jede Sitzung, die sie geöffnet hat, endet: Eine Browserquelle, die sie noch zeigt, zeigt einen Hinweis und keinen Inhalt, bis sie eine neue URL erhält. Der Bildschirm, seine Kopplung und sein Inhalt bleiben unberührt. Der Aufruf gelingt ohne Änderung, wenn der Bildschirm keinen Link hat.

Bitten Sie den Player eines Bildschirms oder jeden Player in einer Flotte, einmal neu zu laden.

screen reload (<id>... | --tag TAG) [--expires-in DURATION] [--expect-rev REVISION]

screenrig screen reload scr_01EXAMPLESCREEN00000000
screenrig screen reload scr_01EXAMPLESCREEN00000000 --expires-in 2h
screenrig screen reload --tag Lobby

Die Antwort enthält reload_id, state und expires_at. Einem Bildschirm, der online ist, wird das Neuladen sofort gesendet (state sent); ein Offline-Bildschirm hält es als queued vor und erhält es, wenn er vor expires_at online geht, 24 Stunden nach der Anfrage, sofern --expires-in nichts anderes festlegt. Ein neueres Neuladen ersetzt ein noch in der Warteschlange stehendes; screen show listet die commands des Bildschirms auf, und screen command cancel bricht ein noch in der Warteschlange stehendes ab. In einer Flotte enthält jedes Ergebnis in reload dasselbe Feld state. Ein Web-Player lädt an seiner nächsten Seitenbegrenzung neu; ein nativer Player verbindet sich neu, lädt sein Manifest erneut und prüft auf ein Update. Ein Player ignoriert ein Neuladen innerhalb von zehn Minuten nach dem letzten, auf das er reagiert hat. Neuladen funktioniert bei aktiven und archivierten Bildschirmen und ändert die Bildschirmrevision nicht.

Eine einmalige Nachricht als Bühnen-Chrome auf einem Live-Bildschirm oder einer Flotte posten.

screen toast (<id>... | --tag TAG) --text TEXT [--level info] [--duration-ms MS]

screenrig screen toast scr_01EXAMPLESCREEN00000000 --text "Lobby closed"
screenrig screen toast --tag Lobby --text "Closing in ten minutes"

Ein Toast ist kein Primitivelement: Es belegt keinen Canvas-Slot, hat keine Ebene und nimmt nicht an Bereitschaft oder Crossfade teil. Das Neueste gewinnt, es gibt keine Warteschlange und kein Abbrechen, und der akzeptierte Umschlag ist nur { expires_at }. Setzen Sie niemals Zugangsdaten oder andere geheime Materialien in den Text.

Den Namen eines Bildschirms eine Weile über seinem Inhalt anzeigen, um ihn vor Ort zu finden.

screen identify <id> [--duration DURATION]

screenrig screen identify scr_01EXAMPLESCREEN00000000
screenrig screen identify scr_01EXAMPLESCREEN00000000 --duration 2m

Der Player zeichnet eine Vollbild-Überlagerung über seinen Inhalt, mit dem Namen des Bildschirms sehr groß und seiner ID klein darunter. Die Wiedergabe läuft darunter weiter, und ein neueres Identifizieren ersetzt die Überlagerung. Der akzeptierte Umschlag enthält identify_id, duration_ms und expires_at 60 Sekunden nach der Anfrage, sodass ein Offline-Bildschirm sie später nie anzeigt. Nur ein Player, der die Fähigkeit identify meldet, zeigt die Überlagerung an: Jeder andere Bildschirm antwortet mit 409 identify_unsupported (Exit-Code 5), und es wird nichts gesendet; aktualisieren Sie daher den Player oder zeigen Sie den Namen mit screen toast an. Ein archivierter Bildschirm antwortet mit screen_archived, und ein Bildschirm, der noch auf die Kopplung wartet, antwortet mit resource_conflict. Das Identifizieren ändert die Bildschirmrevision nicht.

Machen Sie eine Einzelaufnahme eines aktiven Bildschirms oder aller Bildschirme einer Flotte und speichern Sie sie auf der Festplatte.

screen screenshot <id> [--output FILE] [--timeout MS] [--poll-ms MS]
screen screenshot (<id> <id>... | --tag TAG) [--output DIRECTORY] [--concurrency N] [--timeout MS] [--poll-ms MS]

screenrig screen screenshot scr_01EXAMPLESCREEN00000000 --output ./lobby.webp

screenrig screen screenshot --tag Lobby --output ./lobby-shots

Der Befehl blockiert, bis das WebP auf der Festplatte ist; es gibt kein --no-wait. Der Umschlag meldet screen_id, capture_id, path, bytes, sha256, width und height und niemals Bildbytes. Neueste gewinnt: Eine spätere Anfrage ersetzt eine laufende Aufnahme. Ein Screenshot des Web-Players zeichnet jede iframe-Seite als dunkelgraue Kachel mit der Beschriftung „Embedded web page“ und jede Anwendung so, wie sie sich selbst darstellt; das Bild trägt keine Markierung für die Kachel und beweist daher nicht, dass eine Iframe-Seite gerendert wurde.

Für mehrere IDs oder --tag ist die Antwort ein Flottenergebnis mit action: "screenshot", dem selector und dem output-Verzeichnis; jedes ok-Ergebnis enthält path, bytes, sha256, width und height. Mit --tag listet die CLI zuerst die getaggten Bildschirme nach jeder Listen-Seite; jede Listen-Seite wird berechnet, die Aufnahmen selbst sind kostenlos, und mehrere IDs benötigen keine Liste. --idempotency-key wird in dieser Form abgelehnt, da jede Aufnahme eigene Schlüssel verwendet. Wenn eine Aufnahme unerwartet fehlschlägt, ist das Ergebnis dieses Bildschirms unexpected_error, es starten keine neuen Aufnahmen, die wartenden Bildschirme melden not_attempted und der Exit-Code ist 1.

Tags auf einem Bildschirm oder einer Flotte setzen, hinzufügen, entfernen oder löschen.

screen tag (<id>... | --tag TAG) (--set TAGS | --add TAGS | --remove TAGS | --clear) [--expect-rev REVISION]

screenrig screen tag scr_01EXAMPLESCREEN00000000 --set Lobby,Floor2
screenrig screen tag scr_01EXAMPLESCREEN00000000 --add Spring
screenrig screen tag --tag Lobby --add Spring

Ein Tag besteht aus 1 bis 32 Buchstaben oder Ziffern, und ein Bildschirm trägt höchstens 16 eindeutige Tags. Tags wählen Flotten aus; sie sind niemals Autorisierung und erreichen niemals den Player. Das Ändern von Tags erhöht die Bildschirmrevision, nicht die Manifestrevision. Für einen Bildschirm ist der Umschlag der aktualisierte Bildschirm. --add und --remove lesen zuerst den Bildschirm und schreiben die neue Menge geschützt durch --expect-rev oder die gerade gelesene Revision, sodass eine gleichzeitige Änderung revision_conflict (Exit 6) zurückgibt, anstatt überschrieben zu werden; führen Sie den Befehl erneut aus. In einer Flotte gelten --add und --remove atomar für jeden gespeicherten Satz eines Bildschirms, und ein Bildschirm, der mehr als 16 Tags hätte, schlägt in seinem eigenen Ergebnis mit invalid_request fehl.

Überall dort, wo sich Tags ändern (screen tag, eine Bildschirmaktualisierung über die API, der Tag-Editor des Dashboards), listet levels in der Antwort unter gained und lost die Kampagnen auf, deren Tag-Zielgruppe der Bildschirm betreten oder verlassen hat, jeweils mit source (campaign), id, der Anzahl screens und, wenn die Kampagne eine Reichweite hat, reach_before und reach_after. screen tag der Flotte summiert sie über die Flotte. Lesen Sie levels.lost, bevor Sie eine Tag-Änderung für harmlos halten: Das Entfernen des letzten passenden Tags von den Bildschirmen einer Kampagne leert diese Gruppe und löst die reach_dropped- und group_empty-Benachrichtigungen aus.

Zeigen Sie den Playlist-Zeitplan eines Bildschirms und die aktuell ausgewählte Playlist an.

screen schedule show <id>

screenrig screen schedule show scr_CAFE

Die JSON-Ausgabe kann direkt an screen schedule set --file zurückgegeben werden.

Den Playlist-Zeitplan auf einem Bildschirm oder einer Flotte ersetzen.

screen schedule set (<id>... | --tag TAG) --file FILE [--expect-rev REVISION] [--note TEXT]

screenrig screen schedule set scr_CAFE --file dayparts.json
screenrig screen schedule set --tag Cafe --file dayparts.json

Jede Playlist, die ein Zeitplan benennt, wird als Zuweisung validiert, und der Bildschirm benötigt eine Zeitzone und eine zugewiesene Standard-Playlist. Gilt kein Eintrag, wird die zugewiesene Playlist abgespielt. Wenn eine geplante Playlist später nicht angezeigt werden kann, werden ihre Einträge übersprungen und screen.playlist_unavailable wird protokolliert.

Den Playlist-Zeitplan von einem Bildschirm oder einer Flotte entfernen.

screen schedule clear (<id>... | --tag TAG) [--expect-rev REVISION] [--note TEXT]

screenrig screen schedule clear --tag Cafe

Zeigen, was das Ersetzen des Playlist-Zeitplans eines Bildschirms ändern würde, ohne es auszuführen.

screen schedule preview <id> --file FILE [--calendar-from INSTANT] [--calendar-to INSTANT]

screenrig screen schedule preview scr_LOBBY --file dayparts.json
screenrig screen schedule preview scr_LOBBY --file dayparts.json --calendar-from 2026-12-01T00:00:00Z --calendar-to 2027-01-01T00:00:00Z

Es wird nichts geschrieben. Die Einträge werden so geprüft, wie screen schedule set sie prüft, daher verweigert eine Vorschau, was das Setzen verweigert. data.gained und data.lost sagen, ob der Bildschirm Ebenen seines Zeitplans gewinnen oder verlieren würde; ein Eintrag mit "paused": true liegt auf keinem Bildschirm, daher gewinnt man ihn mit seiner Veröffentlichung. data.calendar.before und data.calendar.after sind der Kalender des Bildschirms, wie er ist und wie er von --calendar-from bis --calendar-to wäre.

Die Revisionen des Playlist-Zeitplans eines Bildschirms auflisten, die neueste zuerst.

screen schedule revisions <id> [--after CURSOR]

screenrig screen schedule revisions scr_LOBBY
screenrig screen schedule revisions scr_LOBBY --after CURSOR

data.items enthält höchstens 50 Revisionen, jeweils mit revision (die Revision des Bildschirms beim Schreiben, daher haben die Nummern Lücken, wo sich der Bildschirm anders geändert hat), created_at, change, current, author, wenn bekannt, und entries, dem gesamten Zeitplan nach diesem Schreibvorgang (none bedeutet, dass der Bildschirm keinen Zeitplan hatte). change ist edited (ein Setzen, ein Löschen oder ein Zeitplanimport), restored (eine Kopie der früheren Revision, die restored_from nennt) oder baseline. Solange data.next_cursor ein String ist, gibt es ältere Revisionen: Führen Sie den Befehl erneut aus, mit --after darauf gesetzt. Revisionen verschwinden mit dem Löschen des Bildschirms. Lesezugriff genügt.

Den Zeitplan einer früheren Revision auf einem Bildschirm wiederherstellen, indem er nach vorn kopiert wird.

screen schedule restore <id> --revision N [--expect-rev REVISION] [--note TEXT]

screenrig screen schedule restore scr_LOBBY --revision 4
screenrig screen schedule restore scr_LOBBY --revision 4 --expect-rev 9

Die Einträge der Revision N werden zum Zeitplan des Bildschirms, derselbe Schreibvorgang wie screen schedule set mit diesen Einträgen (oder screen schedule clear, wenn diese Revision keine hatte), so geprüft, wie sie jetzt geprüft werden: Eine inzwischen gelöschte Playlist verweigert ihn. Unter Propose-Zugriff oder in einem Projekt, das Überprüfung für Agentenänderungen verlangt, wartet die Wiederherstellung wie das Setzen auf eine Person, und auf dem Bildschirm ändert sich nichts, bis sie sie genehmigt. Frühere Revisionen bleiben, wie sie waren.

Zeigen Sie eine Playlist auf einem Bildschirm oder einer Flotte vor Kampagnen, dem Zeitplan und der Zuweisung an.

screen takeover [set] (<id>... | --tag TAG) --playlist-id ID [--until TIME | --for DURATION] [--reason TEXT] [--expect-rev REVISION] [--note TEXT]

screenrig screen takeover scr_LOBBY --playlist-id pl_DRILL --for 30m --reason "Fire drill"
screenrig screen takeover --tag Lobby --playlist-id pl_LAUNCH --for 2h
screenrig screen takeover scr_A scr_B --playlist-id pl_NOTICE --until none

screen takeover ID ist die Kurzform von screen takeover set ID. Eine neue Übernahme ersetzt die vorherige. Wenn sie endet, kehrt der Bildschirm eigenständig zu einer geltenden Kampagne, seinem Zeitplan oder seiner zugewiesenen Playlist zurück. Eine Übernahme, deren Playlist nicht angezeigt werden kann, endet. Ein --for-Wiedergabedurchlauf nach einem unklaren Fehler berechnet ein neues Ende und wird als neue Anfrage gesendet.

Übernahme auf einem Bildschirm oder einer Flotte beenden.

screen takeover clear (<id>... | --tag TAG) [--expect-rev REVISION] [--note TEXT]

screenrig screen takeover clear --tag Lobby

Die Kampagnen des Projekts in der Reihenfolge auflisten, in der Bildschirme sie lesen.

campaign list

Keine Parameter.

screenrig campaign list

data.items enthält höchstens 100 Kampagnen, höchste Priorität zuerst und innerhalb einer Priorität die neueste zuerst. Eine pausierte Kampagne wird aufgelistet und gilt nirgends.

Eine Kampagne lesen.

campaign show <id>

screenrig campaign show cmp_LUNCH

Gibt name, playlist_id, audience (die exakte Regel), priority, paused, die gesetzten from, until, windows, monthly, dates, except, interaction, displays und start sowie revision zurück, den Wert für --expect-rev bei einem späteren Schreibvorgang. reach meldet, auf wie viele Bildschirme die Zielgruppe passt: published bei der letzten Veröffentlichung der Kampagne (erstellt oder aktualisiert mit neuer Zielgruppe, Playlist oder Pausenstatus), current und at für die neueste Anzahl sowie empty_groups, die tag:NAME- und folder:ID-Elemente der Zielgruppe, die auf keinen Bildschirm passen. Ein Tag, Ordner, eine Archivierung oder eine Löschung, die die Anzahl ändert, wird innerhalb von etwa 15 Sekunden neu gezählt; campaign list trägt auch reach, und die Benachrichtigungen reach_dropped und group_empty überwachen sie. Eine ID aus ads campaigns list antwortet hier mit not_found (Exit 4).

Die Bildschirme einer Zielgruppe auf eine Playlist umschalten, immer oder solange ihre Regeln gelten.

campaign create --name NAME --playlist-id ID (--tag TAG | --any-tag TAG | --screen-id ID | --folder ID | --all-screens | --audience RULE) [--from TIME] [--until TIME] [--window SPEC] [--monthly SPEC] [--date SPEC] [--except DATES] [--on-touch [IDLE_S]] [--displays N[,N]] [--start on-time|next-item] [--covers WHERE] [--priority N] [--paused]

screenrig campaign create --name "Lunch menu" --playlist-id pl_LUNCH --tag north --window mon-fri@11:00-14:00
screenrig campaign create --name "North Tower welcome" --playlist-id pl_WELCOME --folder sfd_01EXAMPLEFOLDER000000000
screenrig campaign create --name "Holiday hours" --playlist-id pl_HOLIDAY --tag Lobby --from 2026-12-20T00:00 --until 2027-01-02T00:00 --priority 10
screenrig campaign create --name "North cafes" --playlist-id pl_CAFE --audience '{"all":[{"tag":"North"},{"any":[{"tag":"Cafe"},{"tag":"Patio"}]}]}' --paused
screenrig campaign create --name "Brunch" --playlist-id pl_BRUNCH --tag Cafe --monthly 1st-sun@10:00-14:00 --except 2026-12-06
screenrig campaign create --name "Touch to browse" --playlist-id pl_MENU --screen-id scr_KIOSK --on-touch 90
screenrig campaign create --name "Holiday opening" --playlist-id pl_HOLIDAY --tag Lobby --date 2026-12-24@18:00-22:00 --start on-time
screenrig campaign create --name "Wall outputs 1 and 2" --playlist-id pl_WALL --screen-id scr_WALL --displays 1,2

Tags bestehen aus 1 bis 32 Buchstaben oder Ziffern. DAYS ist daily, ein Wochentag (mon), ein Bereich (mon-fri; fri-mon läuft über das Ende der Woche hinaus) oder eine Kommaliste (sat,sun). Ohne Uhrzeit ist das Fenster der ganze Tag, und ein Ende um oder vor dem Start überschreitet Mitternacht und gehört zum Starttag. In einer --audience-Regel hat jedes Mitglied genau eines von all, any, tag, screen_id oder folder, Gruppen sind höchstens 3 Ebenen tief verschachtelt, eine Zielgruppe hat höchstens 500 Regeln, und {"all":[]} ist jeder Bildschirm.

Nach einer unterbrochenen oder mehrdeutigen Erstellung führen Sie denselben Befehl innerhalb von 24 Stunden erneut aus: Er verwendet den gespeicherten Idempotenzschlüssel, und der Server liefert dieselbe Kampagne zurück, anstatt eine neue zu erstellen.

Eine Kampagne ändern; die Bildschirme ihrer alten und neuen Zielgruppe werden innerhalb einer Minute neu aufgelöst.

campaign update <id> [--name NAME] [--playlist-id ID] [audience option] [--from TIME | --clear-from] [--until TIME | --clear-until] [--window SPEC | --clear-windows] [--monthly SPEC | --clear-monthly] [--date SPEC | --clear-dates] [--except DATES | --clear-except] [--on-touch [IDLE_S] | --clear-on-touch] [--displays N[,N] | --clear-displays] [--start WHEN] [--covers WHERE] [--priority N] [--expect-rev REVISION]

screenrig campaign update cmp_LUNCH --playlist-id pl_LUNCH2 --expect-rev 2
screenrig campaign update cmp_LUNCH --tag Lobby --window sat,sun --priority 20
screenrig campaign update cmp_LUNCH --clear-until --clear-windows
screenrig campaign update cmp_BRUNCH --monthly 2nd-sun@10:00-14:00 --except 2026-12-13,2027-01-10
screenrig campaign update cmp_BROWSE --clear-on-touch --clear-displays

Übergeben Sie mindestens eine Änderung; nur die Felder, die Sie übergeben, ändern sich. Ein neues --playlist-id wird wie bei der Erstellung geprüft. Nach einer unterbrochenen oder mehrdeutigen Anfrage führen Sie denselben Befehl erneut aus: Er verwendet den gespeicherten Idempotenzschlüssel, und der Server liefert die bereits erfolgte Aktualisierung zurück, anstatt sie erneut anzuwenden.

Eine Kampagne auf jedem Bildschirm stoppen, ohne sie zu löschen.

campaign pause <id> [--expect-rev REVISION]

screenrig campaign pause cmp_LUNCH

Bildschirme, die sie angezeigt haben, kehren innerhalb einer Minute zu dem zurück, was sie ohne sie anzeigen würden. campaign resume startet sie erneut.

Eine pausierte Kampagne erneut starten.

campaign resume <id> [--expect-rev REVISION]

screenrig campaign resume cmp_LUNCH

Jeder Bildschirm der Zielgruppe, für den die Kampagne gelten kann, schaltet innerhalb einer Minute auf ihre Playlist um, solange die Kampagne gilt.

Eine Kampagne löschen.

campaign delete <id> [--expect-rev REVISION]

screenrig campaign delete cmp_LUNCH

Die Kampagne kommt nicht zurück. Jeder Bildschirm, der sie anzeigt, kehrt innerhalb einer Minute zu dem zurück, was er ohne sie anzeigen würde; Playlists, Bildschirme und Tags bleiben bestehen. campaign pause stoppt eine Kampagne und behält sie.

Die Bildschirme anzeigen, die eine Kampagne erreicht, und den Status auf jedem.

campaign screens <id> [--limit N] [--cursor CURSOR]