Im Bundle enthaltene CLI-Oberfläche
Die Befehle sind so gruppiert, wie die CLI sie gruppiert. Installation und erste Schritte stehen in der Schnellstartanleitung; die Wahl zwischen Upload, Karten und Selektoren behandelt Compose.
| Gruppe | Befehle | Was es abdeckt |
|---|---|---|
| Projekte | project organization invitations agent login billing doctor | Projekte anlegen, wählen, umbenennen, verschieben, exportieren, an- und abmelden, Personen einladen, Planlimits lesen und Doctor ausführen. |
| Service-Clients | service-client | Service-Clients anlegen, Schlüssel und Secrets hinzufügen und entfernen, widerrufen: die Anmeldung für Server, Skripte und CI-Jobs. |
| Hilfe und Support | help status docs recovery support feedback | Dokumentation durchsuchen, Dienststatus prüfen, nach unklarem Schreibvorgang wiederherstellen, Support kontaktieren, Fehler und Wünsche melden. |
| Medien | media media folder | Bilder, Videos und Audio hochladen, ersetzen, versionieren, taggen, verschieben, löschen, mit Ordnern, Selektoren und Verfügbarkeitsregeln. |
| Mediensynchronisierung | media sync media sync account | Einen Medienordner mit SharePoint, OneDrive, Dropbox oder Google Drive abgleichen: Konten hinzufügen, Synchronisierungen anlegen und ausführen. |
| Playlists | playlist | Playlists vorbereiten, prüfen, erstellen, ändern, exportieren, importieren, Seiten, Revisionen und Instanzen verwalten, eine App-Version ersetzen. |
| Karten | card cards kv webhook | Kartentypen finden, Karte erstellen, Parameter und Live-Daten setzen, Vorschau ansehen und Daten über signierte Webhooks aus Fremdsystemen aktualisieren. |
| Anwendungen | app kv kv webhook | Web-Anwendungen packen, hochladen, aktualisieren und löschen sowie ihren Schlüssel/Wert-Speicher und dessen Webhooks lesen und schreiben. |
| Bildschirme | screen browser setup | Bildschirme koppeln, auflisten, bespielen, zuweisen, taggen, verschieben, neu laden und löschen; Ordner, Links, Videowände und Live-Ansicht verwalten. |
| Zeitpläne | screen schedule screen takeover schedule import | Den Playlist-Zeitplan eines Bildschirms setzen, ansehen, wiederherstellen, löschen, Bildschirme zeitweise übernehmen, Zeitpläne aus Tabellen importieren. |
| Kampagnen | campaign | Kampagnen erstellen, prüfen, veröffentlichen, hochstufen, pausieren, wiederherstellen: Sie schalten ganze Bildschirmgruppen auf eine Playlist. |
| Gerätezustand | screen reboot screen display screen brightness screen uptime | Gerät neu starten und aktualisieren, Anzeige und Neustarts planen, Helligkeit setzen, Kiosk sperren, Betriebszeit, Zustand und Speicher auslesen. |
| Überprüfungen und Notizen | reviews comment notes | Überprüfungen von Agent-Änderungen auflisten, anzeigen und zurückziehen, Kommentare an Bildschirme und Playlists hängen, Projektnotizen hinterlassen. |
| Benachrichtigungen | notifications webhooks alerts events operations | Menschen und Systeme per Benachrichtigung und Webhook über Bildschirmzustände informieren, Ereignisse verfolgen, Alarme bearbeiten, Vorgänge abwarten. |
| Berichte | reports audit playback | Berichte erstellen und per E-Mail planen, das Audit-Protokoll lesen und prüfen, Wiedergabenachweise abfragen: Wiedergaben, Summen und Vollständigkeit. |
| Datenquellen | feeds source connection | Feeds von Drittanbietern lesen, eine Karte planmäßig von einer externen Adresse aktuell halten und Microsoft- und Google-Verbindungen speichern. |
| BI-Dashboards | bi connection bi view | Grafana, Tableau, Power BI oder ein Web-Dashboard verbinden, dann dessen Ansichten durchsuchen, anlegen, testen und auf Bildschirmen zeigen. |
| Auslöser | triggers | Bildschirme bei CAP-Notfallalarmen übernehmen und Overlays von Home Assistant oder jedem HTTP-Client zeigen: Auslöser erstellen, testen, rotieren. |
| Flottenverbindungen | fleet-links migrate | Flottenverbindungen für Geräteverwaltungen anlegen und Medien, Playlists, Zeitpläne und Bildschirme einer anderen Plattform in screenRIG übernehmen. |
| Werbung | ads | Werbung in einem Netzwerk kaufen, das Sie eingeladen hat, oder Werbepausen auf eigenen Bildschirmen verkaufen: Inventar, Slots, Kampagnen, Berichte. |
Jeder Befehl läuft auf dieselbe Weise
screenrig [--json | --human] [--api-url URL] [--config PATH] [--request-id ID]
[--project-id ID] [--idempotency-key KEY] [--timeout MS] <command> [args]Globale Flags
| Markieren | Typ | Standard | Notizen |
|---|---|---|---|
--json | boolean | JSON für Operationen | Explizite JSON-Ausgabe, aus Kompatibilitätsgründen beibehalten. Wählt auch strukturierte Hilfe aus. Kann nicht mit --human kombiniert werden. |
--human | boolean | aus | Wählen Sie eine menschenlesbare Betriebsanzeige. Kann nicht mit --json kombiniert werden. |
--project-id ID | string | zuletzt verwendetes Projekt | Diese Aufruf auf ein zwischengespeichertes Projekt korrigieren, ohne die Auswahl zu ändern. Jeder Befehl behält sein Ziel und seinen Wiederherstellungszustand für die gesamte Ausführung. |
--api-url URL | string | https://api.screenrig.ai | Ursprung der Steuerungsebene. SCREENRIG_API_URL setzt dasselbe. |
--config PATH | Pfad | die Benutzerkonfigurationsdatei | Verwenden Sie eine spezifische Konfigurationsdatei. SCREENRIG_CONFIG setzt dasselbe. |
--request-id ID | string | pro Lauf generiert | Ihre eigene Anforderungs-ID: req_ plus 16 bis 64 Buchstaben, Ziffern, _ oder -. Sie wird nur an die erste Anfrage angehängt und als request_id zurückgegeben. Behalten Sie sie in Berichten bei. |
--idempotency-key KEY | string | pro Schreibvorgang abgeleitet | Diesen Schlüssel wiederverwenden, um einen mehrdeutigen Schreibvorgang erneut zu versuchen. Der Server gibt das ursprüngliche Ergebnis für vierundzwanzig Stunden zurück; ein anderer Inhalt unter demselben Schlüssel ist idempotency_mismatch. |
--timeout MS | integer | 30000 pro Anfrage | Begrenzt jede HTTP-Anfrage. Bei einem Befehl, der auf eine Operation wartet, ist stattdessen die Wartefrist maßgeblich, standardmäßig 120000. |
--help, -h | boolean | aus | Drucken Sie fokussierte Hilfe für den Befehl oder die Gruppe und beenden Sie. Fügen Sie --json für strukturierte Hilfe hinzu. |
--version, -V | boolean | aus | Drucken Sie die gebündelte CLI-Version und beenden Sie. Gleichbedeutend mit dem Befehl version. |
Umgebung
| Variable | Effekt |
|---|---|
SCREENRIG_API_URL | Ursprung der Steuerungsebene, der die gespeicherte Konfiguration überschreibt. |
SCREENRIG_CONFIG | Pfad zur Konfigurationsdatei. |
XDG_CONFIG_HOME | Basis des Konfigurationsverzeichnisses. Sonst %APPDATA%\screenrig unter Windows oder ~/.config/screenrig. |
SCREENRIG_FFMPEG | Absoluter Pfad zu ffmpeg, wenn media upload ihn nicht von PATH beziehen soll. |
SCREENRIG_FFPROBE | Absoluter Pfad zu ffprobe. |
SCREENRIG_CWEBP | Absoluter Pfad zu cwebp, dem Fallback-Still-Encoder. |
Keines davon ist eine Anmeldeinformation: Es gibt keine Token-Option und keine Umgebungsvariable für Anmeldeinformationen. Die CLI liest die Sitzung, die das Plugin für diese Installation gespeichert hat, in einer benutzerprivaten Datei, die ein Plugin-Upgrade überdauert, und erneuert sie selbstständig. Eine mit screenrig login --client-id gespeicherte Konfiguration meldet sich stattdessen als dieser Service-Client an, liest jedes Mal seine Schlüssel- oder Secret-Datei und hält das Token im Speicher.
Ausgabe
Betriebsbefehle schreiben standardmäßig JSON auf stdout, einschließlich Fehler. Ein einzelnes Ergebnis enthält einen Umschlag: ok, dann data, request_id, operation_id und warnings[] bei Erfolg oder error bei Fehler. Fortschritt, sichere URLs und menschliche Notizen gehen an stderr. events follow gibt NDJSON aus: ein JSON-Umschlag pro Ereignis, jeweils in einer eigenen Zeile. Die Umleitung von stdout ändert das Format nicht.
Verwenden Sie --human zur manuellen Inspektion. Ereignisbefehle drucken dann eine logfmt-Zeile pro Ereignis. Hilfe und reine Befehlsgruppen bleiben standardmäßig lesbarer Text; verwenden Sie screenrig --json playlist --help für strukturierte Entdeckung. --json und --human können nicht kombiniert werden.
Ältere Plugin-Bundles benötigen möglicherweise explizit --json für Betriebsergebnisse. Prüfen Sie die Hilfe der installierten CLI bei der Arbeit mit einem älteren Bundle. Playlist-Autorendateien bleiben JSON-Dokumente; ein Befehlsresultatumschlag ist kein bearbeitbares Playlist-Dokument.
Ein Fehlerumschlag enthält error.status, ein stabiles error.code und oft error.next.command, die genau angeben, was als Nächstes ausgeführt werden soll. Verzweigen Sie danach statt nach Text.
Eine Änderung, die auf die Überprüfung durch eine Person wartet, ist ein Erfolg, kein Fehler: ok: true, Beenden 0, data.status: pending_review mit dem review, eine pending_review Warnung mit dem Namen der Überprüfungs-URL und data.next zeigt auf reviews show ID. Ein erneutes Taggen von genehmigten Medien unter Überprüfung ist ok, Beenden 0, mit der Warnung media_review_pending stattdessen: Die Überprüfung erscheint innerhalb weniger Sekunden in reviews list. Siehe Reviews.
Beendigungscodes
| Code | Bedeutung |
|---|---|
0 | Erfolg. |
1 | Unerwarteter Fehler. |
2 | Nutzungsfehler. Es wurde nichts gesendet. |
3 | Problem mit den Zugangsdaten. Diese Installation kann sich nicht authentifizieren. |
4 | Nicht gefunden. |
5 | Konflikt. |
6 | Vorbedingung fehlgeschlagen, einschließlich revision_conflict: die --expect-rev-Revision war veraltet. |
7 | Ratenbegrenzung. Beachten Sie Retry-After, angezeigt als retry_after_seconds. |
8 | Andere clientseitige Ablehnung. |
9 | Serverfehler. |
10 | Netzwerkfehler. |
11 | Zeitüberschreitung. |
12 | Konfigurationsfehler. |
13 | Der Vorgang selbst ist fehlgeschlagen. |
Übliche Fehlercodes im Umschlag:
| Code | Bedeutung | Nächster Schritt |
|---|---|---|
not_enrolled | Diese Installation enthält noch keine Projektanmeldeinformationen. | Erstellen Sie ein Projekt mit screenrig agent enroll --email ADDRESS --organization "NAME". Verwenden Sie screenrig login nur, wenn der Benutzer darum bittet, ein bereits bestehendes Konto zu verwenden. |
session_ended | Die Anmeldung wurde widerrufen, ist abgelaufen oder beendet. | screenrig login, genehmigt von einer Person im Dashboard. |
insufficient_access | Das Zugriffslevel der Sitzung kann dies nicht: Nur Lesen ändert nichts, und Vorschlagen kann nicht löschen, Bildschirme steuern oder ausgeben. | screenrig agent status zeigt effective_access. Wenn access_limited_by project oder person nennt, ändert der Projekteigentümer die Überprüfungseinstellung; sonst screenrig login --access manage, genehmigt von einer Person. |
approver_required | Nur der Projektinhaber oder ein Mitglied, das genehmigen kann, darf dies tun, z. B. einem Agenten Manage geben. | Bitten Sie den Projektinhaber, "Kann genehmigen" einzuschalten oder "Nur lesen" oder "Vorschlagen" zu wählen. |
playlist_not_approved | Die Playlist hat noch keine genehmigte Version, daher kann sie von keinem Bildschirm angezeigt werden. | Warten Sie auf die Überprüfung (screenrig reviews show ID) oder wählen Sie eine genehmigte Playlist. |
review_not_pending | Die Überprüfung wurde bereits entschieden, zurückgezogen oder ersetzt. | screenrig reviews show ID für seinen Status. |
login_denied, login_expired | Die Person hat die Anmeldung verweigert oder ihr 24-Stunden-Code ist abgelaufen. | Führen Sie screenrig login erneut aus. |
client_auth_failed | Der Schlüssel, das Secret oder die ID eines Service-Clients wurde abgelehnt. | Gleichen Sie die Schlüssel- oder Geheimnisdatei, mit der sich die Konfiguration anmeldet (login --client-id ID --client-key-file FILE oder --client-secret-file FILE), mit screenrig service-client show ID ab. |
capability_required | Dem Projekt fehlt die Fähigkeit, die dieser Befehl benötigt, wie z. B. screens oder advertiser. | screenrig project capabilities, dann wählen Sie das passende --intent für ein neues Projekt oder ändern Sie den Zweck des Projekts. |
rate_limited | Zu viele Anfragen im aktuellen Zeitraum. | Warten auf retry_after_seconds und dann erneut versuchen. |
free_organization_limit | Die Person besitzt bereits ihre kostenlose Standard-Organisation, daher kann project create keine weitere starten. | Fügen Sie das Projekt der in den Details genannten Organisation hinzu: screenrig project create NAME --organization-id ID. Eine weitere Organisation benötigt Plus, Premium oder Enterprise über das Kontaktformular unter https://screenrig.ai/contact#message. |
organization_plan_required | Die Organisation nimmt keine neuen Bildschirme auf, bis ein Plan dafür bezahlt wird. | Der Eigentümer verschiebt das Projekt mit screenrig project moves und screenrig project move --organization-id ID, oder die Organisation bucht Plus, Premium oder Enterprise über das Kontaktformular unter https://screenrig.ai/contact#message. |
Revisionen und Wiederholungen
Revisionsschutz ist optional. Lassen Sie --expect-rev weg, um die aktuelle Ressource ohne vorheriges Revisionslesen zu schreiben. Geben Sie es mit einer bekannten revision an, um veraltete Schreibvorgänge abzulehnen. Bei revision_conflict Ressource erneut abrufen, Änderung erneut anwenden und mit der zurückgegebenen Revision erneut versuchen. Bei einem mehrdeutigen Transportfehler mit derselben --idempotency-key erneut versuchen; die Steuerungsebene gibt das ursprüngliche Ergebnis zurück, anstatt zweimal zu schreiben.
Limit für Agentenanfragen
Die Agenten, CLI-Sitzungen und Service-Clients einer Organisation stellen in allen ihren Projekten zusammen bis zu 500 Anfragen pro Stunde bei Standard und Plus, 2.000 bei Premium und Education und 10.000 bei Enterprise. Es wird nichts berechnet. Über dem Limit scheitert ein Befehl mit rate_limited und retry_after_seconds: so lange warten, dann einmal wiederholen. Die Bildschirme spielen weiter und das Dashboard funktioniert weiter.
Jeder API-Aufruf eines Befehls ist eine Anfrage. Ein Flottenbefehl, screen assign oder screen tag mit mehreren Bildschirm-IDs oder --tag, ist eine Anfrage, egal wie viele Bildschirme er erreicht, und screen screenshot --tag stellt eine Anfrage je Ergebnisseite, der es folgt. Jede JSON-Seite von playback plays oder playback list ist eine Anfrage, und ein Wiedergabe-Export als CSV, XLSX oder PDF ist eine Anfrage für seinen gesamten Zeitraum.
Nicht gezählt werden: project show, agent status, billing, notes list, notes show, operations wait, events follow und sein Replay, die Bildschirmnachrichten screen reload, screen toast, screen identify, screen play-page, screen screenshot und screen live, Benachrichtigungs-E-Mails, Bildschirmhinweise und Webhook-Zustellungen sowie Kartendaten und Key/Value-Schreibvorgänge, die ein eigenes Limit haben.
Befehlsnamen und -erkennung
Verwenden Sie show zur Inspektion einer Ressource, list für Sammlungen und kv get / kv set für Werte. Verwenden Sie --name für Anzeigenamen, --screen-id, --app-id, --playlist-id und --release-id für Ressourcenselektoren, --expect-rev für Revisionsschutz und --after für Ereignis-Cursor. Die Gruppe ist app; „application“ ist der Ressourcenname. Kommentare behalten comment ACTION screen|playlist ID bei.
Verwenden Sie screenrig help --all für den vollständigen Bestand oder screenrig playlist init
--help für fokussierte Hilfe. Fügen Sie --json für Argument-Metadaten, Auswahlmöglichkeiten, Standardwerte, Beispiele und Optionsbeziehungen hinzu. Die Gruppen exactlyOne, atLeastOne, atMostOne und together werden vor Konfiguration oder Netzwerkzugriff geprüft; requires bedeutet, dass die erste Option alle verbleibenden Optionen erfordert. Lesen Sie stdin nur, wenn die Befehlshilfe - ausdrücklich unterstützt.
Ein neues Projekt erstellen
screenrig agent enroll --email ADDRESS --organization "NAME"
agent enroll erstellt eine Identität, eine Organisation, ein Projekt und eine Mitgliedschaft und speichert die Anmeldeinformationen für Identität und Projekt privat. Benennen Sie die Organisation nach dem Unternehmen, für das die Bildschirme sind, sonst nach der Person, so wie Sie sie aus der Konversation kennen. Übergeben Sie Screens nur, wenn Sie keines von beiden kennen, und screenRIG benennt die Organisation nach der E-Mail-Adresse. Das Projekt erhält einen gut lesbaren Namen aus zwei Wörtern, den die Person ändern kann. --organization ist erforderlich; --name benennt den Agenten separat, höchstens 80 Zeichen. Verwenden Sie die tatsächliche Kontakt-E-Mail der Person. Die Einschreibung sendet per E-Mail eine Einladung als Projektmitglied; sie gibt nicht preis, ob diese Adresse bereits eine Anmeldung hat. Die Person öffnet die Einladung und erstellt eine Anmeldung mit einem Passkey oder meldet sich an, um das Projekt ihrer bestehenden Anmeldung hinzuzufügen. Mit der Annahme wechselt das Projekt in die Organisation, zu der die verifizierte E-Mail-Domain der Person gehört, andernfalls in die kostenlose Standard-Organisation, die sie bereits besitzt, bei einem Namenskonflikt umbenannt.
Fügen Sie --intent advertising für ein Projekt hinzu, das Anzeigen kauft, anstatt Bildschirme zu koppeln. --setup-code CODE verknüpft das neue Projekt mit dem Website-Besuch, der den Code gezeigt hat, etwa K7QX-2MPD. --force ersetzt den Einschreibungs- oder ausstehenden Verbindungsstatus dieser Installation, wenn absichtlich ein anderes Projekt erstellt wird.
agent enroll (--email ADDRESS | --agentid-claim CODE) --organization NAME [--name NAME]
[--intent signage|advertising] [--setup-code CODE] [--force]
Mit AgentID anmelden
Ein Agent mit einem AgentID meldet sich bei https://api.screenrig.ai/agentid/start, an, erhält einen Anspruchscode, installiert das offizielle Plugin und führt screenrig agent enroll --agentid-claim CODE --organization "NAME" aus. Die verifizierte E-Mail des Eigentümers erhält die Dashboard-Einladung.
Bei einem bestehenden Konto anmelden
screenrig loginlogin meldet diese Installation bei einem bereits existierenden Konto an. Es druckt eine Dashboard-Adresse und einen Code und wartet dann bis zu 24 Stunden. Eine Person öffnet die Adresse, die den Code enthält, prüft, ob er übereinstimmt, passt das Projekt, Nur lesen, Vorschlagen oder Verwalten oder die Fähigkeitsbereiche an, wenn gewünscht, und drückt einmal Verbinden; eine Dashboard-Anmeldung der letzten Stunde ist der Nachweis, sodass keine zweite Passkey-Abfrage erfolgt. Die CLI speichert die Sitzung, wählt das genehmigte Projekt aus und gibt status: signed_in mit Projekt, Organisation und access zurück.
login [--project ID] [--access read|propose|manage] [--name NAME] [--no-wait] [--resume ID]
login --client-id ID (--client-key-file PATH | --client-secret-file PATH)
logout--access fragt nach einem Level; der Standard ist manage, und die Person entscheidet. --project schlägt das Projekt vor. --no-wait gibt status: pending mit dem verification_uri_complete, dem user_code und einem login_-Handle zurück, das kein Geheimnis enthält; login --resume ID wartet später auf die Genehmigung. Führen Sie login erneut auf einer angemeldeten Installation aus, um ein weiteres Projekt hinzuzufügen oder ein Nur-Lesen- oder Vorschlag-Projekt zu Verwalten zu erhöhen.
Jede Sitzung trägt Fähigkeitsbereiche: screens, content, playlists, advertising, reports und project. Eine Sitzung ruft nur Befehle in ihren Bereichen auf; reports liest auch jeden Bereich. Ein Befehl außerhalb davon gibt 403 forbidden mit Detail This agent credential lacks the <name> capability. zurück. Nur-Lesen-Sitzungen listen und lesen. Vorschlags-Sitzungen laden auch Medien hoch, schreiben Notizen und schlagen Medien-, Playlist- und Bildschirmänderungen vor, die auf die Überprüfung einer Person warten. Eine Änderung über das Sitzungsniveau hinaus gibt 403 insufficient_access zurück.
logout widerruft die Anmeldung auf dem Server und entfernt die gespeicherten Tokens; in der Konfiguration eines Service-Clients entfernt es den gespeicherten Client. Ein Fehler, der den Server möglicherweise nicht erreicht hat, behält sie, sodass ein erneutes Ausführen von logout sicher ist. doctor zeigt, wann die Sitzung endet: 90 Tage nach der letzten Nutzung und höchstens ein Jahr nach der Anmeldung. Siehe Authentifizierung.
Playlists vorbereiten, veröffentlichen und bearbeiten
Für fertige Bilder und Videos bereiten Sie eine Vollbild-Playlist in Wiedergabereihenfolge vor:
screenrig playlist init med_POSTER med_VIDEO --name "Lobby loop" --screen-id scr_LOBBY --output lobby.json
screenrig playlist validate lobby.json
screenrig screen publish scr_LOBBY lobby.json
screenrig screen screenshot scr_LOBBYValidieren Sie das Dokument, veröffentlichen Sie es und sehen Sie sich dann den echten Bildschirm mit screen screenshot an. playlist init akzeptiert lokale Bild-, Video- und Audiodateien, bereite med_-IDs, gepinnte rel_-Anwendungs-Releases, HTTP- oder HTTPS-Iframe-URLs und eingefügte <iframe>-Embed-Codes in Wiedergabereihenfolge, einschließlich gemischter Eingaben:
screenrig playlist init ./poster.png med_VIDEO rel_APP https://example.com --name Lobby --screen-id scr_LOBBY --output lobby.jsonLokale Dateien werden über den normalen Medienpfad hochgeladen, bis zu vier gleichzeitig, und warten auf die Bereitschaft. Dies erfordert ffmpeg und ffprobe, sofern nicht --no-transcode bereitgestellt wird. data.uploads listet source, media_id und reused jeder Datei sowie timing pro Phase auf. Audiodateien und bereite Audio-med_-IDs werden anstelle von Seiten zum Soundtrack, in Eingabereihenfolge. Die Vorbereitung schreibt das lokale Dokument und kann Medien hochladen; sie erstellt weder eine entfernte Playlist noch weist sie einen Bildschirm zu. Bestehende Medien müssen bereit sein. HTTP- und HTTPS-URLs dürfen LAN-Hosts und eingebettete Zugangsdaten enthalten und werden während der Vorbereitung nicht abgerufen. Ein eingefügter <iframe>-Embed-Code wird auf sein src gelesen und wird zu einer Iframe-Seite. Die Player-Web-App benötigt HTTPS-URLs ohne Benutzernamen oder Passwort.
Wird die Vorbereitung unterbrochen, führen Sie denselben Befehl erneut aus. Nichts wird geschrieben, bis jeder Upload bereit ist, sodass keine Ausgabedatei den erneuten Versuch blockiert, und eine Datei, deren Upload bereits abgeschlossen ist, gibt ihre vorhandene Medien-ID (reused: true) zurück, statt erneut hochgeladen zu werden.
Jede Eingabe außer Audio wird zu einer Vollbildseite mit schwarzem Hintergrund und 200 ms Crossfade. Bilder und Videos verwenden --fit contain|cover|fill (Standard contain). Videos sind stumm, sofern --sound nicht angegeben ist, wiederholen sich nicht und werden nach Abschluss fortgesetzt. Andere Seiten verwenden --duration-ms (Standard 8000), und eine Anwendungsseite bleibt 24 Stunden (86400000 ms) lang angezeigt, sofern dies nicht angegeben wird. Anwendungen und Iframes verwenden fill; Anwendungsfreigaben sind mit zeitgesteuertem Fortschritt und ohne Controller-Rechte fixiert. Bearbeiten Sie das Dokument für anwendungssteuerbaren Fortschritt. Überprüfen Sie die Freigabebereitschaft und die tatsächliche Wiedergabe über den Server und den vorgesehenen Player. Beim Veröffentlichen können die Antwort-Header geeigneter öffentlicher HTTPS-Iframe-Seiten geprüft werden. Eine Seite, deren X-Frame-Options oder frame-ancestors das Einbetten verweigert, kann vom Web-Player sowie von den Playern für macOS, Samsung Tizen, LG webOS und BrightSign nicht angezeigt werden. Erkennt die Veröffentlichung eine Ablehnung, gelingt der Schreibvorgang trotzdem: screen publish und Playlist-Schreibvorgänge wie playlist create|update|patch geben eine iframe_framing_refused-Warnung aus, die Seite und Primitive nennt, und events list zeigt eine playlist.iframe_framing_refused-Warnung.
Geben Sie --screen-id an, um die Zielmaße und Revision zu lesen. Das Ergebnis enthält data.screen_id, data.screen_revision und data.publish.argv. Übergeben Sie dieses Argumentarray ohne Shell-Splitting an den gebündelten screenrig-Launcher: Es bewahrt Pfade, Konfiguration und API-Ursprung. Fügen Sie --expect-rev explizit hinzu, um spätere Bildschirmänderungen abzusichern. Ziel-Metadaten bleiben außerhalb des erstellten Dokuments. Ein Bildschirm mit Videowand liefert die Leinwand seiner Wand und das passende format.
Um die Leinwand zu überschreiben, geben Sie sowohl --target-width als auch --target-height an. Diese funktionieren auch ohne Bildschirm, in diesem Fall werden keine Veröffentlichungsargumente zurückgegeben. Unbekannte oder mehrere gemeldete Flächen erfordern explizite Abmessungen. Ausgabedateien sind standardmäßig exklusiv; verwenden Sie --overwrite, um eine vorhandene Authoring-Datei atomar zu ersetzen. Eine leere Datei gilt nicht als vorhanden. Übergeordnete Verzeichnisse werden automatisch erstellt. URL- und Release-ID-Eingaben mit expliziten Abmessungen funktionieren ohne Anmeldung.
screen publish <screen-id> <file> erstellt eine neue Playlist, weist sie mit einer optionalen Bildschirm-Versionssperre zu, liest die Zuweisung zurück und wartet, bis der Player sie anzeigt. Es aktualisiert keine vorhandene Playlist nach Namen. Anzeigenamen können sich wiederholen; verwenden Sie die Playlist-ID für eine explizite playlist update. Das JSON-Ergebnis meldet playlist_id, playlist_revision, screen_id, screen_revision, stage, assignment_verified, playback_verified und playback.
Das Warten ist durch --timeout begrenzt (Standard 120000 ms) und fragt alle --poll-ms ab (Standard 2000 ms). Es endet, sobald der Player die Playlist auf dem Bildschirm bestätigt: stage ist playing und playback_verified ist true. Andernfalls bleibt stage assigned, und playback.reason, als Warncode mit seinem nächsten Schritt wiederholt, nennt den Grund:
playback.reason | Bedeutung |
|---|---|
screen_offline | Kein Player ist verbunden; sie wird abgespielt, sobald sich der Player wieder verbindet. |
playlist_not_effective | Eine Übernahme, Kampagne oder ein Zeitplan zeigt playback.effective_playlist_id; der veröffentlichte Standard wird abgespielt, wenn das endet. |
playback_failed | Der Player hat ein fehlgeschlagenes Upgrade gemeldet; playback.code nennt die Ursache. |
playback_pending | Das Warten lief ab, während heruntergeladen oder vorbereitet wurde (playback.state). |
not_waited | --no-wait wurde nach der Zuweisung ohne Warten zurückgegeben. |
Eine playback_partial-Warnung bedeutet, dass die Playlist ohne playback.missing_page_count Seiten abgespielt wird, die nicht in den Speicher des Players passen.
Wenn das Projekt eine Überprüfung von Agentenänderungen erfordert oder die Sitzung Propose-Zugriff hat, stoppt screen publish sobald die Playlist oder ihre Zuweisung vorgeschlagen wird: stage ist pending_review, das Ergebnis benennt beide Überprüfungen, und der Umschlag bleibt ok: true. Es wird nichts abgespielt, bis eine Person zustimmt. Fügen Sie --note TEXT hinzu, um dem Prüfer mitzuteilen, was sich geändert hat; siehe Reviews. --no-wait kehrt nach der Zuweisung zurück. Während eine iframe-Seite angezeigt wird, ist ein Screenshot der Player-Web-App screenshot_unavailable (unsupported_surface); eine Anwendungsseite wird so erfasst, wie die Anwendung sich selbst rendert.
Das Veröffentlichen speichert automatisch ein privates lokales Journal. Nach einem unklaren Fehler wiederholen Sie denselben Befehl und die Eingabe mit derselben Konfiguration, um fortzufahren. Wenn die Playlist-Erstellung vor dem Fehler bei der Zuweisung erfolgreich war, identifiziert der Fehler die erstellte Playlist. Löschen Sie diese nicht oder starten Sie keine weitere Erstellung zur Wiederherstellung. Ein Revisionskonflikt erfordert die Überprüfung des Bildschirms und die Abstimmung der beabsichtigten Zuweisung; eine bereits erstellte Playlist kann explizit mit screen assign zugewiesen werden. Veröffentlichen aktualisiert die erwartete Revision niemals stillschweigend. Unvollständige Wiederherstellung endet nach dem 24-Stunden-Server-Idempotenzfenster; prüfen und klären Sie, bevor Sie weitere Schreibvorgänge durchführen.
Um eine vorhandene Playlist zu bearbeiten:
screenrig playlist show pl_EXISTING --output lobby.json
screenrig playlist update pl_EXISTING lobby.jsonplaylist show --output schreibt das editierbare Dokument, {name, pages} plus die audio, format und fields, die die Playlist hat, und gibt seinen Pfad, playlist_id und die Quell-revision auf stdout zurück. Optional übergeben Sie diese Revision mit --expect-rev, um das Update zu schützen. Es bewahrt dynamische Selektoren, Zeitpläne, Bewegung und angeheftete Anwendungsfreigaben und entfernt serverabgeleitete und schreibgeschützte Felder, sodass die Datei so, wie sie geschrieben ist, validiert und aktualisiert. Kommentare bleiben separat; Seitenkommentare werden per Seiten-ID übernommen. Einfaches playlist show ist eine Inspektionsantwort; --editable ohne --output gibt data.document, data.playlist_id und data.revision zurück. Das Aktualisieren einer Playlist betrifft jeden zugewiesenen Bildschirm. In Prüfung schlägt playlist update das neue Dokument vor, und playlist show gibt weiterhin die Live-Version zurück, bis eine Person es genehmigt. Um einen Teil einer Playlist zu ändern, verwenden Sie playlist rename, playlist patch oder playlist page add|replace|remove, die nur das Geänderte senden.
K/V und Kommentar schreiben akzeptieren --file - für stdin. Verwenden Sie playlist show ID --editable --human für das bearbeitbare Dokument auf stdout. Anwendungs- und Playlist-Anzeigenamen können sich wiederholen; verwenden Sie Ressourcen-IDs für Aktualisierungen.
Eine Anwendungsfreigabe ersetzen
Nach einem erfolgreichen app update nehmen Sie data.application.release_id und identifizieren die genaue Playlist, Seite und Anwendungsprimitive, die geändert werden sollen. Vorschau der Ersetzung:
screenrig playlist replace-release pl_EXISTING --page board-page --primitive board --release-id rel_NEWDies ist eine rein lesende Auswirkungsprüfung. Prüfen Sie data.previous_release_id, data.release_id und data.affected_screens, einschließlich archivierter Zuweisungen. Wenden Sie direkt mit --apply an. Um diese Auswirkungsprüfung zu aktivieren, liefern Sie auch --expect-impact mit der Vorschau-data.impact:
screenrig playlist replace-release pl_EXISTING --page board-page --primitive board --release-id rel_NEW --applyAndere Primitive und Einstellungen bleiben erhalten. Das Update betrifft jeden Bildschirm, der dieser geteilten Playlist zugewiesen ist; archivierte Bildschirme behalten den neuen Pin für die spätere Verwendung. Wenn --expect-impact angegeben wird, erfordert eine geänderte Ersatz-, Revision- oder beobachtete Bildschirmauswirkung eine neue Vorschau. Direkte Anwendung überspringt die Bildschirmumfrage; affected_screens wird ausgelassen. Eine bereits gesetzte Veröffentlichung gelingt ohne Schreibvorgang. Zuweisungen können sich nach dem Snapshot ändern: Der Server prüft die Playlist-Revision atomar nur, wenn --expect-rev angegeben wird. Der Server validiert Verfügbarkeit und Eigentum der Veröffentlichung bei der Anwendung. Bestehende Pins bleiben bis zur Anwendung unverändert; danach überprüfen Sie Manifestrevisionen und Wiedergabe auf den betroffenen Bildschirmen. In der Überprüfung schlägt --apply den neuen Pin vor; fügen Sie --note TEXT für den Prüfer hinzu.
playlist validate, create, update und patch sowie screen publish akzeptieren - als Eingabedatei, um stdin zu lesen, und playlist page add|replace akzeptieren --file -. JSON-Container werden nie in erstellte Dateien geschrieben. --expect-rev schützt eine Revision. Das Flag weglassen, um die aktuelle Ressource ohne Revisionsvoraussetzung zu schreiben. Eine angegebene veraltete Revision gibt weiterhin revision_conflict zurück.
Den Pfad kurz halten
- Mit dem offiziellen Plugin starten
- Player öffnen
- Wählen Sie einen Erstellungsweg
- Offizielles Plugin installieren
- Funktionen ansehen
Das gebündelte CLI verwendet api.screenrig.ai; Player verwenden play.screenrig.ai; das Dashboard liegt unter screenrig.ai/dashboard; Releases verwenden isolierte Ursprünge unter apps.screenrig.ai. Anwendungspakete erreichen native Player über eine private, serververmittelte Auslieferung. Die interne Transportreferenz bleibt für Transport-Tools verfügbar.