Telas de Exibição

Changes Display Screens settings shared by every facility in the facility's brand: the boot screen shown while screens start up, the settings new screens start with, and what templated content shows. Organisation admins only; read the current values and canEdit with display_settings_read boot_screen, screen_defaults or templated.

Actions:

• save_boot_screen: Save the boot screen. Sets the boot screen image (PNG, JPEG or WebP, up to 10 MB, from a public https imageUrl or imageBase64) and/or how it is laid out. Without an image, fit and background re-render the current one. Screens pick it up when they next start. Asks for confirmation.
• reset_boot_screen: Reset the boot screen. Removes the brand's boot screen; screens go back to the default one when they next start. Asks for confirmation.
• save_screen_defaults: Save the screen defaults. The settings a screen starts with when it is paired at one of the brand's facilities. Only the settings you pass change. Screens that are already paired keep their own settings; change those with device_inventory_write configure_screen. Asks for confirmation.
• save_templated: Save templated content settings. What templated content screens and the Schedule show: the data source name, workout names, programs in the Schedule and how far ahead, training phases and how far ahead, and Program Builder training camps (one banner per week) and how far ahead. Asks for confirmation.

Cria, renomeia e exclui grupos de Display Screens em uma instalação e define quais telas estão neles. Os grupos são destinos de publicação (display_publish targets.groupIds) e destinos de comandos (display_screen_command groupIds). Quando várias telas, grupos ou destinos são informados, a ação vale para todos em uma única chamada; confirme com o usuário antes de agir em muitos.

Ações:

• save: Salvar um grupo. Criar: name (e, opcionalmente, screenIds). Renomear: groupId (id ou nome atual) e name. screenIds substitui os membros; as telas não listadas saem deste grupo, mas continuam nos outros grupos.
• delete: Excluir um grupo. Exclui um grupo: suas telas saem dele (continuam nos outros grupos) e o conteúdo publicado no grupo é removido da programação. Requer groupId. Pede confirmação.

Publica apps HTML estáticos ("hosted apps") para Display Screens. Chame display_library_read app_guidelines antes para ver tamanhos de tela, regras de design, limites e o SDK, e display_screenshot depois para conferir o resultado em uma tela. Quando várias telas, grupos ou destinos são informados, a ação vale para todos em uma única chamada; confirme com o usuário antes de agir em muitos.

Ações:

• publish: Publicar um hosted app. Cria um hosted app (name + files) ou publica uma nova versão (appId + files; ela entra no ar em todos os lugares onde o app é exibido, e rollback a desfaz). publishTo também o coloca em telas, como display_publish; um destino de marca ou organização requer confirm. Requer files. Pode pedir confirmação.
• rollback: Reverter um hosted app. Torna uma versão anterior a atual novamente, em todos os lugares onde o app é exibido. Liste as versões com display_library_read app_versions. Requer appId, version.

Lê a biblioteca de conteúdo do Display Screens visível para uma instalação: mídia (imagens, vídeos), apps (páginas web, apps HTML hospedados, apps de Agente de IA, visualizações de CFTV) e playlists, além dos apps de Agente de IA e das fontes de CFTV que podem ser adicionados.

Cada item tem um contentRef (media#…, app#…, playlist#…) para display_publish e playlists. ownerScope mostra quem é o dono (facility#, brand# ou org#); o conteúdo só pode ser publicado dentro do seu dono. Mídia com status processing ainda não está pronta; failed precisa ser enviada novamente. Páginas web com frameable: false não podem ser reproduzidas em playlists, somente como tela de página inteira. Itens com displayIssue são ignorados pelas telas: um app de Agente de IA não publicado, pausado, display-off, com público limitado ou sem Custom Apps; uma visualização de CFTV com no-cctv, cctv-off (um administrador da instalação ativa o CFTV nas telas nas configurações do Display Screens) ou no-cameras.

Ações:

• list: Listar itens da biblioteca. Mídia e apps (paginados; filtre por type, kind, tag ou nome) ou, com type agent-apps, os apps de Agente de IA permitidos nas telas que você pode publicar com display_publish content.agentAppId. Cada item tem um type: media, app ou agent-app.
• cctv_sources: Listar fontes de CFTV. As câmeras da instalação e as Live Views compartilhadas para display_publish content.cctv, e se o CFTV nas telas está ativado. Requer acesso ao CFTV na instalação.
• get: Obter um item da biblioteca. Um item de mídia, app ou playlist por contentRef. Requer contentRef.
• usages: Onde o conteúdo é usado. As atribuições ativas da programação e as playlists que usam um item de mídia ou app (ou as atribuições de uma playlist). Conteúdo em uso não pode ser excluído. Requer contentRef.
• app_versions: Listar versões do hosted app. As versões de um hosted app e qual é a atual, para display_hosted_apps_write rollback. Requer appId.
• app_guidelines: Diretrizes de hosted apps. Tamanhos de tela, regras de design, limites de pacote, o Display App SDK e um modelo inicial. Chame antes de criar um app para display_hosted_apps_write publish.
• check_url: Verificar uma página web. Se uma página web pode ser exibida dentro de playlists (alguns sites recusam ser incorporados em frames), com dicas sobre a aparência. Páginas que recusam frames ainda podem ser uma tela de página inteira. Requer url.
• playlists: Listar playlists. Playlists visíveis para a instalação (paginadas), cada uma com seus itens (contentRef, duração, fit).

Adiciona e altera conteúdo da biblioteca do Display Screens: envie imagens e vídeos, crie apps de página web, de Agente de IA e de visualização de CFTV, edite nomes, tags, durações e datas, exclua itens não usados e atualize a prévia de um app. Apps HTML hospedados são publicados com display_hosted_apps_write; playlists, com display_playlists_write.

Crie imagens em 1920×1080 (paisagem) ou 1080×1920 (retrato). Mídia nova começa como processing enquanto as versões para web são geradas; ela pode entrar em playlists imediatamente e é reproduzida quando fica pronta. ownerScope: facility (padrão), brand ou organisation (brand e organisation exigem acesso a toda a organização).

Ações:

• upload_media: Enviar uma imagem ou um vídeo. Adiciona uma imagem ou um vídeo a partir de uma url https pública (preferível; imagens de até 25 MB, vídeos de até 200 MB) ou de base64 com mimeType (até 20 MB). Imagens JPEG, PNG, WebP, GIF; vídeos MP4, WebM, MOV (convertidos para MP4 H.264 de até 1080p). Vídeos maiores: create_video_upload.
• create_video_upload: Iniciar o envio de um vídeo grande. Para vídeos de até 2 GB: registra o vídeo e retorna um upload pré-assinado (faça PUT do arquivo em upload.url com upload.headers antes de upload.expiresAt) e, em seguida, chame transcode com o contentRef dele. Requer name, mimeType, bytes.
• transcode: Processar um vídeo. Converte um vídeo para as telas: depois de create_video_upload, de novo após uma falha ou para um vídeo antigo que as telas não conseguem reproduzir. Requer contentRef.
• create_app: Adicionar um app. Adiciona uma página web (kind url, informe url; verificada quanto a frames), um app de Agente de IA (kind agent-app, informe agentAppId de display_library_read list type agent-apps) ou uma visualização de CFTV (kind cctv-view, de propriedade da instalação, requer acesso ao CFTV). Requer kind, name.
• update: Atualizar um item da biblioteca. Altera o nome, as tags ou a duração de um item de mídia ou app; o validFrom/validTo de um item de mídia (ISO, null limpa; fora desse intervalo ele é ignorado); a url de uma página web; ou as câmeras, a visualização, o layout ou a qualidade de uma visualização de CFTV. Requer contentRef.
• delete: Excluir um item da biblioteca. Exclui um item de mídia ou app. Bloqueado enquanto estiver em uma programação ativa ou playlist: o erro as lista (remova-as antes com display_schedule_write delete ou display_playlists_write save). Requer contentRef. Pede confirmação.
• refresh_preview: Atualizar a prévia de um app. Faz uma nova captura de tela de um app para a prévia na biblioteca (por exemplo, depois que a página mudou). Requer contentRef.

Cria, atualiza e exclui playlists do Display Screens: sequências em loop de mídia e apps. As alterações chegam em segundos a todas as telas que exibem a playlist. Publique uma playlist com display_publish content.contentRef "playlist#".

Ações:

• save: Salvar uma playlist. Criar: name + items (items pode ficar vazio). Atualizar: playlistId + qualquer um de name, items, transition; items substitui a lista inteira, então envie todos os itens em ordem.
• delete: Excluir uma playlist. Exclui uma playlist. Bloqueado enquanto ela estiver publicada em algum lugar: o erro lista as atribuições a remover antes (display_schedule_write delete). Requer playlistId. Pede confirmação.

Coloca conteúdo no Display Screens: um item de mídia, playlist, app, página web, app de Agente de IA ou visualização ao vivo de CFTV, em telas, grupos, na instalação, na marca ou na organização dela.

mode: now (padrão) substitui o que os destinos normalmente exibem; scheduled exibe somente em janelas semanais (fuso horário da instalação) e/ou entre from e to; takeover interrompe tudo por durationMin (ou até um horário) e depois termina sozinho (encerre antes com display_takeover_stop). As telas decidem o que exibir por camada (takeover > scheduled > default) e depois pelo nível de especificidade do destino (screen > group > facility > brand > organisation).

CFTV: as imagens ao vivo das câmeras ficam visíveis para qualquer pessoa perto das telas. A primeira chamada retorna requiresConfirmation (código CCTV_CONFIRMATION_REQUIRED); pergunte ao usuário e chame de novo com confirmCctv: true. A instalação precisa ter "Allow CCTV on display screens" ativado.

Somente telas no modo player exibem conteúdo publicado; as outras são listadas em warnings. Retorna um batchId; display_schedule_write delete com ele desfaz a publicação inteira. Quando várias telas, grupos ou destinos são informados, a ação vale para todos em uma única chamada; confirme com o usuário antes de agir em muitos.

Lê o que está publicado no Display Screens: para uma tela, o que ela exibe em um momento e ao longo de um intervalo (resolvido entre todas as camadas e destinos dos quais ela herda), além das atribuições que chegam a ela; ou as atribuições publicadas em um grupo, na instalação, na marca ou na organização dela.

Os ids de atribuição (as_…) e de lote (bt_…) são o que display_schedule_write atualiza ou exclui. Os horários são ISO; as janelas estão no fuso horário da instalação.

Ações:

• get: Obter a programação de uma tela. O que uma tela exibe em at (padrão agora), sua linha do tempo de from até to (padrão 24 horas) e todas as atribuições que chegam a ela. Requer screenId.
• list_assignments: Listar atribuições. Atribuições publicadas em um grupo (groupId) ou na instalação, na marca ou na organização dela (target, padrão facility). Paginadas, alteração mais recente primeiro.

Altera o que está publicado no Display Screens: edite o horário, a prioridade ou o conteúdo de uma atribuição (opcionalmente em toda a publicação) ou remova uma atribuição ou uma publicação inteira. Encontre os ids com display_schedule_read. Remover conteúdo da programação o mantém na biblioteca; para encerrar um takeover antes do tempo, mas manter o histórico, use display_takeover_stop.

Ações:

• update: Atualizar uma atribuição. Altera o horário (janelas semanais, from/to; null limpa uma data), a prioridade ou o conteúdo de uma atribuição. applyToBatch faz a mesma alteração em todos os destinos da publicação. Um takeover só pode receber um novo horário de término. Conteúdo de CFTV requer confirmCctv depois que o usuário concordar. Requer assignmentId.
• delete: Remover da programação. Remove uma atribuição (assignmentId) ou tudo de uma publicação (batchId). As telas voltam em segundos ao que exibiriam normalmente. Pede confirmação.

Envia um comando ao vivo para as telas do Display Screens em uma instalação: reload (as telas player buscam a programação novamente), identify (pisca o nome e o código da tela, para encontrá-la no local), displayOn/displayOff (o painel da TV), rebootDevice (reinicia o computador da tela, 1–2 minutos em branco; requer confirm: true) ou osd (uma mensagem curta na tela; informe message).

Escolha as telas com screenIds e/ou groupIds (todas as telas desses grupos na instalação), ou allScreens: true para todas as telas da instalação (displayOn/displayOff então alcançam também as telas de templated content). Retorna resultados por tela. Quando várias telas, grupos ou destinos são informados, a ação vale para todos em uma única chamada; confirme com o usuário antes de agir em muitos.

Lê as telas do Display Screens de uma instalação: liste-as com o status e o que está no ar agora e a seguir (filtre por grupo, status ou modo de exibição), obtenha o detalhe completo e a linha do tempo de uma tela ou liste os grupos de telas com suas telas.

O modo de exibição aparece para os usuários como "Data Source": player é "User managed content", program-builder é "Templated content" (para os usuários, sempre use esse nome), url é "Full-page website (Kiosk Mode)". Os horários são ISO; o fuso horário da instalação é retornado.

Ações:

• list: Listar telas. Telas da instalação (paginadas), cada uma com status, último heartbeat, grupos, tags e o que está no ar agora e a seguir. Também retorna os grupos.
• get: Obter uma tela. O detalhe completo de uma tela (status, heartbeat, versão do player, erros recentes) e, para telas player, o que ela exibe ao longo de um intervalo de tempo (padrão as próximas 24 horas, máx. 14 dias). Requer screenId.
• groups: Listar grupos de telas. Grupos de telas da instalação (paginados), cada um com suas telas.

Altera as telas do Display Screens: emparelhe uma tela nova pelo código de emparelhamento; renomeie uma tela, defina seus grupos e tags ou mude o modo de exibição (mostrado aos usuários como "Data Source"); gere um novo token para uma tela player; crie um link de prévia de uma tela ou de um conteúdo com validade limitada; ou restaure uma tela às configurações de fábrica (remove-a da instalação).

Modos de exibição: player ("User managed content"), url ("Full-page website (Kiosk Mode)", informe url, somente https), program-builder ("Templated content"; para os usuários, sempre use esse nome). Mudar o modo recarrega a tela na hora e muda o que os membros veem, por isso requer a confirmação do usuário.

Ações:

• update: Atualizar uma tela. Define o nome, os grupos (ids ou nomes; substitui os grupos atuais), as tags (substitui as atuais) e/ou o modo de exibição de uma tela. Uma mudança de modo retorna requiresConfirmation primeiro. Requer screenId. Pode pedir confirmação.
• rotate_token: Gerar novo token da tela. Emite um novo token para uma tela player e a recarrega; o token antigo para de funcionar. Use quando a URL do player de uma tela puder ter vazado. Requer screenId. Pede confirmação.
• create_preview_link: Criar um link de prévia. Um link (válido por tempo limitado) que mostra o que uma tela exibe ou como um conteúdo fica, opcionalmente em um horário futuro. Qualquer pessoa com o link pode vê-lo até ele expirar.
• reset: Restaurar uma tela às configurações de fábrica. Remove a tela da instalação e a restaura às configurações de fábrica; uma tela desligada é restaurada na próxima vez que ficar on-line e então mostra a página de emparelhamento. Informe confirmName: o nome da tela exatamente como o usuário o digitou. Requer Gerenciamento de dispositivos. Requer screenId, confirmName. Pede confirmação.
• pair: Emparelhar uma tela nova. Adiciona uma tela nova à instalação pelo código de 6 caracteres da página de emparelhamento e a recarrega. Instalações só com Display Screens a iniciam em player; com templated content também, mode escolhe (padrão program-builder). Requer Gerenciamento de dispositivos. Requer pairingCode, name. Pede confirmação.

Captura o que uma tela do Display Screens está exibindo agora e retorna a imagem, para você conferir o próprio trabalho depois de publicar (layout, tamanho do texto, nada cortado ou rolando). Aguarda até 15 segundos pela resposta da tela; telas off-line excedem o tempo limite. Também retorna uma URL do portal para o JPEG (somente usuários conectados, mantida por 10 minutos).

As capturas de tela podem incluir CFTV ao vivo e membros no enquadramento; não as compartilhe fora da conversa.

Reads Display Screens settings for a facility: the fallback slate, polling and nightly reload, CCTV on screens; the screen power schedule (with the next days' on/off times); automations (brightness, bell volume, check-in power, round timer state); the brand's boot screen, screen defaults and templated content settings; and, with templated content, the scheduled program dates and the templated schedule.

Actions:

• settings: Get facility display settings. The fallback slate (message, background, logo, facility name), polling interval, nightly reload time and whether CCTV may be shown on screens.
• power_schedule: Get the power schedule. When screens turn on and off: the saved schedule (or the older automations' equivalent), the facility time zone and the on/off times for the next 7 days.
• power_schedule_preview: Preview a power schedule. The on/off times a schedule would give over the next 7 days, without saving it. Needs schedule.
• automations: Get display automations. Automatic brightness (day/night levels and triggers), bell volume levels and schedule (decimal hours, 6.5 = 06:30), check-in power, and the round timer state, for one or several facilities. usesGlobalDefaults is true until the facility saves its own.
• boot_screen: Get the brand's boot screen. The image the facility's brand shows while screens start up (fit, background, image URLs) and whether you can change it (organisation admins).
• screen_defaults: Get the brand's screen defaults. The settings a screen starts with when it is paired at one of the brand's facilities (orientation, screen mirroring, session timer, speaker control, duress monitoring, camera restreaming, Wi-Fi support) and whether you can change them (organisation admins). Screens that are already paired keep their own settings; see device_inventory_read for those.
• templated: Get the brand's templated content settings. What templated content screens and the Schedule show for the facility's brand (source name, workout names, programs and training phases, look-ahead days) and whether you can change it (organisation admins).
• program_dates: List scheduled program dates. The dates with a workout program, from the start of this month to the brand's look-ahead. Needs templated content (Program Builder) at the facility.
• templated_schedule: Get the templated schedule. Programs and training phases between two dates (YYYY-MM-DD, at most 62 days), as the brand shows them. Needs templated content (Program Builder) at the facility. Needs from, to.

Altera as configurações do Display Screens de uma instalação: o fallback slate, a consulta periódica e a recarga noturna, e "Allow CCTV on display screens"; a programação de energia das telas; e as automações (brilho, volume do sinal, energia no check-in). Os campos que você omitir mantêm os valores atuais. As configurações de toda a marca (tela de inicialização, templated content) estão em display_brand_settings_write.

Ações:

• save_settings: Salvar as configurações de exibição da instalação. O fallback slate exibido quando nada está programado, o intervalo de consulta (30–300 s), o horário da recarga noturna (HH:mm) e allowCctv. Ativar allowCctv requer a confirmação do usuário e um administrador da instalação com acesso ao CFTV. Pode pedir confirmação.
• save_power_schedule: Salvar a programação de energia. Altera quando as telas ligam e desligam; os campos informados são mesclados à programação salva. Retorna os horários de ligar/desligar dos próximos 7 dias. Verifique antes com display_settings_read power_schedule_preview. Requer schedule.
• save_automations: Salvar as automações de exibição. Altera as configurações de brilho automático, volume do sinal e energia no check-in. A instalação passa então a ter as próprias configurações em vez dos padrões globais.

Encerra agora os takeovers do Display Screens em andamento: de uma publicação (batchId de display_publish), de destinos (padrão: takeovers publicados na instalação inteira) ou, com allScreens, todos os takeovers publicados na instalação, nas telas dela ou nos grupos delas. Takeovers de marca e de organização só são encerrados por batchId. As telas voltam em segundos ao conteúdo programado ou padrão; retorna quantos foram encerrados. Quando várias telas, grupos ou destinos são informados, a ação vale para todos em uma única chamada; confirme com o usuário antes de agir em muitos.

Controla as telas de templated content (modo de exibição "Templated content" em display_screens_read): carrega nelas o programa de treino de um dia ou controla o timer de rodadas. As telas de User managed content e de site em página inteira nunca são afetadas.

Ações:

• load_program: Carregar um programa de treino. Carrega o programa de treino de uma data (YYYY-MM-DD, padrão hoje) da fonte de dados da instalação em todas as telas de templated content de uma ou várias instalações; as telas recarregam em segundos. Use para mostrar o treino de hoje ou de outro dia, ou quando as telas mostram o treino errado. Várias instalações exigem confirm. Pode pedir confirmação.
• clock: Controlar o timer de rodadas. Inicia, pausa, reinicia ou para o timer de rodadas nas telas de templated content, silencia ou reativa os sons das rodadas, define o volume do sinal (setvolume com volume 0–100) ou consulta o estado dele. Requer templated content na instalação. Requer command.