Référence des commandes CLI

Lire l’enregistrement du projet et son crédit restant.

project show

Aucun paramètre.

screenrig project show

data.credit_remaining est un nombre entier de crédits. En dessous de 1000, l’enveloppe peut porter un avertissement credits_low. Jusqu’au 1er janvier 2027, l’utilisation est gratuite dans une certaine mesure, donc le crédit restant est un compteur entier qu’un agent peut lire, pas une instruction d’arrêt.

Définir le nom que les gens voient dans le sélecteur de projet du tableau de bord.

project rename NAME

Lire le forfait du projet, les indicateurs de fonctionnalités indépendants screens et advertiser et l’ensemble des capacités effectives. Un refus de route l’emporte sur une lecture périmée des capacités.

project capabilities

Lire la disponibilité quotidienne des écrans du projet sur des jours UTC.

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

La plage et les valeurs par défaut sont celles de screen uptime. data.items liste une ligne par jour UTC, du plus ancien au plus récent : online_s et offline_s cumulés sur les écrans avec un état enregistré ce jour-là, availability, coverage (la part de la journée de ces écrans avec un état enregistré), et screens (combien avaient un état enregistré). La ligne d’aujourd’hui couvre les intervalles terminés jusqu’à présent ; screen list montre qui est en ligne maintenant.

Lire la santé de la flotte par heure UTC : écrans rapportant, chauds, afficheur déconnecté, plantage.

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

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

data.items liste la santé de la flotte par heure UTC : hour, screens_reporting, hot (température maximale à 80 °C ou plus), display_disconnected, et crashing (3 crashs ou plus en 24 heures). Le CLI suit next_cursor jusqu’à la fin et répond chaque heure avec next_cursor null. Les heures suivent les rapports avec un délai d’environ 5 minutes.

Créer, lister ou révoquer des invitations de membres de projet et d’acheteurs de publicité.

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 utilise member par défaut. La livraison par courriel est la valeur par défaut et expire après sept jours. --email accepte des destinataires séparés par des virgules, jusqu’à cinquante par demande. --link est réservé aux membres, nécessite exactement un destinataire prévu, et renvoie une URL d’invitation de vingt-quatre heures une fois pour un transfert direct. Ne mettez jamais cette URL dans des journaux, notes ou une transcription partagée. Les listes ne la renvoient jamais.

Les acheteurs d’annonces utilisent uniquement le courriel et ont besoin d’un écran ou d’un périmètre de créneau possédé (ou les deux). --screen-id et --slot-id acceptent des ID séparés par des virgules ; --policy sélectionne trusted ou review_required. Les filtres de statut sont queued, sent, issued, accepted, revoked, expired et 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

Les agents n’acceptent pas les invitations. La personne invitée ouvre le courriel, se connecte ou crée une clé d’accès, et accepte dans le tableau de bord. L’inscription par lien vérifie d’abord leur courriel. Révoquer une invitation acceptée ne supprime pas une adhésion; utilisez les contrôles d’adhésion acheteur pour révoquer l’accès publicitaire.

Signaler si cette installation détient une crédentiale utilisable.

agent status

Aucun paramètre.

screenrig agent status

Lecture seule. Ne modifie jamais l’état local ou serveur, et ne coûte rien. Le résultat porte le access de session, son effective_access et, quand le paramètre de revue du projet ou un membre sans droit d’approbation le maintient plus bas, access_limited_by (project ou person).

Connectez cette installation à un compte existant, avec l’approbation d’une personne dans le tableau de bord.

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

screenrig login --access read

Imprime l’adresse du tableau de bord et un code de huit lettres sur stderr, puis attend jusqu’à 24 heures. La personne vérifie que le code correspond et appuie une fois sur Connecter, sans deuxième invite de clé d’accès après une connexion au tableau de bord dans l’heure précédente. L’enveloppe rapporte status: signed_in, le projet, l’organisation et access. L’exécuter à nouveau sur une installation connectée ajoute un projet ou élève un projet en lecture seule ou à proposer en gestion. Le refus est login_denied et l’expiration est login_expired.

Terminer la connexion de cette installation et supprimer ses jetons.

logout

Aucun paramètre.

screenrig logout

Révoque la connexion sur le serveur, puis supprime les jetons stockés et rapporte status: signed_out. Un échec qui n’a peut-être pas atteint le serveur les conserve, donc relancer est sans risque. Exécutez screenrig login pour vous reconnecter.

Ouvrez l’URL ordinaire du tableau de bord. Cette commande ne crée pas de lien de connexion, ne crée pas de session et ne nécessite pas d’identifiant d’agent.

dashboard [open]

screenrig dashboard

Le tableau de bord affiche les projets de la personne après connexion. La sélection de projet dans le navigateur ne change pas le projet lié à un agent.

Demander un courriel de réinitialisation de connexion sans justificatif d’agent.

dashboard reset-sign-in --email ADDRESS

L’accusé de réception ne révèle pas si le courriel a une connexion. Le réinitialisation envoyée par courriel expire après une heure ; la personne crée une nouvelle clé d’accès. La complétion remplace ses identifiants de connexion et révoque les autres sessions.

Vérifiez cette installation et signalez chaque vérification par nom.

doctor [--repair-config]

screenrig doctor

data.checks nomme chaque vérification et son statut : le runtime Node, le chemin de configuration résolu et ses permissions, l’origine du plan de contrôle et ses routes de service, la capacité feedback annoncée, et la chaîne d’outils multimédias optionnelle (ffmpeg, ffprobe, encoder_libx264, encoder_libx265, encoder_libwebp, cwebp, filter_hdr_tonemap).

Toute vérification échouée fait sortir doctor avec un code non nul, donc lisez les noms individuels avant de déclarer l’installation non saine. Une chaîne d’outils média manquante affecte seulement media upload.

Imprime la version CLI intégrée et son adaptateur de protocole.

version

Aucun paramètre.

screenrig version

Exécutez ceci en premier dans une session. Une enveloppe réussie prouve que le lanceur a résolu le CLI intégré. --version et -V font la même chose depuis n’importe où dans la ligne de commande.

Lister les clients de service de ce projet, actifs et révoqués, avec leurs clés, identifiants secrets et usages.

service-client list

Aucun paramètre.

screenrig service-client list

Ne jamais renvoyer un secret.

Afficher un client du service.

service-client show ID

screenrig service-client show scl_ID

Liste l’kid de chaque clé et l’css_ de chaque secret pour la rotation.

Créer un client de service appartenant à ce projet.

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

Nécessite les autorisations d’identité, de projet et d’administration de l’organisation décrites ci-dessus. Au maximum 50 clients actifs par organisation, tous projets confondus. Une clé sans son propre kid est identifiée par son empreinte RFC 7638.

Enregistrer une seconde clé publique pour une rotation sans interruption.

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

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

Un client détient au maximum deux clés.

Générer un second secret pour une rotation sans interruption.

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

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

Un client détient au maximum deux secrets. Le secret actuel continue de fonctionner jusqu’à ce que vous le supprimiez.

Supprimer une clé ; les jetons émis avec celle-ci cessent de fonctionner en quelques secondes.

service-client remove-key ID --kid KID

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

Un client conserve au moins une clé ou un secret.

Supprimer un secret ; les jetons émis avec celui-ci cessent de fonctionner en quelques secondes.

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

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

Révoquer un client de service de façon permanente.

service-client revoke ID --yes

screenrig service-client revoke scl_ID --yes

Supprime ses clés et secrets ; ses jetons cessent de fonctionner en quelques secondes. L’enregistrement reste pour audit.

Générer une image fixe pleine page présentable dans la boutique de médias du projet.

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

La commande stocke un WebP avec perte dans le magasin de médias du projet et renvoie data.media_id (med_…). Ne téléversez pas à nouveau les octets. N’imprimez jamais les pixels ni l’invite. L’arbre d’auteur et le contrat d’invite vivent sur Compose.

Convertir un fichier local en octets de livraison, le téléverser et attendre que l’objet soit prêt.

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

La vidéo devient un MP4 : profil élevé H.264 niveau 4.2 par défaut, ou H.265 avec --codec hevc, en yuv420p balisé Rec. 709. Une source HDR est mappée en tonalité vers Rec. 709. L’audio, lorsque la source en a, est AAC à 192 kbit/s, 48 kHz, stéréo.

Les images fixes deviennent WebP avec perte à la qualité 90, conservant l’alpha si la source en a. Une source animée boucle indéfiniment. Un WebP déjà conforme à la limite de taille est transmis sans réencodage.

L’audio devient un MP3 pour une bande sonore de liste de lecture. Une source MP3 se téléverse inchangée ; les sources WAV, AAC, M4A, OGG et FLAC sont converties en MP3 128 kb/s, ce qui nécessite une build ffmpeg avec libmp3lame. Une piste dure de 1 seconde à 3 heures. playlist init transforme les entrées audio en pistes de bande sonore plutôt qu’en pages. L’objet prêt est un objet média audio avec une durée. Il ne peut pas être placé sur une page ; nommez-le dans la liste de lecture audio bande sonore à la place.

L’identifiant de l’objet prêt est data.media_id. La même valeur est data.id et data.operation.result.media_id. Cet identifiant est ce qu’un sélecteur de liste de lecture prend.

Un nom de fichier peu informatif tel que video.mp4 ajoute un avertissement consultatif generic_filename à l’enveloppe. Le téléversement réussit quand même et la CLI ne renomme jamais le fichier ; choisissez le nom avant d’exécuter la commande.

Les conversions exécutent ffmpeg et ffprobe depuis PATH, ou depuis les chemins absolus dans SCREENRIG_FFMPEG et SCREENRIG_FFPROBE. Les images fixes préfèrent l’encodeur ffmpeg libwebp et retombent sur cwebp sur PATH ou SCREENRIG_CWEBP. Exécutez doctor avant le premier téléversement d’une session.

--preset signage-1080p30 limite le grand côté à 1920, le petit côté à 1080, et le taux à 30 ips constant. signage-4k30 limite le grand côté à 3840, le petit côté à 2160, et le taux à 30 ips constant. Les deux fonctionnent avec du contenu paysage, portrait et carré. --no-audio omet l’encodage audio pour les clips silencieux. Ces options s’appliquent uniquement à la vidéo.

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

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

Le téléversement arrive à la racine de la bibliothèque et est déplacé dans le dossier une fois prêt. media upload-batch --folder déplace chaque élément téléversé de la même manière.

Avec un accès Proposer, ou lorsque le projet exige une révision pour les modifications d’agent, un nouveau téléversement attend la révision d’une personne avant qu’une étiquette, un dossier ou un sélecteur all ne le diffuse ; voir Révisions.

Téléversez plusieurs fichiers locaux à partir d’un manifeste, en reprenant depuis un fichier d’état requis.

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

L’enveloppe transporte data.items[] dans l’ordre du manifeste, chacun avec path, source_filename, sha256, outcome (accepted ou resumed), et media_id. data.failed[] transporte les éléments qui n’ont pas abouti.

Remplacer le fichier d’un média sur place. Son id, ses playlists et ses programmations continuent de fonctionner.

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"

Le média garde son id, ses étiquettes et son dossier, si bien que chaque playlist et chaque programmation qui le nomme joue le nouveau fichier au prochain manifeste, et que les sélecteurs d’étiquette, de dossier et all le prennent aussi en compte. Rien n’est reprogrammé. La commande exécute les mêmes étapes que media upload (conversion, limite d’octets vidéo du plan, limites de dimensions, quota de stockage, transfert signé) puis remplace au lieu d’ajouter un nouveau média. Elle n’accepte ni --tag ni --folder.

Par défaut la commande attend la fin du traitement. data.media_id et data.id sont l’id du média, data.version est le numéro du nouveau fichier dans media versions, et data.revision est la nouvelle révision du média. data.warnings, data.operation, data.upload, data.transcode et la durée sont rapportés comme pour media upload, et l’id d’opération figure sur l’enveloppe. Avec --no-wait, data.operation est l’opération acceptée, et data.version et data.warnings sont absents.

Un changement de rapport d’aspect est permis. L’enveloppe porte un avertissement aspect_ratio_changed, et data.warnings[].playlists nomme les playlists qui utilisent le média ; vérifiez donc leur rendu. Un fichier aux mêmes octets que l’actuel est refusé avec resource_conflict (code de sortie 13).

Chaque fichier antérieur reste dans l’historique du média et compte dans les octets stockés jusqu’à la suppression de sa version ; voir media versions.

Avec l’accès Propose, ou quand le projet exige une révision pour les modifications d’agent, le remplacement attend une personne et la commande réussit (code de sortie 0) : data.status est pending_review, data.review_id nomme la révision, l’avertissement pending_review donne son URL et data.next est screenrig reviews show ID. Le média continue de jouer son fichier actuel jusqu’à l’approbation d’une personne ; dites-lui donc qu’il attend et ne répétez pas l’écriture. Un remplacement plus récent du même média remplace celui qui attend. Voir Révisions.

Lister les fichiers qu’a eus un média, le fichier en service en premier.

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

screenrig media versions med_01EXAMPLEIMAGE0000000000

data.items contient une entrée par fichier qu’a eu le média : number, current, filename, content_type, sha256, bytes, width, height, duration_ms, codecs, source (upload, replace, sync ou restore), note, by (type person, agent, client ou sync, avec identifiant et nom) et restored_from. Le fichier en service vient en premier (current: true), puis les autres du plus récent au plus ancien. La version 1 est le premier téléversement ; chaque remplacement, restauration ou changement de synchronisation de médias ajoute le numéro suivant.

Sans --limit ni --cursor, toutes les pages sont lues et data.next_cursor vaut null. Avec l’un des deux, une seule page est lue : tant que data.next_cursor est une chaîne, relancez la commande avec --cursor défini sur cette valeur. L’accès Lecture seule suffit. Les octets d’une version passée restent stockés et comptent dans les octets stockés du projet jusqu’à ce que media version delete les supprime ; le nombre de versions conservées n’est pas limité, et les octets stockés au-delà du stockage gratuit du plan sont facturés comme tout autre stockage.

Remettre une version passée en service comme nouvelle version.

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"

Le média garde son id et passe à une nouvelle révision, et chaque playlist et chaque programmation qui le nomme rejoue ce fichier. La version qu’elle copie reste dans l’historique et partage ses octets ; la nouvelle version compte dans les octets stockés comme n’importe quelle autre. data.media est le média et data.warnings porte aspect_ratio_changed, qui nomme les playlists utilisant le média, quand le fichier restauré a un autre rapport d’aspect.

La version en service ne peut pas être restaurée (resource_conflict, code de sortie 5), et une version inconnue est not_found (code de sortie 4). Avec l’accès Propose, ou quand le projet exige une révision pour les modifications d’agent, la restauration attend une personne et la commande réussit (code de sortie 0) : data.status est pending_review avec data.review, l’avertissement pending_review donne son URL et data.next est screenrig reviews show ID. Le média continue de jouer son fichier actuel jusqu’à l’approbation d’une personne ; ne répétez donc pas l’écriture.

Supprimer une version passée et ses octets stockés.

media version delete <id> --number N

screenrig media version delete med_01EXAMPLEIMAGE0000000000 --number 2

L’enregistrement de la version disparaît et ses octets quittent aussitôt les octets stockés du projet. L’objet stocké est retiré au bout de 24 heures, sauf si une autre version ou le fichier en service détient le même fichier. Une version supprimée ne peut pas être restaurée. La version en service ne peut pas être supprimée, et aucune version ne peut l’être tant qu’un remplacement du média attend une révision ; les deux cas sont resource_conflict (code de sortie 5), et media versions ID montre quelle version est en service. Une version inconnue est not_found (code de sortie 4). La suppression exige l’accès Manage : un identifiant Propose est refusé avec insufficient_access, et la suppression n’est jamais proposée à révision.

Lire un objet média, y compris sa révision actuelle.

media show <id>

screenrig media show med_01EXAMPLEIMAGE0000000000

Écrivez une version stockée sur disque pour inspection. N’imprimez jamais les octets.

media download <id> [--output FILE]

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

L’enveloppe rapporte media_id, path, bytes, sha256, content_type, primitive, filename, optionnel source_filename, et width / height. Elle ne transporte jamais de pixels. Utilisez ceci pour valider une image générée avant qu’elle ne soit affichée.

Lister les objets médias, filtrés optionnellement par étiquette et type primitif.

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

Chaque ligne comporte folder_id, qui est absent à la racine de la bibliothèque.

Modifier ou effacer la balise sur un objet. Sa règle de disponibilité se définit avec media availability.

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

screenrig media update med_01EXAMPLEIMAGE0000000000 --tag LobbyLoop

Avec un accès Proposer, ou lorsque le projet exige une révision pour les modifications d’agent, le retagging des médias approuvés répond à ok avec l’avertissement media_review_pending : les écrans continuent de le diffuser avec ses étiquettes approuvées jusqu’à ce qu’une personne approuve le changement, et un rejet remet les étiquettes en place. Sa révision apparaît dans reviews list en quelques secondes ; un retag qui ne change aucune playlist approuvée ni playlist en attente de révision s’applique seul. Voir Révisions.

Définit ou efface le moment où les sélecteurs dynamiques peuvent choisir un fichier.

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

screenrig media availability med_01EXAMPLEIMAGE0000000000 --file rule.json

Les membres et le comportement de la règle figurent sous Disponibilité des médias.

Supprimer un objet média.

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

screenrig media delete med_01EXAMPLEIMAGE0000000000

Déplacez les fichiers médias et les dossiers dans un dossier, ou retour à la racine de la bibliothèque.

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

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

Le déplacement est une requête tout ou rien. Un dossier ne peut pas se déplacer dans lui-même ni dans un dossier qu’il contient, et les dossiers s’imbriquent au maximum sur 10 niveaux. Les éléments déjà dans la destination restent tels quels. data.media et data.folders comptent ce qui a été déplacé.

Le déplacement de fichiers modifie ce que les sélecteurs by:folder de leurs anciens et nouveaux dossiers jouent, à partir de la résolution du sélecteur suivant de chaque écran ; déplacer un dossier ne change pas les fichiers propres à un dossier. Sous Propose access, ou lorsque le projet exige une révision pour les modifications d’agent, chaque fichier déplacé attend la révision d’une personne (reviews list) et les listes de lecture approuvées continuent de le jouer par le dossier avec lequel il a été approuvé ; voir Révisions.

Lister les dossiers médias du projet.

media folder list [--library]

screenrig media folder list
screenrig media folder list --library

Retourne chaque dossier du projet, au maximum 1000, ordonnés par nom : data.items avec id, name, parent_id (null à la racine de la bibliothèque) et revision. Construisez l’arborescence à partir de parent_id. Le dossier d’un fichier est folder_id sur media list et media show ; il est absent à la racine de la bibliothèque.

Lire un dossier de médias.

media folder show <id>

screenrig media folder show mfd_01EXAMPLEFOLDER000000000

L’enveloppe transporte le name, parent_id et revision du dossier.

Créer un dossier de médias à la racine de la bibliothèque ou dans un autre dossier.

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

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

Une organisation contient au maximum 1000 dossiers, tous projets confondus, imbriqués jusqu’à 10 niveaux. Une liste de lecture joue les fichiers d’un dossier avec un sélecteur by:folder.

Renommez un dossier de médias, ou déplacez-le avec tout son contenu dans un autre dossier.

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

Un dossier ne peut pas être déplacé dans lui-même ou dans un dossier qu’il contient, et un déplacement doit garder chaque dossier dans une profondeur maximale de 10 niveaux. Envoyer les valeurs actuelles est une opération sans effet.

Supprimer un dossier média. Ses fichiers et dossiers sont déplacés d’un niveau vers le haut.

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

screenrig media folder delete mfd_01EXAMPLEFOLDER000000000

Supprime uniquement le dossier. Ses fichiers et dossiers montent dans son parent, ou dans la racine de la bibliothèque s’il n’en a pas. Un sélecteur by:folder qui le nomme ne correspond plus à rien, donc redirigez d’abord ces listes de lecture.

Ajoutez votre propre application Microsoft Entra, ou une connexion Microsoft du projet, pour qu’une synchronisation puisse lire un dossier SharePoint ou OneDrive Entreprise.

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

Dans le Microsoft Entra admin center, inscrivez une application à locataire unique sans URI de redirection, ajoutez un secret client (copiez sa Value, pas son Secret ID), ajoutez l’autorisation d’application Microsoft Graph Sites.Selected (puis accordez à l’application l’accès en lecture à chaque site) ou Files.Read.All, et accordez le consentement de l’administrateur. L’application appartient à ce projet. Exécutez ensuite media sync account test.

Ajoutez un compte Dropbox et affichez le lien à usage unique que son titulaire ouvre, connecté à Dropbox, pour le connecter.

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 est le lien et data.authorize_expires_at son expiration. Le CLI n’ouvre jamais de navigateur : envoyez le lien à la personne titulaire du compte Dropbox, qui autorise un accès en lecture seule (files.metadata.read, files.content.read, account_info.read). Exécutez media sync account show jusqu’à ce que data.state soit ready (il vaut d’abord pending_consent), puis media sync create dropbox. Votre propre application Dropbox doit avoir ces autorisations activées et l’URI de redirection qu’affiche la sortie.

Ajoutez un compte Google Drive, prêt immédiatement, et affichez l’adresse du compte de service avec laquelle les dossiers sont partagés.

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 est l’adresse avec laquelle partager chaque dossier ; le rôle Lecteur suffit. Avec le compte de service de screenRIG, un dossier ne se synchronise que si un membre de ce projet dont le courriel est vérifié l’a partagé ou en est propriétaire (sinon media_sync_sharer_not_member). Avec votre propre clé, tout dossier partagé avec le compte de service se synchronise.

Liste les comptes de synchronisation de médias de ce projet avec leur type, leur état et leur dernier test ; aucun secret n’est renvoyé.

media sync account list

Aucun paramètre.

screenrig media sync account list

Consultez un compte : son locataire et son ID client, son état, son secret masqué et son dernier test.

media sync account show <id>

screenrig media sync account show msa_01EXAMPLEACCOUNT0000000

Un compte Dropbox affiche aussi qui l’a connecté et son app_key ; un compte Google Drive affiche son service_account_email.

Renommez un compte, modifiez le locataire, l’ID d’application ou le secret client d’une application Microsoft, ou remplacez la clé propre d’un compte Google Drive.

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

Au moins un changement est requis. Un changement d’identifiants efface last_test : testez de nouveau le compte. Les secrets client Entra expirent : remplacez donc le secret ici avant son expiration.

Créez un nouveau lien à usage unique pour connecter, ou reconnecter, un compte Dropbox.

media sync account connect <id>

screenrig media sync account connect msa_01EXAMPLEACCOUNT0000000

data.authorize_url et data.authorize_expires_at portent le lien, qui remplace le précédent. Envoyez-le à la personne titulaire du compte Dropbox. Utilisez-le quand la personne n’a pas terminé ou que le compte est reconnect_required (Dropbox n’honore plus la connexion). Un compte connecté reste connecté jusqu’à ce que le nouveau consentement soit terminé, et un autre compte Dropbox qui se connecte reprend la connexion.

Vérifiez un compte : l’ouverture de session et les autorisations Graph d’une application Microsoft, ou la connexion ou la clé d’un compte Dropbox ou Google Drive.

media sync account test <id>

screenrig media sync account test msa_01EXAMPLEACCOUNT0000000

La réponse est stockée sous last_test. Pour une application Microsoft, le test rapporte credentials (Microsoft a émis un jeton ; un refus porte son code AADSTS, comme AADSTS7000215 pour un secret qui est l’ID plutôt que la Value) et permissions (les autorisations d’application Graph que le jeton porte). Sites.Selected seule est un avertissement : chaque site a encore besoin de son autorisation, et un lien de partage exige Files.Read.All. Le test ne juge ni l’autorisation d’un site ni un dossier : media sync create lit le dossier que vous nommez. Une vérification échouée donne data.ok à false avec la sortie 0.

Supprimez un compte qu’aucune synchronisation n’utilise.

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

screenrig media sync account delete msa_01EXAMPLEACCOUNT0000000

Tant que des synchronisations utilisent le compte, la réponse est resource_conflict (sortie 5), en les nommant : supprimez-les d’abord.

Synchronisez un dossier SharePoint ou OneDrive Entreprise dans un dossier de médias.

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"

Un dossier que Microsoft refuse donne media_sync_source_refused (sortie 5), avec l’autorisation à accorder ; rien n’est stocké.

Synchronisez un dossier Dropbox dans un dossier de médias.

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"

Chaque exécution reprend à partir de la position enregistrée par Dropbox dans le dossier et ne lit que ce qui a changé. Un dossier que le compte ne peut pas ouvrir donne media_sync_source_refused, et une connexion que Dropbox n’honore plus donne dropbox_reconnect_required (media sync account connect) : les deux donnent la sortie 5, rien n’est stocké.

Synchronisez un dossier Google Drive, partagé avec le compte de service d’un compte, dans un dossier de médias.

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

Avec le compte de service de screenRIG, le dossier ne se synchronise que si un membre de ce projet dont le courriel est vérifié l’a partagé ou en est propriétaire (media_sync_sharer_not_member, sortie 3, rien n’est stocké). Chaque exécution le vérifie de nouveau, et un dossier qui perd une telle personne arrête la synchronisation à l’état error, ses médias étant conservés : partagez-le de nouveau depuis le compte Google d’un membre, puis exécutez media sync update ID --resume. Les fichiers Google Docs, Sheets et Slides sont ignorés comme unsupported_type. Un dossier que l’adresse ne peut pas ouvrir donne media_sync_source_refused (sortie 5) : partagez-le avec le compte de service.

Liste les synchronisations de médias de ce projet avec leur dossier de médias, leur cadence, leur état et le statut de leur dernière exécution.

media sync list

Aucun paramètre.

screenrig media sync list

Consultez une synchronisation et le résumé de sa dernière exécution.

media sync show <id>

screenrig media sync show msy_01EXAMPLESYNC000000000

data.last_run porte status (ok, partial ou error), added, updated, removed, pending_delete (fichiers supprimés qu’un écran garde encore, en attente dans le dossier Removed) et skipped avec la raison de chaque fichier (unsupported_type, too_large, storage, subfolder, download_failed, unreadable, in_use) ; une exécution échouée porte error avec un code et un detail qui indiquent la correction. data.source ajoute path pour Dropbox et shared_by pour Google Drive.

Une synchronisation à l’état error a besoin d’une réparation. Son dossier de médias a été supprimé : pointez-la vers un autre avec media sync update --folder-id. Son dossier source a été supprimé ou déplacé : supprimez la synchronisation et créez-en une. Pour Google Drive par le compte de service de screenRIG, le dossier a perdu la personne vérifiée qui le partageait (sharer_not_member) : partagez-le de nouveau depuis le compte Google d’un membre du projet, puis media sync update ID --resume. Une exécution Dropbox échoue avec reconnect_required quand Dropbox cesse d’honorer la connexion (media sync account connect).

Modifiez le nom, la cadence ou le dossier de médias d’une synchronisation, ou mettez-la en pause et reprenez-la.

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

Au moins un changement est requis.

Exécutez une synchronisation maintenant plutôt qu’à sa prochaine heure.

media sync run <id>

screenrig media sync run msy_01EXAMPLESYNC000000000

La synchronisation s’exécute en 30 secondes environ, et media sync show affiche alors sa dernière exécution. Une synchronisation en pause doit d’abord être reprise.

Arrêtez une synchronisation ; ses médias et son dossier restent.

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

screenrig media sync delete msy_01EXAMPLESYNC000000000

La synchronisation oublie quel fichier source est devenu quel média. Les médias importés et le dossier de médias restent, et rien n’est supprimé.

Emballez un répertoire statique dans une archive déterministe sans la téléverser.

app pack <directory> [--output FILE]

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

L’enveloppe rapporte sha256, compressed_bytes, expanded_bytes, file_count, la liste des entrées, et si le runtime SDK a été injecté. app upload emballe le répertoire lui-même, donc utilisez cette commande seulement si vous voulez inspecter d’abord l’archive.

Les applications s’exécutent sous une politique de sécurité de contenu qui bloque le code en ligne. L’empaquetage déplace les blocs de style et script en ligne dans des fichiers sous _screenrig/inline/ et les lie. Les gestionnaires d’événements en ligne tels que onclick= et javascript: URLs ne peuvent pas être déplacés ; l’empaquetage les refuse et nomme le fichier et la ligne.

Emballez un répertoire, publiez-le comme nouvelle version d’application, et attendez que la publication réussisse.

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

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

Lire trois champs : data.operation.state est succeeded, data.application.release_id est l’ID rel_ un application primitif pins, et data.application.id est l’ID app_ que les commandes kv utilisent. Une opération réussie, pas un ID de version seul, signifie que la version est utilisable.

Chaque app upload crée une nouvelle application et une première version immuable. Pour publier une version ultérieure de la même application, utilisez app update. Une playlist continue de servir la version qu’elle épingle déjà jusqu’à ce que vous modifiiez ce primitif.

Publier une nouvelle version d’une application existante, en conservant l’identité, le nom et les K/V de l’application.

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

screenrig app update app_01EXAMPLEAPP00000000000 ./lobby-board

Attendre data.operation.state: "succeeded", puis utiliser playlist replace-release pour examiner la page exacte, le primitif, la nouvelle version et les écrans affectés. Appliquer avec le jeton d’impact retourné et une garde de révision optionnelle comme décrit dans le flux de travail de la liste de lecture. Les épingles existantes de la liste de lecture restent inchangées jusqu’à l’application. En cas de conflit de révision, relire l’application avant de décider de réessayer ; ne pas créer une application de remplacement juste pour contourner le conflit.

Lister les applications du projet.

app list

Aucun paramètre.

screenrig app list

Lire une application.

app show <id>

screenrig app show app_01EXAMPLEAPP00000000000

latest_ready_release est absent jusqu’à ce qu’une première publication soit prête. L’état de publication vit sur l’opération et la version, pas sur l’application.

Supprimer une application et chacune de ses versions.

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

screenrig app delete app_01EXAMPLEAPP00000000000

Il n’y a pas de suppression par version. Tant qu’un écran affiche une des versions de l’application, la suppression répond application_in_use : donnez d’abord un autre contenu à ces écrans. La suppression ne vérifie pas les playlists qui épinglent une version sans l’afficher, donc mettez à jour ou supprimez aussi ces playlists.

Lister les clés stockées pour une application.

kv list --app-id ID

screenrig kv list --app-id app_01EXAMPLEAPP00000000000

Lire une clé.

kv get --app-id ID <key>

screenrig kv get --app-id app_01EXAMPLEAPP00000000000 menu

Écrivez une clé depuis JSON, un fichier ou des octets base64.

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"}'

Supprimer une clé.

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

screenrig kv delete --app-id app_01EXAMPLEAPP00000000000 menu

Créer un webhook qui écrit une clé, et recevoir son URL et secret une seule fois.

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

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

L’enveloppe est le webhook : data.id (kvw_…), data.key, data.url (https://api.screenrig.ai/api/applications/<app_id>/kv-webhooks/<id>/write) et data.secret (srkw_…). Saisissez l’URL et le secret dans le système d’envoi maintenant. Aucune commande ultérieure ne montre ce secret à nouveau.

Lister les webhooks d’une application, les plus anciennes d’abord.

kv webhook list --app-id ID

screenrig kv webhook list --app-id app_01EXAMPLEAPP00000000000

Chaque élément possède id, key, description, url, created_at et, une fois écrit, last_used_at. Une liste ne contient jamais de secret.

Supprimer un webhook. Son URL cesse de fonctionner immédiatement, et la clé conserve sa valeur.

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

screenrig kv webhook delete kvw_01EXAMPLEWEBHOOK00000 --app-id app_01EXAMPLEAPP00000000000

Remplacer le secret d’un webhook et recevoir le nouveau une fois.

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

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

L’enveloppe transporte le nouveau secret dans data.secret. L’ancien secret cesse de fonctionner immédiatement, donc saisissez le nouveau dans le système d’envoi.

Modifier un webhook de carte : sa description, son mappage, son état activé ou sa signature.

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

L'enveloppe est le webhook. data.signing_secret n'apparaît qu'une fois, dans la réponse qui a activé la signature.

Lire le journal de livraison d'un webhook de carte, du plus récent au plus ancien, pour les sept derniers jours.

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

screenrig kv webhook deliveries kvw_01EXAMPLEWEBHOOK00000 --card crd_01EXAMPLEBOARD0000000000

Chaque élément a at, outcome (written, unchanged, refused, invalid ou handshake), reason (par exemple credentials, signature, disabled, body, mapping, card_data_invalid ou rate_limited), detail, status, bytes, revision et request_id. Aucun corps, en-tête ni identifiant n’est stocké, et un envoi à une mauvaise adresse ne laisse aucune ligne.

Préparer une liste de lecture plein écran modifiable à partir de fichiers médias locaux, d’ID médias prêts, d’ID de version d’application ou d’URL HTTP ou HTTPS.

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

La préparation écrit le document local et peut téléverser des médias ; elle ne crée pas de liste de lecture distante et n’affecte aucun écran. Inspectez le document, puis screen publish. Voir Préparer, publier et modifier des listes de lecture.

Validez un document de liste de lecture localement avant création ou mise à jour. Pas de réseau.

playlist validate <file>

screenrig playlist validate ./lobby-loop.json

Les erreurs nomment des chemins JSON exacts. Une réussite signifie que la forme locale et la sémantique inter-champs sont valides ; l’autorisation, la disponibilité des médias, le nombre de sélecteurs dynamiques, les durées et la disponibilité distante nécessitent encore des vérifications serveur. Créer et mettre à jour effectuent cette vérification avant leur écriture. Le résultat porte aussi des constats de géométrie lint qui ne font pas échouer la vérification : motion_overuse, collision, safe_margin et adjacent_repeat. Pour voir à quoi ressemble une page, publiez-la et exécutez screen screenshot.

Créer une liste de lecture à partir d'un document JSON, d'un modèle ou du modèle intégré Avis urgent.

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 de l'enveloppe est l'id pl_ que prend screen assign. Quand le changement attend une révision, data vaut {status: pending_review, review, playlist} : la liste de lecture existe avec approved_revision: 0, et aucun écran ne peut l'afficher tant qu'une personne n'a pas approuvé (playlist_not_approved). Un modèle est une liste de lecture qui déclare fields ; il n'est jamais affiché sur un écran (playlist_is_template), et une liste créée à partir de lui est une liste ordinaire, qu'on peut affecter, planifier et réviser.

Remplacer un document de liste de lecture.

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

screenrig playlist update pl_01EXAMPLEPLAYLIST000000 ./lobby-loop.json

Lorsque la modification attend une révision, la liste de lecture en direct continue de jouer sans changement jusqu'à ce qu'une personne approuve la proposition.

Lire une liste de lecture, y compris sa révision actuelle.

playlist show <id>

screenrig playlist show pl_01EXAMPLEPLAYLIST000000

Il retourne la version en direct. approved_revision est 0 pour une playlist qu'aucune personne n'a encore approuvée, et approval nomme la revue ouverte pendant qu'un changement attend ; reviews show ID retourne la proposition.

Lister les listes de lecture du projet.

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

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

Afficher les champs d'un modèle ou les valeurs d'une copie, ou modifier les valeurs et mettre la copie à jour.

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

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

Sans option, il affiche les champs d'un modèle et le nombre de listes de lecture créées à partir de lui, ou les valeurs d'une copie, la révision du modèle dont elle est issue et si le modèle en a une plus récente. Chaque changement, et --refresh seul, recrée les pages de la copie à partir de la révision actuelle du modèle, ce qui permet à un changement de marque fait sur le modèle d'atteindre les copies existantes ; rien n'y est poussé automatiquement. Les valeurs sont vérifiées comme à la création. Avec l'accès Propose, un changement devient une révision.

Lister les listes de lecture créées à partir d'un modèle et la révision du modèle dont chacune est issue.

playlist instances <id>

screenrig playlist instances pl_01EXAMPLETEMPLATE00000

outdated signale une liste de lecture créée à partir d'une révision plus ancienne du modèle ; playlist fields ID --refresh la remet à jour.

Lister les révisions d'une liste de lecture, la plus récente en premier.

playlist revisions <id> [--after CURSOR]

screenrig playlist revisions pl_01EXAMPLEPLAYLIST000000

Chaque révision indique ce qui l'a créée (created, edited, promoted avec la révision copiée, ou baseline, la révision que la liste de lecture avait au début de son historique), qui l'a faite, quand, combien de pages elle contient et si elle est actuelle. Une page contient 50 révisions; next_cursor lit la suivante.

Lire une révision et la liste de lecture telle qu'elle était à ce moment.

playlist revision show <id> --revision N

screenrig playlist revision show pl_01EXAMPLEPLAYLIST000000 --revision 3

Rendre de nouveau actuelle une révision antérieure en la copiant comme nouvelle révision.

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

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

Les pages, la bande sonore et le format de la révision deviennent la révision suivante. Le nom reste le même, les révisions précédentes restent dans la liste et chaque écran qui affiche la liste de lecture se met à jour. La promotion exige un identifiant qui publie en direct; un identifiant dont les changements attendent une révision obtient forbidden. Une révision dont le contenu est déjà actuel ne change rien.

Supprimer une liste de lecture.

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

screenrig playlist delete pl_01EXAMPLEPLAYLIST000000

Exportez les fichiers image et vidéo, l’audio de la bande sonore et les URL d’iframe dans un paquet de liste de lecture portable.

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

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

Le paquet contient un manifeste, le document de liste de lecture et des fichiers image, vidéo et audio de bande sonore adressés par leur contenu. Les sélecteurs dynamiques all, tag et folder sont figés sur des identifiants exacts, les URL d’iframe sont conservées et les commentaires sont exclus.

Les cartes, les flux et les pages adslot arrêtent l’exportation avant le téléchargement des médias. Les applications l’arrêtent aussi par défaut; --skip-applications supprime les primitives d’application ainsi que les pages vides ou contrôlées par une application, et indique les identifiants des primitives et des pages ignorées. Au moins une page doit rester. Les cartes, les flux et les pages adslot arrêtent toujours l’exportation avec cette option.

Pour obtenir un document modifiable qui conserve les références aux cartes et aux applications, utilisez screenrig playlist show pl_01EXAMPLEPLAYLIST000000 --output playlist.json. Le document utilise les ressources existantes du même projet.

Créer une liste de lecture à partir d’un répertoire bundle, ou en mettre à jour une existante à partir de celui-ci.

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)"

Les noms d’affichage des listes de lecture peuvent se répéter. L’import crée une liste de lecture distincte même si son nom correspond ; utilisez --update avec un ID pour remplacer une liste de lecture existante.

L’importation valide localement l’ensemble du paquet avant qu’il ne touche le projet : manifeste, document, chemins, types de médias, longueurs et hachages. Les médias existants sont réutilisés si le nom de fichier, le type de média, la longueur en octets, le hachage et la balise correspondent exactement ; les autres sont téléversés sans conversion, et la liste de lecture est écrite seulement après que chaque objet est prêt.

L’importation ne supprime ni n’élague jamais les médias distants. Si une étape ultérieure échoue après le début d’un téléversement, l’erreur liste les objets confirmés prêts et indique si l’écriture de la liste de lecture a commencé. Réessayer le même paquet réutilise ces objets.

Associez un Player avec le code affiché sur son écran.

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

Lister les écrans. Les écrans archivés sont omis sauf demande contraire.

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

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

Chaque ligne comporte le tags de l’écran. Avec --human, le tableau ajoute une colonne TAGS lorsque un écran listé possède des étiquettes.

Lire un écran, y compris révision, affectation et état de vie.

screen show <id>

screenrig screen show scr_01EXAMPLESCREEN00000000

tags liste les étiquettes de flotte de l’écran. effective_playlist, takeover et playlist_schedule rapportent ce que l’écran joue et pourquoi ; voir Horaires et prise de contrôle. health et les capacités hôtes du Player sont dans Santé et alimentation de l’appareil. online est vrai tant qu’un Player est connecté, incluant une courte fenêtre de reconnexion. Les last_online_at et last_ip optionnels apparaissent après la première connexion. observation optionnel rapporte les surfaces qu’un Player a peintes : id, width, height, pixel_ratio et presentation. Tous ces éléments sont en lecture seule ; screen update ne peut pas les envoyer, et un écran archivé retourne toujours sa ligne.

commands liste les 10 derniers redémarrages, rechargements, vidages de cache, redémarrages d’application et mises à jour de l’écran, du plus ancien au plus récent, chacun avec son type, son state (queued, sent, done, failed, expired, cancelled ou superseded), son source (schedule pour un redémarrage émis par un horaire de redémarrage; absent pour un redémarrage demandé par une personne), son expires_at, et le moment où il a été envoyé ou effectué. reboot_schedule et next_reboot_at indiquent l’horaire de redémarrage de l’écran et le début de sa prochaine fenêtre de redémarrage. Un vidage de cache, un redémarrage d’application ou une mise à jour que le Player a terminé porte aussi son cause et un court detail, que --human affiche dans une colonne CAUSE et une ligne sous le tableau. suspension porte le message et le since d’un écran suspendu. Un écran archivé par screen replace indique replaced_by, l’écran vers lequel son appareil a été déplacé. Avec --human, screen show affiche chacun d’eux.

last_outage indique la dernière panne de l’écran : offline_since, back_at et duration_s, et, une fois qu’un rapport de santé la détermine, une likely_cause parmi device_restart, app_crash, app_restart, network ou platform ; elle est absente lorsque screenRIG ne peut pas la déterminer. Un redémarrage est établi dès le retour de l’écran, tandis qu’une cause réseau ou screenRIG attend le prochain rapport de santé du Player, qui peut prendre jusqu’à quinze minutes. glass porte les verdicts que screenRIG a tirés des rapports de lecture et des captures d’écran. Avec --human, screen show affiche Last outage et Likely cause, ainsi que Playlist stalled, Blank screen ou Frozen picture pour un verdict qui a trouvé un problème ; Notifications précise ce que les verdicts laissent de côté.

Modifiez le nom, l’affectation de la liste de lecture ou le fuseau horaire d’un écran en un seul appel.

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

screenrig screen update scr_01EXAMPLESCREEN00000000 --name "Lobby"

En révision, un changement de --playlist-id seul est proposé comme screen assign ; une session Proposer ne peut pas modifier les autres champs.

Créer une nouvelle liste de lecture à partir d’un fichier préparé et l’assigner à un écran.

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

screenrig screen publish scr_LOBBY lobby.json

Cela crée une nouvelle liste de lecture et l’assigne. Cela ne met pas à jour une liste de lecture existante par nom. Inspectez d’abord le document préparé. Répétez la même entrée pour reprendre un échec ambigu. La relecture de l’assignation ne prouve pas la lecture ; demandez une capture d’écran séparément. En cours d’examen, il retourne stage: pending_review avec les deux examens. Voir Préparer, publier et modifier des listes de lecture.

Dirigez un écran, ou une flotte d’écrans, vers une liste de lecture.

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

Si la liste de lecture programme une page et que l’écran n’a pas de fuseau horaire, le CLI refuse avant d’envoyer quoi que ce soit et nomme la commande screen set-timezone à exécuter. Aucune révision n’est consommée par ce refus. Dans une flotte, chaque écran applique cette règle indépendamment : un écran sans fuseau horaire échoue dans son résultat et les autres sont assignés.

Pour publier sur une flotte, créez la liste de lecture une fois avec playlist create, puis exécutez screen assign --tag TAG --playlist-id ID. screen publish cible un écran.

Définir le fuseau horaire civil dans lequel une liste de lecture programmée est lue.

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

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

Les horaires de page sont des heures civiles, donc sans zone ils sont sans signification. Changer la zone recrée la révision du manifeste.

Masquer un écran et assombrir sa vitre.

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

screenrig screen archive scr_01EXAMPLESCREEN00000000

L’archivage masque l’écran de la liste par défaut et assombrit la vitre. Il ne désassocie pas le lecteur.

Restaurer un écran archivé dans la liste par défaut.

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

screenrig screen unarchive scr_01EXAMPLESCREEN00000000

Un Lecteur peut aussi archiver son propre écran : une réinitialisation confirmée sur un Lecteur qui détient une clé, ou le déjumelage d’un Lecteur navigateur jumelé par cookie. screen show rapporte alors archive_reason comme device_reset ou device_unpair (project pour une archive que vous demandez), avec archived_at. L’écran conserve son lien d’appareil pour toutes les raisons, donc un Lecteur qui détient encore cette clé ou ce cookie d’appareil reste sombre et reprend à la désarchivation sans nouveau jumelage. Le Lecteur réinitialisé ou déjumelé perd sa clé ou son cookie et se jumelle à nouveau comme un nouvel écran. Une clé remplacée par une récupération d’écran confirmée reste retirée.

Un écran archivé comme replaced par screen replace ne conserve aucun lien d’appareil, donc la désarchivation le refuse et screen delete le supprime.

Afficher un avis sur un écran à la place de son contenu, jusqu’à sa reprise.

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

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

Un écran suspendu affiche le message à la place de son contenu. Rien d’autre ne change : sa liste de lecture, son horaire, sa prise de contrôle et le contrôle de l’afficheur restent en place et continuent d’évoluer, et screen resume montre ce que l’écran afficherait en ce moment. screen show rapporte suspension avec le message et le since ; suspendre un écran déjà suspendu remplace le message et conserve since. La suspension augmente la révision de l’écran, et le Player récupère ses données à nouveau immédiatement. Un écran archivé répond screen_archived.

Mettre fin à la suspension d’un écran pour qu’il affiche de nouveau son propre contenu.

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

screenrig screen resume scr_01EXAMPLESCREEN00000000

La reprise affiche de nouveau le contenu propre de l’écran, à partir de ce que l’écran afficherait en ce moment, et le Player récupère ses données à nouveau immédiatement. Un écran qui n’est pas suspendu répond inchangé, sans changement de révision. Un écran archivé répond screen_archived.

Supprimer un écran.

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

screenrig screen delete scr_01EXAMPLESCREEN00000000

Supprimer enlève un écran uniquement tant qu’aucune clé de Player n’y est liée, et screen show rapporte deletable: true pour cet écran. Un Player qui se jumelle par code, Player natif ou Player navigateur, détient une clé, et cette clé reste liée à son écran : supprimer cet écran répond 409 screen_archive_required (code de sortie 5) ; archivez-le plutôt. Seul un Player navigateur jumelé par cookie ne détient aucune clé, et son écran se supprime qu’il soit jumelé ou encore en attente.

Déplacer l’appareil jumelé en tant qu’autre écran vers cet écran, en conservant les paramètres et l’historique de cet écran.

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

screenrig screen replace scr_01EXAMPLESCREEN00000000 --with scr_01EXAMPLENEWSCREEN000000

Jumelez d’abord le nouveau matériel comme un écran distinct, puis remplacez. La clé de l’appareil, ou l’identifiant d’un Player navigateur, ouvre désormais <id>, qui conserve son nom, ses étiquettes, son fuseau horaire, sa liste de lecture, ses horaires, sa prise de contrôle, son horaire d’affichage et sa substitution, son mur vidéo, ses commentaires, ses champs, son emplacement et son historique, et reprend l’hôte et le Player de l’écran de remplacement. Sa santé, son statut, son stockage et ses commandes en file d’attente repartent de zéro. L’écran nommé par --with est archivé avec archive_reason replaced et replaced_by nommant <id>. Il ne conserve aucun lien d’appareil, donc screen unarchive ne peut pas le restaurer et screen delete le supprime. La clé que <id> détenait est retirée après une période de grâce de quinze minutes, puis son ancien appareil est refusé. Les deux écrans doivent être actifs avec un Player jumelé : un écran toujours en attente de jumelage répond resource_conflict, un écran archivé répond screen_archived, et un mur vidéo nécessite un Player de remplacement qui déclare display.wall (wall_unsupported). La requête porte toujours une clé d’idempotence, et une nouvelle tentative exacte renvoie la réponse originale.

Émettre un nouvel ID public pour un écran.

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

screenrig screen rotate-public-id scr_01EXAMPLESCREEN00000000

Crée le lien d’un écran, ou le remplace, et affiche son URL de lecteur.

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

screenrig screen link create scr_01EXAMPLESCREEN00000000

Affiche data.url, l’URL du lecteur (https://play.screenrig.ai/player/#screen=…) à coller comme URL d’une source navigateur dans vMix ou OBS, qui ne conserve rien et perdrait sinon son jumelage à chaque chargement. Le lecteur fonctionne depuis l’URL à chaque chargement : l’URL est tout le jumelage. Créer de nouveau le lien le remplace (data.replaced vaut true) : l’ancienne URL cesse de fonctionner aussitôt et le lecteur ouvert depuis elle affiche un avis sans contenu. L’URL est un identifiant d’accès qui ouvre l’écran : elle est affichée sous une étiquette sensible, tenue hors du journal des opérations, et réaffichée par screen link show. Ouvrez-la à un seul endroit. Un écran qui n’est pas jumelé répond resource_conflict (code de sortie 5), et un écran archivé répond screen_archived. Après une requête interrompue, relancez la même commande : elle réutilise la clé d’idempotence enregistrée et renvoie le même lien.

Affiche le lien d’un écran et son URL de lecteur.

screen link show <id>

screenrig screen link show scr_01EXAMPLESCREEN00000000

Affiche data.url sous une étiquette sensible, avec data.hint (les quatre derniers caractères du secret), data.created_at et data.last_used_at une fois qu’un lecteur a ouvert le lien. Un identifiant en lecture seule reçoit url vide avec url_redacted à true, et la sortie lisible indique que l’URL est retenue ; une connexion Manage la reçoit. Un écran sans lien répond screen_link_not_found (code de sortie 4) et nomme la commande qui en crée un. screen show affiche Screen link: on (…HINT) pour un écran qui en a un, jamais son URL.

Désactive le lien d’un écran.

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

screenrig screen link delete scr_01EXAMPLESCREEN00000000

L’URL cesse de fonctionner aussitôt et chaque session qu’elle a ouverte prend fin : une source navigateur qui l’affiche encore montre un avis et aucun contenu jusqu’à ce qu’on lui donne une nouvelle URL. L’écran, son jumelage et son contenu ne sont pas touchés. La commande réussit sans rien changer lorsque l’écran n’a pas de lien.

Demander au lecteur d’un écran, ou à tous les lecteurs d’une flotte, de recharger une fois.

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

La réponse porte un reload_id, un state et un expires_at. Un écran en ligne reçoit le rechargement immédiatement (state sent) ; un écran hors ligne le conserve queued et le reçoit lorsqu’il revient en ligne avant expires_at, soit 24 heures après la requête sauf indication contraire de --expires-in. Un rechargement plus récent remplace celui qui est toujours en file d’attente ; screen show liste les commands de l’écran, et screen command cancel annule celui qui est toujours en file d’attente. Dans une flotte, le reload de chaque résultat porte le même state. Un lecteur web recharge à sa prochaine limite de page ; un lecteur natif se reconnecte, récupère son manifeste et vérifie une mise à jour. Un lecteur ignore un rechargement dans les dix minutes suivant le dernier traité. Le rechargement fonctionne sur écrans actifs et archivés et ne change pas la révision de l’écran.

Publiez un message transitoire comme chrome de scène sur un écran en direct ou une flotte.

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"

Un toast n’est pas un primitif : il n’occupe aucun emplacement de canevas, n’a pas de couche, et ne participe pas à la préparation ou au fondu. Le dernier l’emporte, il n’y a pas de file d’attente ni d’annulation, et l’enveloppe acceptée est { expires_at } seulement. Ne mettez jamais d’identifiants ou autre matériel secret dans le texte.

Afficher le nom d’un écran par-dessus son contenu pendant un moment, pour le repérer sur place.

screen identify <id> [--duration DURATION]

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

Le Player dessine une superposition plein écran au-dessus de son contenu, avec le nom de l’écran en très grand et son ID en petit au-dessous. La lecture se poursuit par-dessous, et une identification plus récente remplace la superposition. L’enveloppe acceptée porte identify_id, duration_ms et un expires_at à 60 secondes après la requête, de sorte qu’un écran hors ligne ne l’affiche jamais plus tard. Seul un Player qui déclare la capacité identify affiche la superposition : tout autre écran répond 409 identify_unsupported (code de sortie 5) et rien n’est envoyé, donc mettez à jour le Player ou affichez le nom avec screen toast. Un écran archivé répond screen_archived et un écran toujours en attente de jumelage répond resource_conflict. L’identification ne change pas la révision de l’écran.

Capturez une image fixe d’un écran actif, ou de chaque écran d’une flotte, et enregistrez-la sur disque.

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

La commande bloque jusqu’à ce que le WebP soit sur disque ; il n’y a pas de --no-wait. L’enveloppe rapporte screen_id, capture_id, path, bytes, sha256, width et height, et jamais les octets d’image. Le plus récent l’emporte : une requête ultérieure remplace une capture en cours. Une capture d’écran du Player web dessine chaque page iframe comme une tuile gris foncé intitulée « Embedded web page » et chaque application telle qu’elle s’affiche elle-même ; l’image ne porte aucun repère pour la tuile, elle ne prouve donc pas qu’une page iframe s’est affichée.

Pour plusieurs identifiants ou --tag, la réponse est un résultat de flotte avec action: "screenshot", le selector, et le répertoire output ; chaque résultat ok porte path, bytes, sha256, width et height. Avec --tag, la CLI liste d’abord les écrans étiquetés, suivant chaque page de liste ; chaque page de liste est facturée et les captures elles-mêmes sont gratuites, et plusieurs identifiants n’ont pas besoin de liste. --idempotency-key est refusé sous cette forme, car chaque capture utilise sa propre clé. Si une capture échoue de façon inattendue, le résultat de cet écran est unexpected_error, aucune nouvelle capture ne démarre, les écrans encore en attente rapportent not_attempted, et le code de sortie est 1.

Définir, ajouter, supprimer ou effacer les étiquettes sur un écran ou une flotte.

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

Une étiquette fait de 1 à 32 lettres ou chiffres, et un écran porte au plus 16 étiquettes uniques. Les étiquettes sélectionnent des flottes ; elles ne sont jamais une autorisation et n’atteignent jamais le Player. Changer les étiquettes augmente la révision de l’écran, pas celle du manifeste. Pour un écran, l’enveloppe est l’écran mis à jour. --add et --remove lisent d’abord l’écran et écrivent le nouvel ensemble protégé par --expect-rev ou la révision juste lue, donc un changement concurrent renvoie revision_conflict (sortie 6) au lieu d’être écrasé ; relancez la commande. Dans une flotte, --add et --remove s’appliquent atomiquement à l’ensemble stocké de chaque écran, et un écran qui dépasserait 16 étiquettes échoue dans son propre résultat avec invalid_request.

Chaque fois que des étiquettes changent (screen tag, une mise à jour d’écran par l’API, l’éditeur d’étiquettes du tableau de bord), levels dans la réponse liste, sous gained et lost, les campagnes dont l’audience d’étiquettes l’écran a rejointe ou quittée, chacune avec son source (campaign), son id, le nombre de screens et, quand la campagne a une portée, reach_before et reach_after. Un screen tag de flotte les additionne sur la flotte. Lisez levels.lost avant de juger une modification d’étiquette inoffensive : retirer la dernière étiquette correspondante des écrans d’une campagne vide ce groupe et déclenche les notifications reach_dropped et group_empty.

Afficher l’horaire de la liste de lecture d’un écran et la liste qu’il sélectionne actuellement.

screen schedule show <id>

screenrig screen schedule show scr_CAFE

La sortie JSON peut être renvoyée directement à screen schedule set --file.

Remplacer la programmation de la liste de lecture sur un écran ou une flotte.

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

Chaque liste de lecture nommée dans un horaire est validée comme une affectation, et l’écran a besoin d’un fuseau horaire et d’une liste de lecture par défaut assignée. Quand aucune entrée n’est en vigueur, la liste de lecture assignée est jouée. Si une liste de lecture programmée ne peut plus être affichée, ses entrées sont ignorées et screen.playlist_unavailable est enregistré.

Supprimer la programmation de la liste de lecture d’un écran ou d’une flotte.

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

screenrig screen schedule clear --tag Cafe

Montrer ce que changerait le remplacement de l’horaire de listes de lecture d’un écran, sans le faire.

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

Rien n’est écrit. Les entrées sont vérifiées comme les vérifie screen schedule set, donc un aperçu refuse ce que refuse le set. data.gained et data.lost disent si l’écran gagnerait ou perdrait des niveaux de son horaire ; une entrée avec "paused": true n’est sur aucun écran, donc la publier la gagne. data.calendar.before et data.calendar.after sont le calendrier de l’écran tel qu’il est et tel qu’il serait de --calendar-from à --calendar-to.

Lister les révisions de l’horaire de listes de lecture d’un écran, la plus récente d’abord.

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

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

data.items contient au plus 50 révisions, chacune avec revision (la révision de l’écran à l’écriture, d’où des trous dans les numéros là où l’écran a changé autrement), created_at, change, current, author lorsqu’il est connu et entries, l’horaire complet après cette écriture (none signifie que l’écran n’avait pas d’horaire). change est edited (un set, un clear ou une importation d’horaire), restored (une copie de la révision antérieure que nomme restored_from) ou baseline. Tant que data.next_cursor est une chaîne, des révisions plus anciennes restent : relancez la commande avec --after réglé à cette valeur. Les révisions partent avec la purge de l’écran. L’accès en lecture seule suffit.

Remettre sur un écran l’horaire d’une révision antérieure en le copiant vers l’avant.

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

Les entrées de la révision N deviennent l’horaire de l’écran, la même écriture que screen schedule set avec ces entrées (ou screen schedule clear si cette révision n’en avait aucune), vérifiées comme elles le sont maintenant : une liste de lecture supprimée depuis la refuse. Avec l’accès Propose, ou dans un projet qui exige une révision des changements des agents, la restauration attend une personne comme le set, et rien ne change à l’écran avant qu’elle l’approuve. Les révisions antérieures restent telles quelles.

Afficher une liste de lecture sur un écran ou une flotte avant les campagnes, l’horaire et l’affectation.

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 est l’abréviation de screen takeover set ID. Une nouvelle prise de contrôle remplace la précédente. Lorsqu’elle se termine, l’écran revient automatiquement à une campagne en vigueur, à son horaire ou à sa liste de lecture assignée. Une prise de contrôle dont la liste de lecture ne peut être affichée se termine. Une relance --for après un échec ambigu calcule une nouvelle fin et est envoyée comme une nouvelle requête.

Terminer la prise de contrôle sur un écran ou une flotte.

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

screenrig screen takeover clear --tag Lobby

Lister les campagnes du projet dans l’ordre où les écrans les lisent.

campaign list

Aucun paramètre.

screenrig campaign list

data.items contient au maximum 100 campagnes, les priorités les plus élevées d’abord et les plus récentes d’abord au sein d’une même priorité. Une campagne en pause est listée et ne s’applique nulle part.

Lire une campagne.

campaign show <id>

screenrig campaign show cmp_LUNCH

Retourne name, playlist_id, audience (la règle exacte), priority, paused, les from, until, windows, monthly, dates, except, interaction, displays et start qui sont définis, et revision, la valeur pour --expect-rev lors d’une écriture ultérieure. reach indique combien d’écrans l’audience couvre : published à la dernière publication de la campagne (créée, ou mise à jour avec une nouvelle audience, liste de lecture ou état de pause), current et at pour le dernier compte, et empty_groups, les feuilles tag:NAME et folder:ID de l’audience qui ne correspondent à aucun écran. Une étiquette, un dossier, un archivage ou une suppression qui change le compte est recompté en environ 15 secondes ; campaign list porte aussi reach, et les notifications reach_dropped et group_empty le surveillent. Un identifiant de ads campaigns list répond not_found (sortie 4) ici.

Faire basculer les écrans d’une audience vers une liste de lecture, en tout temps ou tant que ses règles sont en vigueur.

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

Les étiquettes comptent de 1 à 32 lettres ou chiffres. DAYS est daily, un jour (mon), une plage (mon-fri ; fri-mon traverse la fin de la semaine) ou une liste séparée par des virgules (sat,sun). Sans heure, la fenêtre couvre toute la journée, et une fin à ou avant le début traverse minuit et appartient au jour de début. Dans une règle --audience, chaque membre a exactement l’un de all, any, tag, screen_id ou folder, les groupes s’imbriquent sur 3 niveaux au plus, une audience a au plus 500 règles, et {"all":[]} désigne chaque écran.

Après une création interrompue ou ambiguë, relancez la même commande dans les 24 heures : elle réutilise la clé d’idempotence enregistrée, et le serveur renvoie la même campagne au lieu d’en créer une autre.

Modifier une campagne ; les écrans de son ancienne et de sa nouvelle audience résolvent à nouveau dans la minute.

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

Passez au moins un changement ; seuls les champs que vous passez changent. Un nouveau --playlist-id est vérifié comme à la création. Après une requête interrompue ou ambiguë, relancez la même commande : elle réutilise la clé d’idempotence enregistrée, et le serveur renvoie la mise à jour qui a déjà eu lieu au lieu de l’appliquer à nouveau.

Arrêter une campagne sur chaque écran sans la supprimer.

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

screenrig campaign pause cmp_LUNCH

Les écrans qui l’affichaient reviennent, dans la minute, à ce qu’ils afficheraient sans elle. campaign resume la redémarre.

Redémarrer une campagne en pause.

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

screenrig campaign resume cmp_LUNCH

Chaque écran de l’audience auquel la campagne peut s’appliquer bascule vers la liste de lecture de la campagne dans la minute tant que celle-ci est en vigueur.

Supprimer une campagne.

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

screenrig campaign delete cmp_LUNCH

La campagne ne revient pas. Chaque écran qui l’affiche revient, dans la minute, à ce qu’il afficherait sans elle ; les listes de lecture, les écrans et les étiquettes restent. campaign pause arrête une campagne et la conserve.

Afficher les écrans qu’une campagne atteint et l’état de chacun.

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