Listes de lecture : commandes CLI

Listes de lecture

Une liste de lecture est un document JSON de pages. playlist init prépare un document plein écran à partir d’entrées ordonnées. playlist create et playlist update lisent ce document depuis un fichier ; playlist patch, playlist rename et playlist page add|replace|remove en modifient une partie. La forme est résumée sous les commandes.

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

screenrig playlist init med_01EXAMPLEIMAGE0000000000 med_01EXAMPLEVIDEO0000000000 --name "Lobby loop" --screen-id scr_01EXAMPLESCREEN00000000 --output lobby.json

playlist validate <file>

screenrig playlist validate ./lobby-loop.json

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"

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

screenrig playlist update pl_01EXAMPLEPLAYLIST000000 ./lobby-loop.json

playlist patch <id> [file] [--name NAME] [--clear-audio] [--expect-rev REVISION] [--note TEXT]

screenrig playlist patch pl_01EXAMPLEPLAYLIST000000 --name "Lobby loop" --expect-rev 7
screenrig playlist patch pl_01EXAMPLEPLAYLIST000000 changes.json --expect-rev 7

playlist rename <id> --name NAME [--expect-rev REVISION] [--note TEXT]

screenrig playlist rename pl_01EXAMPLEPLAYLIST000000 --name "Lobby loop" --expect-rev 7

playlist page add <playlist-id> (--file PAGE.json | --media MED_ID) [--seconds N] [--fit contain|cover] [--sound]
                  [--from WHEN] [--until WHEN] [--before PAGE_ID] [--page-id ID]
                  [--expect-rev REVISION] [--note TEXT]

screenrig playlist page add pl_01EXAMPLEPLAYLIST000000 --media med_01EXAMPLEIMAGE0000000000 --from 2026-12-01 --until 2026-12-24
screenrig playlist page add pl_01EXAMPLEPLAYLIST000000 --media med_01EXAMPLEVIDEO0000000000 --before up-ab12cd34 --note "Winter menu"
screenrig playlist page add pl_01EXAMPLEPLAYLIST000000 --file page.json --page-id welcome

playlist page replace <playlist-id> <page-id> [--file PAGE.json | --media MED_ID] [--seconds N] [--fit contain|cover]
                      [--sound] [--from WHEN] [--until WHEN | --always] [--expect-rev REVISION] [--note TEXT]

screenrig playlist page replace pl_01EXAMPLEPLAYLIST000000 up-ab12cd34 --media med_01EXAMPLEIMAGE0000000000
screenrig playlist page replace pl_01EXAMPLEPLAYLIST000000 up-ab12cd34 --until 2026-12-31
screenrig playlist page replace pl_01EXAMPLEPLAYLIST000000 up-ab12cd34 --always

playlist page remove <playlist-id> <page-id> [--expect-rev REVISION] [--note TEXT]

screenrig playlist page remove pl_01EXAMPLEPLAYLIST000000 up-ab12cd34

playlist show <id> [--output FILE [--overwrite]] [--editable]

screenrig playlist show pl_01EXAMPLEPLAYLIST000000
screenrig playlist show pl_01EXAMPLEPLAYLIST000000 --output playlist.json
screenrig playlist show pl_01EXAMPLEPLAYLIST000000 --editable

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

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

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

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

playlist instances <id>

screenrig playlist instances pl_01EXAMPLETEMPLATE00000

playlist revisions <id> [--after CURSOR]

screenrig playlist revisions pl_01EXAMPLEPLAYLIST000000

playlist revision show <id> --revision N

screenrig playlist revision show pl_01EXAMPLEPLAYLIST000000 --revision 3

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

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

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

screenrig playlist delete pl_01EXAMPLEPLAYLIST000000

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

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

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

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

playlist replace-release <id> --page PAGE_ID --primitive PRIMITIVE_ID --release-id REL_ID
                         [--apply [--expect-rev REVISION] [--expect-impact TOKEN] [--note TEXT]]

screenrig playlist replace-release pl_01EXAMPLEPLAYLIST000000 --page board-page --primitive board --release-id rel_NEW
screenrig playlist replace-release pl_01EXAMPLEPLAYLIST000000 --page board-page --primitive board --release-id rel_NEW --apply

Le document de la liste de lecture

Une liste de lecture est name (1 à 120 caractères) plus pages (1 à 100), avec une bande sonore audio optionnelle et un format optionnel. Chaque page porte id, canvas, transition, advance, visibility optionnel, audio_cue optionnel et primitives (1 à 24). Les ID de page, de primitive et de piste sont une lettre suivie d’au plus 63 lettres, chiffres, _ ou - ; les ID de page sont uniques dans la liste de lecture et les ID de primitive sur leur page. Un canvas prend width et height de 1 à 1 000 000, un background et un viewport_fit optionnel : voir Arrière-plan et mouvement de la page.

Un format fait d’une liste de lecture un mur vidéo, {displays, arrangement, orientation} avec columns pour un grid, ou un bandeau, {region, orientation}. Un mur compte de 2 à 12 afficheurs de 1920 x 1080 (1080 x 1920 en portrait), chaque page ordinaire a la toile du mur, et le displays d’une primitive nomme les tuiles qu’elle couvre à la place de rect. Voir Murs vidéo et Bandeaux. Une page d’emplacement publicitaire, {id, type: "adslot", adslot_id} avec visibility optionnel, ne contient ni toile ni primitives ; une liste de lecture en contient au plus 16 et garde une page ordinaire sans visibility.

Un modèle ajoute fields au document, [{name, label, type, required, max_length?}] avec type valant text, media ou url, et peut marquer toute primitive locked: true. Une page lit un champ sous la forme {field.NAME} dans les params d'une carte (champs texte et adresse), comme selector.media_id d'une image ou d'une vidéo (un champ média) ou comme src entier d'un iframe (un champ adresse). Chaque jeton doit nommer un champ déclaré du bon type, chaque champ doit être lu, et une primitive verrouillée n'en lit aucun ; playlist validate le vérifie hors ligne. Seul le propriétaire ou un membre qui peut approuver modifie une primitive verrouillée (primitive_locked). Un modèle déclare au plus 16 champs : name est de 1 à 32 lettres minuscules, chiffres ou traits de soulignement, label jusqu'à 60 caractères, et le max_length d'un champ texte (200 par défaut) jusqu'à 2000. Un champ média ou adresse optionnel laissé sans valeur omet la primitive qui le lit. Déclarer fields et verrouiller une primitive relèvent des modèles de liste de lecture, une fonctionnalité Premium. Un format de mur vidéo de 2 ou 3 écrans exige Plus, et un de 4 à 12 écrans, Enterprise. Un forfait sans la fonctionnalité répond feature_not_in_plan avec required_plan, tandis qu’une écriture qui conserve ce que la liste de lecture contient déjà reste possible. Créer une copie à partir d'un modèle est inclus dans tous les forfaits.

Les six primitives sont image, video téléversée, stream en direct, iframe Web et application, et card. Le texte et l’habillage ne sont pas des types de transmission : placez une card pour du texte en direct, ou téléversez une image fixe terminée que votre agent a créée et placez-la comme image.

Un flux prend une ou deux sources ordonnées avec des protocoles uniques et une image prête du même projet comme fallback_media_id. Utilisez au plus un flux par page et avance basée sur la durée. HLS utilise une URL HTTPS publique; les Players Android et Qt se connectent directement aux flux RTSP des caméras, identifiants compris. Consultez les détails des transports de caméra pour les formats d’URL ouverts par chaque Player; le multicast direct UDP/MPEG-TS en option sur Android et Qt utilise un groupe IPv4 dans 239/8 et un port. Une source peut ne donner que son url et laisser le schéma nommer le protocole. Les autres Players sélectionnent l’alternative HLS ou affichent le fallback. Les octets du flux ne sont pas mis en cache pour la relecture. L’audio est muet par défaut ; muted défini à false le fait jouer, selon les règles du son d’une vidéo ci-dessous. L’importation et l’exportation de paquet de liste de lecture ne supportent pas les flux.

{
  "id": "live",
  "primitive": "stream",
  "sources": [
    {
      "protocol": "udp-mpegts",
      "group": "239.10.0.1",
      "port": 5000
    },
    {
      "protocol": "hls",
      "url": "https://example.com/live.m3u8"
    }
  ],
  "fallback_media_id": "med_fallback",
  "muted": true,
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "contain"
}

Utilisez ce primitif sur une page avec advance: {"mode":"duration","after_ms":30000}. Remplacez le flux d’exemple et l’ID de secours. Exigences du lecteur et configuration du transport.

Chaque primitive est à plat : id, primitive, les champs propres à cette primitive, puis rect, layer, content_fit, et enter et motion optionnels. Il n’y a pas d’objet de contenu imbriqué. rect est x, y, width et height en unités de toile et layer un nombre entier de 0 à 1024. Un rect peut dépasser la toile pour un fond perdu : les Players ajustent le contenu à l’ensemble de rect puis le rognent à la toile, donc utilisez content_fit cover ou fill pour remplir la toile visible. Une carte est placée par layout et ne nécessite un rect que pour free ; sur une liste de lecture de mur, displays remplace rect.

Les primitives image et vidéo exigent un selector. selector.by est id avec un media_id prêt et one_at_a_time false, ids avec 1 à 1 024 media_ids prêts uniques, all pour chaque objet prêt de cette primitive, tag correspondant à ^[A-Za-z0-9]{1,32}$, ou folder avec le folder_id d’un dossier multimédia mfd_ existant, qui lit directement les fichiers prêts qu’il contient et aucun de ses sous-dossiers. Ne mettez pas media_id sur la primitive elle-même et n’envoyez pas d’éléments résolus par le serveur. Une primitive application épingle un release_id et une primitive iframe prend un src et un title de 1 à 200 caractères, donc aucune des deux n’accepte de sélecteur. src est n’importe quelle page http ou https que l’écran peut atteindre, y compris une page de réseau local ou derrière une connexion ; un lien YouTube est stocké sous forme de son intégration à lecture automatique. src, et le fallback_src facultatif d’un iframe, peuvent porter des jetons d’écran comme {screen.field.kiosk_id}, et une primitive application peut porter params avec les mêmes jetons, de sorte qu’une seule liste de lecture donne à chaque écran sa propre page. Les Players Android, Amazon Signage Stick, Linux, Raspberry Pi et Windows ouvrent la page elle-même. L’application Web du Player et les Players macOS, Samsung Tizen, LG webOS et BrightSign l’encadrent, donc une page qui envoie X-Frame-Options (DENY, SAMEORIGIN ou l’obsolète ALLOW-FROM), ou une liste Content-Security-Policy frame-ancestors sans l’origine du Player, y affiche un cadre bloqué, et l’application Web du Player n’affiche que des pages https sans connexion dans l’adresse. Lorsque la publication détecte une page HTTPS publique qui refuse l’encadrement, l’écriture réussit quand même et la CLI affiche l’entrée warnings du serveur : le code iframe_framing_refused, le page_id, primitive_id et src, l’en-tête qui a refusé, et la prochaine étape (utilisez une page qui autorise l’encadrement depuis l’origine du Player, ou demandez à son propriétaire d’autoriser cette origine). Le serveur ajoute aussi un avertissement playlist.iframe_framing_refused au journal des événements, un par page qui refuse, que events list affiche avec primitive_id. Une page de réseau local, une page http et une page que le serveur ne peut pas joindre en quelques secondes ne sont pas vérifiées. Un Player signale une liste de lecture comme en cours de lecture dès que son manifeste est à l’écran, donc une publication vérifiée ne prouve pas qu’une page iframe s’est affichée : agissez sur l’avertissement, ou regardez l’écran. Les deux primitives Web exigent content_fit de fill, parce qu’aucune n’a de taille intrinsèque.

Un iframe prend aussi reload_s (0, la valeur par défaut, ne recharge jamais ; de 60 à 86400 charge src de nouveau toutes les reload_s secondes tant que la page est à l’écran), fallback_src (la page affichée lorsque src ne se charge pas, avec les formes et règles de src ; un src rétabli la remplace au prochain rechargement) et navigation_allowlist (de 1 à 64 sources d’hôte de la forme [scheme://]host[:port][path], comme example.com, *.example.com ou https://example.com/docs/ ; avec une liste, les liens de la page, les navigations par script et les redirections n’atteignent que src, fallback_src et les adresses correspondantes ; omettez-le pour aucune restriction, une liste vide est refusée). Un code d’intégration <iframe> collé est lu pour son src. Un partage Google Slides, Docs ou Sheets, un lien Publier sur le Web ou d’intégration, ou un lien d’intégration Microsoft 365, est stocké reconstruit pour l’écran : les présentations Slides et PowerPoint bouclent, une présentation Slides avance sur le délai propre du lien plafonné à la durée de la page (donnez à la page la durée de la présentation entière), et Docs, Sheets, Word et Excel se rechargent toutes les 5 minutes. Un fichier qui demande aux spectateurs de se connecter est refusé avec document_not_shared, dont le détail nomme le paramètre de partage à modifier. Voir Afficher une page Web, une vidéo ou un document.

advance.mode est duration avec after_ms, qui sur une page contenant exactement une vidéo YouTube (ni liste de lecture ni direct) peut aussi porter until réglé sur video_end pour que la page dure jusqu’à la fin de la vidéo et que after_ms soit le temps d’affichage quand l’écran ne peut pas lire la durée de la vidéo, media_end sur une page avec exactement une primitive image ou vidéo, audio_end sur une page dont le audio_cue nomme une piste sonore, ou application avec max_ms lorsque l’application termine son propre tour en appelant window.screenrig.nextPage(). Une page application nécessite exactement une primitive marquée controller ; tout autre mode l’interdit. after_ms, max_ms et dwell_ms sont des millisecondes entières de 1 000 à 86 400 000, et une image sur une page media_end nécessite dwell_ms. Une page contient au plus un stream et au plus deux primitives application ou iframe, et media_end interdit les deux.

transition.type est l’un de crossfade, swipe-left, swipe-right, swipe-up, swipe-down, dip, wipe-left, wipe-right, wipe-up, wipe-down, slide-left, slide-right, slide-up, slide-down ou stinger. duration_ms est requis, de 0 à 60000. playlist init écrit un fondu enchaîné de 200 ms. Balayer déplace les deux pages ensemble comme un carrousel. Glisser fait glisser la page entrante sur la page sortante, qui dérive d’un quart de la distance. Essuyer découvre la page entrante derrière un bord dur en mouvement. Plonger fait fondre la page sortante vers une couleur unie puis vers la page entrante ; color est un #RRGGBB optionnel, par défaut #000000, et n’est valide que sur dip. Les noms de direction indiquent la direction du mouvement : wipe-left est un bord se déplaçant vers la gauche. ease est optionnel : linear, in, out ou in-out ; la valeur par défaut est linear pour crossfade et swipe-* et in-out pour dip, wipe-* et slide-* ; il n’est pas permis sur stinger. La page entrante possède sa transition. La première page d’une liste de lecture ne joue aucune transition.

Un stinger est un graphique thématique plein cadre qui couvre la page sortante, échange la page entrante pendant que l’écran est couvert, puis la découvre. Utilisez-le pour nommer une section d’une liste de lecture : placez-le sur la première page de la section. L’objet stinger est requis pour type: "stinger" et interdit sur les autres types. Tous ses membres sont optionnels. theme est l’un de neomustard (par défaut), cyanotype, propaganda, signal, avant-garde, bloom ou primetime, et correspond aux thèmes de carte. title fait jusqu’à 40 caractères et subtitle jusqu’à 60, définis dans le type d’affichage du thème. logo est media: plus l’identifiant d’une image prête dans le projet, par exemple media:med_01EXAMPLE. accent est un #RRGGBB optionnel qui remplace l’accent du thème. duration_ms pour un stinger est entre 2000 et 6000 et couvre tout le bumper ; les durées typiques vont de 2700 à 4000. Le titre reste entièrement affiché pendant hang_ms, de 0 à 6000, par défaut 1000 (une seconde), et hang_ms est au maximum 60 % de duration_ms ; un maintien plus long nécessite un duration_ms plus long. Un Player incapable d’afficher un stinger joue un fondu enchaîné de même durée. Consultez la page en direct Carte Stinger pour voir la transition.

L’exemple suivant montre une transition de page stinger :

{ "type": "stinger", "duration_ms": 3500, "stinger": { "theme": "primetime", "title": "BREAKFAST", "subtitle": "Served until 11", "logo": "media:med_01EXAMPLE", "hang_ms": 1000 } }

Un objet enter optionnel sur une primitive ajoute une animation d’objet : fade-up, fade-down, fade-left, fade-right, fade-in, zoom-in ou zoom-out, et un stagger optionnel de 0 à 8 retarde son début de 120 ms par pas. Un motion optionnel garde une primitive en mouvement après son entrée : spin et drift font pivoter ou glisser une image ou une vidéo, et path déplace une image, une vidéo, une application ou un iframe le long de points de passage. Voir Arrière-plan et mouvement de la page.

Un objet page visibility optionnel limite quand la page joue : un booléen enabled requis, des limites civiles optionnelles from et until, et jusqu’à 16 windows récurrents de jours et heures civiles. from et until sont YYYY-MM-DDTHH:MM dans le fuseau horaire de chaque écran, from inclus et until exclu et postérieur à from ; une fenêtre est days (mon à sun) avec start et end sous la forme HH:MM, donnés ensemble ou tous deux omis pour la journée entière, et un end égal ou antérieur à start traverse minuit. enabled: false masque la page ; enabled: true nécessite au moins l’un de from, until, windows ou data. Chaque liste de lecture garde au moins une page sans aucun champ visibility. Un écran lit ces heures dans son fuseau horaire effectif : sa substitution, sinon le fuseau que signale son Player, sinon UTC.

Une condition visibility.data de page, {key, path?, equals?}, n’affiche la page que tant qu’un document de données de carte correspond : key est une clé de données de carte ou un ID de carte, path un pointeur RFC 6901 dans le document, et equals une chaîne, un nombre, un booléen ou null (omettez-le pour tester que la valeur existe). La clé {screen.weather} lit la météo à l’emplacement propre de chaque écran, que screen update ID --location LAT,LON définit : {"enabled":true,"data":{"key":"{screen.weather}","path":"/condition","equals":"rain"}} n’affiche la page que lorsqu’il pleut là où se trouve cet écran. Le document météo contient condition (clear, cloud, fog, rain, snow, storm ou wind), band (freezing sous 0 °C, cold de 0 à 9, mild de 10 à 17, warm de 18 à 24, hot à partir de 25), temperatureC en degrés entiers et isDay. C’est la météo actuelle de la cellule de 0,25 degré de l’écran, actualisée environ toutes les heures, et non une prévision. Un écran sans emplacement n’affiche jamais la page, et la publication refuse un path ou un equals que le document ne peut pas contenir, comme cloudy pour cloud. Un Player qui ne déclare pas la capacité d’hôte page.conditions voit une telle page désactivée. Les conditions de données sont une fonctionnalité Plus : sans elle, une écriture qui ajoute une condition visibility.data qu’une page n’a pas déjà reçoit feature_not_in_plan, tandis que conserver ou retirer une condition enregistrée et la visibilité par plages horaires restent possibles. Gardez une page ordinaire sans visibility comme page de repli.

Un primitif video ou stream joue sans son à moins de régler muted sur false. Il joue alors son audio au volume de l’écran tant que sa page est courante, et cette page met en pause la bande sonore de la liste de lecture, qui reprend au même point sur la page suivante sans son. Plusieurs primitifs sur une même page jouent tous leur audio. Une page avec son ne peut pas porter de audio_cue : une écriture qui en ajoute un répond invalid_request à pages[i].audio_cue, « a page with sound cannot cue the soundtrack », tandis qu’une page plus ancienne déjà enregistrée qui a les deux continue de jouer. Les publicités restent muettes.

Un objet audio optionnel de premier niveau ajoute une bande sonore qui joue continuellement pendant que les pages changent et se met en pause sur une page avec son. tracks liste de 1 à 128 entrées dans l’ordre de lecture, chacune avec un id unique (le motif d’ID de page) et le media_id d’un objet média audio prêt. loop par défaut est true et redémarre à la première piste après la dernière ; volume par défaut est 1 et varie de 0 à 1, multiplié par le volume du Player ; cued par défaut est false, et true arrête la bande sonore après chaque piste pour qu’une piste joue seulement quand une page audio_cue la démarre. Une page ordinaire peut porter audio_cue avec un ID track de cette liste et un booléen restart optionnel (par défaut false) : quand la page apparaît, le Player passe à cette piste depuis son début, la redémarrant seulement si elle joue déjà et que restart est true. Les repères sont des indices, les pages d’emplacement publicitaire ne peuvent pas les porter, et un repère sans bande sonore est rejeté. Une page avec advance {"mode":"audio_end"} se termine quand la piste nommée par son audio_cue se termine, donc elle requiert ce repère et une bande sonore, ne prend pas de after_ms, et suit les règles duration pour les primitifs image et vidéo ; un primitif stream a toujours besoin d’une page duration, et une application sur la page n’est jamais son contrôleur ; max_ms est un indice optionnel que le serveur remplace. playlist update remplace tout le document, donc omettre audio supprime la bande sonore ; playlist patch la conserve sauf si audio est fourni, et --clear-audio ou audio: null la supprime. Un bandeau n’a pas de bande sonore. Création de bande sonore.