Listas de reproducción: comandos CLI

Listas de reproducción

Una lista de reproducción es un documento JSON de páginas. playlist init prepara un documento a pantalla completa a partir de entradas ordenadas. playlist create y playlist update leen ese documento desde un archivo; playlist patch, playlist rename y playlist page add|replace|remove cambian una parte de él. La forma se resume bajo los comandos.

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

El documento de la lista de reproducción

Una lista de reproducción es name (de 1 a 120 caracteres) más pages (de 1 a 100), con una banda sonora audio opcional y un format opcional. Cada página lleva id, canvas, transition, advance, visibility opcional, audio_cue opcional y primitives (de 1 a 24). Los ids de página, de primitiva y de pista son una letra seguida de hasta 63 letras, dígitos, _ o -; los ids de página son únicos en la lista de reproducción y los de primitiva en su página. Un canvas toma width y height de 1 a 1000000, un background y un viewport_fit opcional: consulte Fondo de página y movimiento.

Un format convierte una lista de reproducción en un muro de video, {displays, arrangement, orientation} con columns para un grid, o en una franja, {region, orientation}. Un muro tiene de 2 a 12 pantallas de 1920 x 1080 (1080 x 1920 en vertical), cada página ordinaria tiene el lienzo del muro, y el displays de una primitiva nombra los mosaicos que cubre en lugar de rect. Consulte Muros de video y Franjas. Una página de espacio publicitario, {id, type: "adslot", adslot_id} con visibility opcional, no contiene lienzo ni primitivas; una lista de reproducción contiene como máximo 16 de ellas y conserva una página ordinaria sin visibility.

Una plantilla añade fields al documento, [{name, label, type, required, max_length?}] con type de text, media o url, y puede marcar cualquier primitiva como locked: true. Una página lee un campo como {field.NAME} en los params de una tarjeta (campos de texto y de dirección), como selector.media_id de una imagen o un vídeo (un campo de medio) o como src completo de un iframe (un campo de dirección). Cada marcador debe nombrar un campo declarado del tipo correcto, cada campo debe leerse y una primitiva bloqueada no lee ninguno; playlist validate lo comprueba sin conexión. Solo el propietario o un miembro que pueda aprobar cambia una primitiva bloqueada (primitive_locked). Una plantilla declara como máximo 16 campos: name es de 1 a 32 letras minúsculas, dígitos o guiones bajos, label de hasta 60 caracteres, y el max_length de un campo de texto (predeterminado 200) de hasta 2000. Un campo de medio o de dirección opcional que se deja sin valor omite la primitiva que lo lee. Declarar fields y bloquear una primitiva son plantillas de listas de reproducción, una función de Premium. Un format de muro de video de 2 o 3 pantallas requiere Plus, y uno de 4 a 12 pantallas, Enterprise. Un plan sin la función responde feature_not_in_plan con required_plan, mientras que una escritura que conserva lo que la lista de reproducción ya tiene sigue disponible. Crear una copia a partir de una plantilla está incluido en todos los planes.

Las seis primitivas son image, video subido, stream en vivo, iframe web y application, y card. El texto y el marco no son tipos de transmisión: coloque una card para texto en vivo, o suba una imagen fija terminada que haya hecho su agente y colóquela como imagen.

Un flujo toma una o dos fuentes ordenadas con protocolos únicos y una imagen lista del mismo proyecto como fallback_media_id. Use como máximo un flujo por página y avance basado en duración. HLS usa una URL HTTPS pública; los Players de Android y Qt se conectan directamente a las transmisiones RTSP de las cámaras, con las credenciales incluidas. Consulte los detalles del transporte de cámaras para conocer los formatos de URL que abre cada Player; la multidifusión UDP/MPEG-TS directa opcional en Android y Qt usa un grupo IPv4 en 239/8 y un puerto. Una fuente puede dar solo su url y dejar que el esquema indique el protocolo. Otros Players seleccionan la alternativa HLS o muestran el fallback. Los bytes del flujo no se almacenan en caché para reproducción. El audio está silenciado por defecto; muted con el valor false lo reproduce, con las reglas del sonido de un video que se indican más abajo. La importación y exportación de paquetes de listas de reproducción no admiten flujos.

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

Utilice este primitivo en una página con advance: {"mode":"duration","after_ms":30000}. Reemplace el ejemplo de fuente y el ID de respaldo. Requisitos del Player y configuración del transporte.

Cada primitiva es plana: id, primitive, los campos propios de esa primitiva, luego rect, layer, content_fit, y enter y motion opcionales. No hay ningún objeto de contenido anidado. rect es x, y, width y height en unidades de lienzo y layer un número entero de 0 a 1024. Un rect puede extenderse más allá del lienzo como sangrado: los Players ajustan el contenido a todo el rect y luego lo recortan al lienzo, así que use content_fit cover o fill para llenar el lienzo visible. Una tarjeta se coloca mediante layout y necesita un rect solo para free; en una lista de reproducción de muro displays reemplaza a rect.

Las primitivas de imagen y video requieren un selector. selector.by es id con un media_id listo y one_at_a_time false, ids con de 1 a 1024 media_ids listos únicos, all para todos los objetos listos de esa primitiva, tag que coincide con ^[A-Za-z0-9]{1,32}$, o folder con el folder_id de una carpeta de medios mfd_ existente, que reproduce directamente los archivos listos que contiene y ninguno de sus subcarpetas. No ponga media_id en la propia primitiva ni envíe elementos resueltos por el servidor. Una primitiva application fija un release_id y una primitiva iframe toma un src y un title de 1 a 200 caracteres, por lo que ninguna de las dos toma un selector. src es cualquier página http o https a la que la pantalla pueda llegar, incluida una página de la LAN o una detrás de un inicio de sesión; un enlace de YouTube se guarda como su incrustación con reproducción automática. src, y el fallback_src opcional de un iframe, pueden llevar tokens de pantalla como {screen.field.kiosk_id}, y una primitiva application puede llevar params con los mismos tokens, de modo que una lista de reproducción da a cada pantalla su propia página. Los Players Android, Amazon Signage Stick, Linux, Raspberry Pi y Windows abren la página directamente. El Player web y los Players macOS, Samsung Tizen, LG webOS y BrightSign la enmarcan, por lo que una página que envía X-Frame-Options (DENY, SAMEORIGIN o el obsoleto ALLOW-FROM), o una lista Content-Security-Policy frame-ancestors sin el origen del Player, muestra un marco bloqueado en ellos, y el Player web solo muestra páginas https sin inicio de sesión en la dirección. Cuando la publicación detecta una página HTTPS pública que rechaza ser enmarcada, la escritura igualmente tiene éxito y la CLI imprime la entrada warnings del servidor: el código iframe_framing_refused, page_id, primitive_id y src, el encabezado que la rechazó y el paso siguiente (use una página que permita el marco desde el origen del Player, o pida a su propietario que permita ese origen). El servidor también añade una advertencia playlist.iframe_framing_refused al registro de eventos, una por cada página que la rechaza, que events list imprime con primitive_id. Una página de la LAN, una página http y una página a la que el servidor no puede llegar en unos segundos no se comprueban. Un Player informa de una lista de reproducción como en reproducción una vez que su manifiesto está en pantalla, por lo que una publicación verificada no prueba que una página iframe se haya mostrado: actúe según la advertencia, o mire la pantalla. Ambas primitivas web requieren content_fit de fill, porque ninguna tiene un tamaño intrínseco.

Un iframe también toma reload_s (0, el predeterminado, nunca recarga; de 60 a 86400 carga src de nuevo cada reload_s segundos mientras la página está en pantalla), fallback_src (la página que se muestra cuando src no carga, con las formas y reglas de src; un src recuperado la reemplaza en la siguiente recarga) y navigation_allowlist (de 1 a 64 fuentes de host con la forma [scheme://]host[:port][path], como example.com, *.example.com o https://example.com/docs/; con una lista, los enlaces de la página, las navegaciones por script y las redirecciones llegan solo a src, fallback_src y direcciones que coincidan; omítalo para no tener restricción, una lista vacía se rechaza). Un código de inserción <iframe> pegado se lee para obtener su src. Un enlace para compartir, de Publicar en la Web o de inserción de Google Slides, Docs o Sheets, o un enlace Insertar de Microsoft 365, se almacena reconstruido para la pantalla: las presentaciones de Slides y PowerPoint se repiten en bucle, una presentación de Slides avanza con el retardo propio del enlace limitado a la duración de la página (dé a la página el tiempo de la presentación completa), y Docs, Sheets, Word y Excel se recargan cada 5 minutos. Un archivo que pide a los espectadores iniciar sesión se rechaza con document_not_shared, cuyo detalle nombra el ajuste de uso compartido que hay que cambiar. Consulte Mostrar una página web, un video o un documento.

advance.mode es duration con after_ms, que en una página con exactamente un video de YouTube (no una lista de reproducción ni una transmisión en vivo) también puede llevar until establecido en video_end para que la página dure hasta que termine el video y after_ms sea el tiempo que se muestra cuando la pantalla no puede leer la duración del video, media_end en una página con exactamente una primitiva de imagen o video, audio_end en una página cuyo audio_cue nombra una pista de banda sonora, o application con max_ms cuando la aplicación termina su propio turno llamando a window.screenrig.nextPage(). Una página application necesita exactamente una primitiva marcada controller; todos los demás modos lo prohíben. after_ms, max_ms y dwell_ms son milisegundos enteros de 1000 a 86400000, y una imagen en una página media_end necesita dwell_ms. Una página contiene como máximo un stream y como máximo dos primitivas application o iframe, y media_end prohíbe ambos.

transition.type es uno 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 o stinger. duration_ms es obligatorio, de 0 a 60000. playlist init escribe un fundido cruzado de 200 ms. Deslizar mueve ambas páginas juntas como un carrusel. Deslizar lateral mueve la página entrante sobre la saliente, que se desplaza una cuarta parte. Barrido descubre la página entrante detrás de un borde duro en movimiento. Sumergir desvanece la página saliente a un color sólido y luego a la página entrante; color es un #RRGGBB opcional, predeterminado #000000, y válido solo en dip. Los nombres de dirección indican la dirección del movimiento: wipe-left es un borde que se mueve hacia la izquierda. ease es opcional: linear, in, out o in-out; el predeterminado es linear para crossfade y swipe-* y in-out para dip, wipe-* y slide-*; no está permitido en stinger. La página entrante controla su transición. La primera página de una lista de reproducción no reproduce transición.

Un stinger es un gráfico temático a pantalla completa que cubre la página saliente, intercambia la página entrante mientras la pantalla está cubierta y luego la descubre. Úselo para nombrar una sección de una lista de reproducción: colóquelo en la primera página de la sección. El objeto stinger es obligatorio para type: "stinger" y no está permitido en otros tipos. Todos sus miembros son opcionales. theme es uno de neomustard (el predeterminado), cyanotype, propaganda, signal, avant-garde, bloom o primetime, y coincide con los temas de la tarjeta. title tiene hasta 40 caracteres y subtitle hasta 60, establecidos en el tipo de visualización del tema. logo es media: más el id de una imagen lista en el proyecto, por ejemplo media:med_01EXAMPLE. accent es un #RRGGBB opcional que reemplaza el acento del tema. duration_ms para un stinger es de 2000 a 6000 y cubre todo el bumper; las duraciones típicas son de 2700 a 4000. El título se muestra completamente durante hang_ms, de 0 a 6000, predeterminado 1000 (un segundo), y hang_ms es como máximo el 60 % de duration_ms; una duración más larga necesita un duration_ms más largo. Un Player que no puede dibujar un stinger reproduce un fundido cruzado de la misma duración. Vea la página en vivo Tarjeta Stinger para observar la transición.

El siguiente ejemplo muestra una transición de página con stinger:

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

Un objeto enter opcional en una primitiva añade una animación de objeto: fade-up, fade-down, fade-left, fade-right, fade-in, zoom-in o zoom-out, y un stagger opcional de 0 a 8 retrasa su inicio 120 ms por paso. Un motion opcional mantiene en movimiento una primitiva después de que entra: spin y drift giran o deslizan una imagen o un video, y path mueve una imagen, un video, una aplicación o un iframe a lo largo de puntos de referencia. Consulte Fondo de página y movimiento.

Un objeto de página visibility opcional limita cuándo se reproduce la página: un booleano enabled obligatorio, límites civiles from y until opcionales, y hasta 16 windows recurrentes de días y horas civiles. from y until son YYYY-MM-DDTHH:MM en la zona horaria de cada pantalla, from inclusivo y until exclusivo y posterior a from; una ventana es days (mon a sun) con start y end como HH:MM, indicados juntos o ambos omitidos para el día completo, y un end igual o anterior a start cruza la medianoche. enabled: false oculta la página; enabled: true necesita al menos uno de from, until, windows o data. Cada playlist mantiene al menos una página sin campo visibility alguno. Una pantalla lee estas horas en su zona horaria efectiva: su anulación o, si no, la zona que informa su Player o, si no, UTC.

Una condición visibility.data de página, {key, path?, equals?}, muestra la página solo mientras un documento de datos de tarjeta coincide: key es una clave de datos de tarjeta o un ID de tarjeta, path un puntero RFC 6901 dentro del documento, y equals una cadena, un número, un booleano o null (omítalo para comprobar que el valor existe). La clave {screen.weather} lee el clima de la ubicación propia de cada pantalla, que establece screen update ID --location LAT,LON: {"enabled":true,"data":{"key":"{screen.weather}","path":"/condition","equals":"rain"}} muestra la página solo mientras llueve donde está esa pantalla. El documento del clima tiene condition (clear, cloud, fog, rain, snow, storm o wind), band (freezing por debajo de 0 °C, cold de 0 a 9, mild de 10 a 17, warm de 18 a 24, hot desde 25), temperatureC en grados enteros e isDay. Es el clima actual de la celda de 0,25 grados de la pantalla, actualizado cada hora aproximadamente, no un pronóstico. Una pantalla sin ubicación nunca muestra la página, y la publicación rechaza un path o un equals que el documento no puede contener, como cloudy en lugar de cloud. En un Player que no declara la capacidad de host page.conditions, una página así queda deshabilitada. Las condiciones de datos son una función de Plus: sin ella, una escritura que añade una condición visibility.data que una página aún no tiene recibe feature_not_in_plan, mientras que conservar o quitar una condición guardada y la visibilidad por franjas horarias siguen disponibles. Mantenga una página ordinaria sin visibility como respaldo.

Un primitivo video o stream se reproduce sin sonido salvo que establezca muted en false. Entonces reproduce su sonido al volumen de la pantalla mientras su página es la actual, y esa página pausa la banda sonora de la lista de reproducción, que se reanuda desde el mismo punto en la página siguiente sin sonido. Varios primitivos en una página reproducen todos su sonido. Una página con sonido no puede llevar un audio_cue: una escritura que añade uno responde invalid_request en pages[i].audio_cue, «a page with sound cannot cue the soundtrack», mientras que una página antigua ya almacenada que tiene ambos sigue reproduciéndose. Los anuncios siguen silenciados.

Un objeto audio opcional de nivel superior añade una banda sonora que se reproduce continuamente mientras cambian las páginas y se pausa en una página con sonido. tracks lista de 1 a 128 entradas en orden de reproducción, cada una con un id único (el patrón de id de página) y el media_id de un objeto de medios audio listo. loop por defecto es true y reinicia en la primera pista tras la última; volume por defecto es 1 y varía de 0 a 1, multiplicado por el volumen del Player; cued por defecto es false, y true detiene la banda sonora tras cada pista para que una pista se reproduzca solo cuando una página audio_cue la inicia. Una página ordinaria puede llevar audio_cue con un id track de esa lista y un booleano restart opcional (por defecto false): cuando aparece la página, el Player cambia a esa pista desde su inicio, reiniciándola solo si ya está reproduciéndose y restart es true. Las señales son indicios, las páginas de espacios publicitarios no pueden llevarlas, y una señal sin banda sonora es rechazada. Una página con advance {"mode":"audio_end"} termina cuando termina la pista que su audio_cue nombra, por lo que requiere esa señal y una banda sonora, no toma after_ms, y sigue las reglas duration para primitivos de imagen y video; un primitivo stream aún necesita una página duration, y una aplicación en la página nunca es su controlador; max_ms es un indicio opcional que el servidor anula. playlist update reemplaza todo el documento, por lo que omitir audio elimina la banda sonora; playlist patch la conserva a menos que se suministre audio, y --clear-audio o audio: null la elimina. Una franja no tiene banda sonora. Creación de banda sonora.