Referência de comando CLI

Ler o registro do projeto e seu crédito restante.

project show

Sem parâmetros.

screenrig project show

data.credit_remaining é uma contagem inteira de créditos. Abaixo de 1000 o envelope pode carregar um aviso credits_low. Até 1º de jan de 2027 o uso é gratuito dentro do razoável, então crédito restante é um medidor inteiro que um agente pode ler, não uma instrução de desligamento.

Defina o nome que as pessoas veem no seletor de projetos do dashboard.

project rename NAME

Ler o plano do projeto, flags de recurso independentes screens e advertiser, e conjunto de capacidades efetivas. Uma negação de rota prevalece sobre uma leitura de capacidade desatualizada.

project capabilities

Ler a disponibilidade diária de telas do projeto ao longo dos dias 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

Intervalo e padrões são os de screen uptime. data.items lista uma linha por dia UTC, do mais antigo para o mais recente: online_s e offline_s somados sobre as telas com estado registrado naquele dia, availability, coverage (a parte do dia dessas telas com estado registrado) e screens (quantas tiveram estado registrado). A linha de hoje cobre intervalos que terminaram até agora; screen list mostra quem está online agora.

Ler a saúde da frota por hora UTC: telas reportando, quente, display desconectado, travando.

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

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

data.items lista a saúde da frota por hora UTC: hour, screens_reporting, hot (temperatura máxima igual ou acima de 80 °C), display_disconnected, e crashing (3 ou mais falhas em 24 horas). O CLI segue next_cursor até o fim e responde a cada hora com next_cursor null. As horas seguem os relatórios com até cerca de 5 minutos de atraso.

Criar, listar ou revogar convites para membros do projeto e compradores de anúncios.

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 padrão para member. Entrega por e-mail é padrão e expira após sete dias. --email aceita destinatários separados por vírgula, até cinquenta por solicitação. --link é somente para membros, requer exatamente um destinatário pretendido, e retorna uma URL de convite de vinte e quatro horas uma vez para entrega direta. Nunca coloque essa URL em logs, notas ou transcrição compartilhada. Listas nunca a retornam.

Compradores de anúncios usam apenas e-mail e precisam de escopo de tela ou slot próprio (ou ambos). --screen-id e --slot-id aceitam IDs separados por vírgula; --policy seleciona trusted ou review_required. Filtros de status são queued, sent, issued, accepted, revoked, expired e 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

Agentes não aceitam convites. A pessoa convidada abre o e-mail, faz login ou cria uma passkey, e aceita no dashboard. O cadastro por link verifica o e-mail primeiro. Revogar um convite aceito não desfaz uma associação; use os controles de associação do comprador para revogar o acesso à publicidade.

Relatar se esta instalação possui uma credencial utilizável.

agent status

Sem parâmetros.

screenrig agent status

Somente leitura. Nunca altera estado local ou do servidor, e não custa nada. O resultado carrega o access da sessão, seu effective_access e, quando a configuração de revisão do projeto ou um membro que não pode aprovar mantém isso baixo, access_limited_by (project ou person).

Faça login desta instalação em uma conta existente, com aprovação de uma pessoa no dashboard.

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

screenrig login --access read

Imprime o endereço do dashboard e um código de oito letras no stderr, depois espera até 24 horas. A pessoa verifica se o código corresponde e pressiona Conectar uma vez, sem segundo prompt de passkey após login no dashboard na última hora. O envelope reporta status: signed_in, o projeto, a organização e access. Executar novamente em uma instalação logada adiciona um projeto ou eleva de Somente leitura ou Propor projeto para Gerenciar. Negação é login_denied e expiração é login_expired.

Encerrar o login desta instalação e remover seus tokens.

logout

Sem parâmetros.

screenrig logout

Revoga o login no servidor, depois remove os tokens armazenados e reporta status: signed_out. Uma falha que pode não ter alcançado o servidor mantém os tokens, então executar novamente é seguro. Execute screenrig login para entrar novamente.

Abra a URL comum do dashboard. Este comando não gera um link de login, cria uma sessão ou precisa de credencial de agente.

dashboard [open]

screenrig dashboard

O dashboard mostra os projetos da pessoa após o login. A seleção de projeto no navegador não altera o projeto vinculado a um agente.

Solicitar um e-mail de redefinição de login sem credencial de agente.

dashboard reset-sign-in --email ADDRESS

O reconhecimento não revela se o e-mail tem um login. O reset enviado por e-mail expira após uma hora; a pessoa cria uma nova passkey. A conclusão substitui suas credenciais de login e revoga outras sessões.

Verifique esta instalação e relate cada verificação pelo nome.

doctor [--repair-config]

screenrig doctor

data.checks nomeia cada verificação e seu status: o runtime Node, o caminho de configuração resolvido e suas permissões, a origem do plano de controle e suas rotas de serviço, a capacidade feedback anunciada, e a cadeia de ferramentas de mídia opcional (ffmpeg, ffprobe, encoder_libx264, encoder_libx265, encoder_libwebp, cwebp, filter_hdr_tonemap).

Qualquer verificação falhada faz doctor sair com código diferente de zero, então leia os nomes individuais antes de chamar a instalação de não saudável. Uma cadeia de ferramentas de mídia ausente afeta apenas media upload.

Imprime a versão do CLI empacotada e seu adaptador de protocolo.

version

Sem parâmetros.

screenrig version

Execute isto primeiro em uma sessão. Um envelope bem-sucedido prova que o launcher resolveu o CLI incluído. --version e -V fazem a mesma coisa de qualquer lugar na linha de comando.

Listar os clientes de serviço deste projeto, ativos e revogados, com suas chaves, IDs secretas e uso.

service-client list

Sem parâmetros.

screenrig service-client list

Nunca retorna um segredo.

Exiba um cliente de serviço.

service-client show ID

screenrig service-client show scl_ID

Lista o kid de cada chave e o css_ de cada segredo para rotação.

Criar um cliente de serviço pertencente a este projeto.

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

Requer as autorizações de identidade, projeto e administração da organização descritas acima. No máximo 50 clientes ativos por organização, contados em todos os seus projetos. Uma chave sem seu próprio kid é identificada pela impressão digital RFC 7638.

Registre uma segunda chave pública para uma rotação sem tempo de inatividade.

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

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

Um cliente possui no máximo duas chaves.

Gerar um segundo segredo para uma rotação sem tempo de inatividade.

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

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

Um cliente possui no máximo dois segredos. O atual continua funcionando até que você o remova.

Remover uma chave; tokens emitidos com ela param de funcionar em segundos.

service-client remove-key ID --kid KID

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

Um cliente mantém pelo menos uma chave ou segredo.

Remover um segredo; tokens emitidos com ele param de funcionar em segundos.

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

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

Revogar permanentemente um cliente de serviço.

service-client revoke ID --yes

screenrig service-client revoke scl_ID --yes

Exclui suas chaves e segredos; seus tokens param de funcionar em segundos. O registro permanece para auditoria.

Gerar uma imagem estática apresentável de página inteira para a loja de mídia do projeto.

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

O comando armazena um WebP com perda na loja de mídia do projeto e retorna data.media_id (med_…). Não reenvie os bytes. Nunca imprima pixels ou o prompt. A árvore de autoria e o contrato do prompt vivem em Compose.

Converter um arquivo local em bytes de entrega, enviá-lo e aguardar até que o objeto esteja pronto.

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

Vídeo torna-se um MP4: perfil alto H.264 nível 4.2 por padrão, ou H.265 com --codec hevc, em yuv420p marcado Rec. 709. Uma fonte HDR é mapeada para Rec. 709. Áudio, quando presente na fonte, é AAC a 192 kbit/s, 48 kHz, estéreo.

Imagens estáticas tornam-se WebP com perdas na qualidade 90, mantendo alfa onde a fonte tem. Fonte animada repete para sempre. WebP que já cabe no limite de tamanho é passado sem reencodificação.

Áudio vira MP3 para trilha sonora da playlist. Fonte MP3 é enviada sem alteração; fontes WAV, AAC, M4A, OGG e FLAC são convertidas para MP3 128 kb/s, que precisa de uma build ffmpeg com libmp3lame. Uma faixa dura de 1 segundo a 3 horas. playlist init transforma entradas de áudio em faixas de trilha sonora em vez de páginas. O objeto pronto é um objeto de mídia audio com duração. Não pode ser colocado numa página; nomeie na playlist audio trilha sonora em vez disso.

O id do objeto pronto é data.media_id. O mesmo valor é data.id e data.operation.result.media_id. Esse id é o que um seletor de playlist usa.

Um nome de arquivo com pouca informação como video.mp4 adiciona um aviso consultivo generic_filename ao envelope. O upload ainda é bem-sucedido e o CLI nunca renomeia o arquivo; escolha o nome antes de executar o comando.

A conversão executa ffmpeg e ffprobe de PATH, ou dos caminhos absolutos em SCREENRIG_FFMPEG e SCREENRIG_FFPROBE. Imagens fixas preferem o codificador ffmpeg libwebp e recorrem a cwebp em PATH ou SCREENRIG_CWEBP. Execute doctor antes do primeiro upload de uma sessão.

--preset signage-1080p30 limita a borda longa a 1920, a borda curta a 1080, e a taxa a 30 fps constante. signage-4k30 limita a borda longa a 3840, a borda curta a 2160, e a taxa a 30 fps constante. Ambos funcionam com conteúdo paisagem, retrato e quadrado. --no-audio omite codificação de áudio para clipes silenciosos. Essas opções aplicam-se apenas a vídeo.

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

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

O upload chega na raiz da biblioteca e se move para a pasta assim que estiver pronto. media upload-batch --folder move todos os itens carregados da mesma forma.

Com acesso Propor, ou quando o projeto exige revisão para alterações do agente, um novo envio espera pela revisão de uma pessoa antes que uma tag, pasta ou seletor all seja exibido; veja Revisões.

Enviar muitos arquivos locais a partir de um manifesto, retomando de um arquivo de estado necessário.

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

O envelope carrega data.items[] na ordem do manifesto, cada um com path, source_filename, sha256, outcome (accepted ou resumed), e media_id. data.failed[] carrega itens que não foram entregues.

Substituir o arquivo de uma mídia no lugar. Seu ID, suas playlists e suas agendas continuam funcionando.

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"

A mídia mantém seu ID, suas tags e sua pasta, de modo que cada playlist e agenda que a nomeia reproduz o novo arquivo no próximo manifesto, e os seletores de tag, pasta e all também o incorporam. Nada é reagendado. O comando executa as mesmas etapas de media upload (conversão, limite de bytes de vídeo do plano, limites de dimensões, cota de armazenamento, transferência assinada) e depois substitui em vez de adicionar mídia nova. Ele não aceita --tag nem --folder.

Por padrão, o comando aguarda o processamento. data.media_id e data.id são o ID da mídia, data.version é o número do novo arquivo em media versions, e data.revision é a nova revisão da mídia. data.warnings, data.operation, data.upload, data.transcode e os tempos são informados como em media upload, e o ID da operação está no envelope. Com --no-wait, data.operation é a operação aceita, e data.version e data.warnings estão ausentes.

Uma proporção de tela alterada é permitida. O envelope traz um aviso aspect_ratio_changed, e data.warnings[].playlists nomeia as playlists que usam a mídia, então confira como elas ficam. Um arquivo com os mesmos bytes do atual é recusado com resource_conflict (código de saída 13).

Cada arquivo anterior permanece no histórico da mídia e conta nos bytes armazenados até que sua versão seja excluída; veja media versions.

Com acesso Propose, ou quando o projeto exige revisão para alterações do agente, a substituição aguarda uma pessoa e o comando tem sucesso (código de saída 0): data.status é pending_review, data.review_id nomeia a revisão, o aviso pending_review dá a URL dela e data.next é screenrig reviews show ID. A mídia continua reproduzindo o arquivo atual até que uma pessoa aprove; avise que ela está aguardando e não repita a gravação. Uma substituição mais recente da mesma mídia substitui a que aguarda. Veja Revisões.

Lista os arquivos que uma mídia já teve, com o arquivo em uso primeiro.

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

screenrig media versions med_01EXAMPLEIMAGE0000000000

data.items tem uma entrada para cada arquivo que a mídia já teve: number, current, filename, content_type, sha256, bytes, width, height, duration_ms, codecs, source (upload, replace, sync ou restore), note, by (tipo person, agent, client ou sync, com ID e nome) e restored_from. O arquivo em uso vem primeiro (current: true), depois os demais, do mais recente ao mais antigo. A versão 1 é o primeiro upload; cada substituição, restauração ou alteração da sincronização de mídia adiciona o número seguinte.

Sem --limit e --cursor, todas as páginas são lidas e data.next_cursor é null. Com qualquer um dos dois, uma página é lida: enquanto data.next_cursor for uma string, execute o comando novamente com --cursor definido com esse valor. O acesso somente leitura basta. Os bytes de uma versão anterior permanecem armazenados e contam nos bytes armazenados do projeto até que media version delete os remova; não há limite de quantas versões são mantidas, e os bytes armazenados acima do armazenamento gratuito do plano são cobrados como qualquer outro armazenamento.

Colocar uma versão anterior de volta em uso como nova versão.

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"

A mídia mantém seu ID e passa para uma nova revisão, e cada playlist e agenda que a nomeia reproduz esse arquivo novamente. A versão que ela copia permanece no histórico e compartilha seus bytes; a nova versão conta nos bytes armazenados como qualquer outra. data.media é a mídia e data.warnings traz aspect_ratio_changed, que nomeia as playlists que usam a mídia, quando o arquivo restaurado tem outra proporção de tela.

A versão em uso não pode ser restaurada (resource_conflict, código de saída 5), e uma versão desconhecida é not_found (código de saída 4). Com acesso Propose, ou quando o projeto exige revisão para alterações do agente, a restauração aguarda uma pessoa e o comando tem sucesso (código de saída 0): data.status é pending_review com data.review, o aviso pending_review dá a URL dela e data.next é screenrig reviews show ID. A mídia continua reproduzindo o arquivo atual até que uma pessoa aprove, então não repita a gravação.

Excluir uma versão anterior e seus bytes armazenados.

media version delete <id> --number N

screenrig media version delete med_01EXAMPLEIMAGE0000000000 --number 2

O registro da versão some e seus bytes saem imediatamente dos bytes armazenados do projeto. O objeto armazenado é removido após 24 horas, a menos que outra versão ou o arquivo em uso contenha o mesmo arquivo. Uma versão excluída não pode ser restaurada. A versão em uso não pode ser excluída, e nenhuma versão pode ser excluída enquanto uma substituição da mídia aguarda revisão; ambos são resource_conflict (código de saída 5), e media versions ID mostra qual versão está em uso. Uma versão desconhecida é not_found (código de saída 4). Excluir exige acesso Manage: uma credencial Propose é recusada com insufficient_access, e a exclusão nunca é proposta para revisão.

Leia um objeto de mídia, incluindo sua revisão atual.

media show <id>

screenrig media show med_01EXAMPLEIMAGE0000000000

Escreva uma versão armazenada no disco para inspeção. Nunca imprima os bytes.

media download <id> [--output FILE]

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

O envelope informa media_id, path, bytes, sha256, content_type, primitive, filename, opcional source_filename, e width / height. Nunca carrega pixels. Use isso para comprovar uma imagem gerada antes de ir para o monitor.

Listar objetos de mídia, opcionalmente filtrados por tag e primitivo.

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

Cada linha carrega folder_id, que está ausente na raiz da biblioteca.

Alterar ou limpar a tag em um objeto. A regra de disponibilidade dele é definida com media availability.

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

screenrig media update med_01EXAMPLEIMAGE0000000000 --tag LobbyLoop

Com acesso Propor, ou quando o projeto exige revisão para alterações do agente, retagging de mídia aprovada responde ok com o aviso media_review_pending: as telas continuam exibindo com suas tags aprovadas até que uma pessoa aprove a alteração, e uma rejeição restaura as tags. A revisão aparece em reviews list em segundos; um retag que não altera nenhuma playlist aprovada nem playlist aguardando revisão aplica-se sozinho. Veja Revisões.

Define ou limpa quando os seletores dinâmicos podem escolher um arquivo.

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

screenrig media availability med_01EXAMPLEIMAGE0000000000 --file rule.json

Os membros e o comportamento da regra estão em Disponibilidade de mídia.

Excluir um objeto de mídia.

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

screenrig media delete med_01EXAMPLEIMAGE0000000000

Mover arquivos e pastas de mídia para uma pasta, ou de volta para a raiz da biblioteca.

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

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

A movimentação é uma solicitação tudo ou nada. Uma pasta não pode se mover para dentro de si mesma ou de uma pasta dentro dela, e pastas aninham no máximo 10 níveis. Itens já no destino permanecem como estão. data.media e data.folders contam o que foi movido.

Mover arquivos altera o que os seletores by:folder das suas pastas antiga e nova reproduzem, a partir da resolução do próximo seletor de cada tela; mover uma pasta não altera os arquivos próprios de nenhuma pasta. Sob Propor acesso, ou quando o projeto requer revisão para mudanças de agente, cada arquivo movido espera a revisão de uma pessoa (reviews list) e playlists aprovadas continuam a reproduzi-lo pela pasta com que foi aprovado; veja Revisões.

Listar as pastas de mídia do projeto.

media folder list [--library]

screenrig media folder list
screenrig media folder list --library

Retorna todas as pastas do projeto, no máximo 1000, ordenadas por nome: data.items com id, name, parent_id (null na raiz da biblioteca) e revision. Construa a árvore a partir de parent_id. A pasta de um arquivo é folder_id em media list e media show; está ausente na raiz da biblioteca.

Leia uma pasta de mídia.

media folder show <id>

screenrig media folder show mfd_01EXAMPLEFOLDER000000000

O envelope carrega o name, parent_id e revision da pasta.

Criar uma pasta de mídia na raiz da biblioteca ou dentro de outra pasta.

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

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

Uma organização mantém no máximo 1000 pastas em todos os seus projetos, aninhadas em até 10 níveis. Uma playlist toca os arquivos de uma pasta com um seletor by:folder.

Renomear uma pasta de mídia ou movê-la com tudo dentro para outra pasta.

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

Uma pasta não pode se mover para dentro de si mesma ou de uma pasta dentro dela, e uma movimentação deve manter todas as pastas dentro de 10 níveis. Enviar os valores atuais é uma operação sem efeito.

Excluir uma pasta de mídia. Seus arquivos e pastas sobem um nível.

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

screenrig media folder delete mfd_01EXAMPLEFOLDER000000000

Exclui apenas a pasta. Seus arquivos e pastas sobem para o pai, ou para a raiz da biblioteca quando não tem pai. Um seletor by:folder que a nomeia não corresponde a nada, então redirecione essas playlists primeiro.

Adiciona seu próprio aplicativo do Microsoft Entra, ou uma conexão da Microsoft do projeto, para que uma sincronização possa ler uma pasta do SharePoint ou do OneDrive for Business.

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

No centro de administração do Microsoft Entra, registre um aplicativo de locatário único sem URI de redirecionamento, adicione um segredo de cliente (copie o Valor, não o ID do segredo), adicione a permissão de aplicativo Sites.Selected do Microsoft Graph (e depois conceda ao aplicativo acesso de leitura a cada site) ou Files.Read.All, e conceda o consentimento do administrador. O aplicativo pertence a este projeto. Execute media sync account test em seguida.

Adiciona uma conta do Dropbox e imprime o link de uso único que seu dono abre, logado no Dropbox, para conectá-la.

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 é o link e data.authorize_expires_at sua expiração. O CLI nunca abre um navegador: envie o link à pessoa dona da conta do Dropbox, que permite acesso somente leitura (files.metadata.read, files.content.read, account_info.read). Execute media sync account show até que data.state seja ready (começa como pending_consent) e depois media sync create dropbox. Seu próprio aplicativo do Dropbox precisa ter essas permissões ativadas e o redirect URI que a saída imprime.

Adiciona uma conta do Google Drive, pronta de imediato, e imprime o endereço da conta de serviço com o qual as pastas são compartilhadas.

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 é o endereço com o qual compartilhar cada pasta; Viewer basta. Pela conta de serviço do screenRIG, uma pasta só sincroniza quando um membro deste projeto com e-mail verificado a compartilhou ou é o proprietário dela (media_sync_sharer_not_member caso contrário). Com sua própria chave, qualquer pasta compartilhada com a conta de serviço sincroniza.

Lista as contas de sincronização de mídia deste projeto com o tipo, o estado e o último teste de cada uma; nenhum segredo é devolvido.

media sync account list

Sem parâmetros.

screenrig media sync account list

Inspeciona uma conta: seu tenant e ID de cliente, o estado, o segredo mascarado e o último teste.

media sync account show <id>

screenrig media sync account show msa_01EXAMPLEACCOUNT0000000

Uma conta do Dropbox também mostra quem a conectou e seu app_key; uma conta do Google Drive mostra seu service_account_email.

Renomeia uma conta, altera o tenant, o ID do aplicativo ou o segredo de cliente de um aplicativo da Microsoft, ou substitui a chave própria de uma conta do 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

Pelo menos uma alteração é obrigatória. Uma alteração de credenciais limpa last_test: teste a conta de novo. Os segredos de cliente do Entra expiram, então substitua o segredo aqui antes que isso aconteça.

Cria um novo link de uso único para conectar, ou reconectar, uma conta do Dropbox.

media sync account connect <id>

screenrig media sync account connect msa_01EXAMPLEACCOUNT0000000

data.authorize_url e data.authorize_expires_at trazem o link, que substitui o anterior. Envie-o à pessoa dona da conta do Dropbox. Use-o quando a pessoa não concluiu ou a conta está em reconnect_required (o Dropbox não honra mais a conexão). Uma conta conectada permanece conectada até que o novo consentimento seja concluído, e outra conta do Dropbox que faça login assume a conexão.

Verifica uma conta: o login e as permissões do Graph de um aplicativo da Microsoft, ou a conexão ou a chave de uma conta do Dropbox ou do Google Drive.

media sync account test <id>

screenrig media sync account test msa_01EXAMPLEACCOUNT0000000

A resposta é armazenada como last_test. Para um aplicativo da Microsoft, informa credentials (a Microsoft emitiu um token; uma recusa traz o código AADSTS, como AADSTS7000215 para um segredo que é o ID em vez do Valor) e permissions (as permissões de aplicativo do Graph que o token carrega). Sites.Selected sozinha é um aviso: cada site ainda precisa de sua concessão, e um link de compartilhamento precisa de Files.Read.All. O teste não avalia a concessão de um site nem uma pasta: media sync create lê a pasta que você nomeia. Uma verificação que falha é data.ok false com código de saída 0.

Exclui uma conta que nenhuma sincronização usa.

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

screenrig media sync account delete msa_01EXAMPLEACCOUNT0000000

Enquanto sincronizações usam a conta, a resposta é resource_conflict (código de saída 5), nomeando-as: exclua-as primeiro.

Sincroniza uma pasta do SharePoint ou do OneDrive for Business com uma pasta de mídia.

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"

Uma pasta que a Microsoft recusa é media_sync_source_refused (código de saída 5), com a permissão a conceder; nada é armazenado.

Sincroniza uma pasta do Dropbox com uma pasta de mídia.

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"

Cada execução continua da posição salva do Dropbox na pasta e lê apenas o que mudou. Uma pasta que a conta não consegue abrir é media_sync_source_refused, e uma conexão que o Dropbox não honra mais é dropbox_reconnect_required (media sync account connect): ambas com código de saída 5, nada armazenado.

Sincroniza com uma pasta de mídia uma pasta do Google Drive compartilhada com a conta de serviço de uma conta.

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

Pela conta de serviço do screenRIG, a pasta só sincroniza quando um membro deste projeto com e-mail verificado a compartilhou ou é o proprietário dela (media_sync_sharer_not_member, código de saída 3, nada armazenado). Cada execução verifica isso de novo, e uma pasta que perde esse compartilhador interrompe a sincronização no estado error com a mídia mantida: compartilhe-a de novo a partir da conta do Google de um membro e depois execute media sync update ID --resume. Arquivos do Google Docs, Sheets e Slides são ignorados como unsupported_type. Uma pasta que o endereço não consegue abrir é media_sync_source_refused (código de saída 5): compartilhe-a com a conta de serviço.

Lista as sincronizações de mídia deste projeto com a pasta de mídia, a cadência, o estado e o status da última execução de cada uma.

media sync list

Sem parâmetros.

screenrig media sync list

Inspeciona uma sincronização e o resumo da última execução dela.

media sync show <id>

screenrig media sync show msy_01EXAMPLESYNC000000000

data.last_run traz status (ok, partial ou error), added, updated, removed, pending_delete (arquivos removidos que uma tela ainda mantém, aguardando na pasta Removed) e skipped com o motivo de cada arquivo (unsupported_type, too_large, storage, subfolder, download_failed, unreadable, in_use); uma execução com falha traz error com um code e um detail que indicam a correção. data.source acrescenta path para o Dropbox e shared_by para o Google Drive.

Uma sincronização no estado error precisa de reparo. Sua pasta de mídia foi excluída: aponte-a para outra com media sync update --folder-id. Sua pasta de origem foi excluída ou movida: exclua a sincronização e crie uma. Para o Google Drive pela conta de serviço do screenRIG, a pasta perdeu o compartilhador verificado (sharer_not_member): compartilhe-a de novo a partir da conta do Google de um membro do projeto e depois media sync update ID --resume. Uma execução do Dropbox falha com reconnect_required quando o Dropbox deixa de honrar a conexão (media sync account connect).

Altera o nome, a cadência ou a pasta de mídia de uma sincronização, ou a pausa e a retoma.

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

Pelo menos uma alteração é obrigatória.

Executa uma sincronização agora em vez de no próximo horário dela.

media sync run <id>

screenrig media sync run msy_01EXAMPLESYNC000000000

A sincronização é executada em cerca de 30 segundos, e media sync show então mostra a última execução dela. Uma sincronização pausada deve ser retomada primeiro.

Interrompe uma sincronização; a mídia e a pasta dela permanecem.

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

screenrig media sync delete msy_01EXAMPLESYNC000000000

A sincronização esquece qual arquivo de origem virou qual mídia. A mídia importada e a pasta de mídia permanecem, e nada é removido.

Empacote um diretório estático em um arquivo determinístico sem enviá-lo.

app pack <directory> [--output FILE]

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

O envelope informa sha256, compressed_bytes, expanded_bytes, file_count, a lista de entradas, e se o tempo de execução do SDK foi injetado. app upload empacota o diretório em si, então use este comando apenas quando quiser inspecionar o arquivo primeiro.

Aplicativos rodam sob política de segurança de conteúdo que bloqueia código inline. Empacotamento move blocos de estilo e script inline para arquivos sob _screenrig/inline/ e os vincula. Handlers de evento inline como onclick= e URLs javascript: não podem ser movidos; empacotamento os recusa e nomeia arquivo e linha.

Empacote um diretório, publique-o como uma nova versão do aplicativo e aguarde a publicação ser bem-sucedida.

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

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

Ler três campos: data.operation.state é succeeded, data.application.release_id é o id rel_ um primitivo application fixa, e data.application.id é o id app_ que os comandos kv usam. Uma operação bem-sucedida, não um id de release sozinho, significa que a release é utilizável.

Cada app upload cria um novo aplicativo e uma primeira versão imutável. Para publicar uma versão posterior do mesmo app, use app update. Uma playlist continua servindo a versão que já fixa até você editar esse primitivo.

Publicar uma nova versão de um aplicativo existente, preservando identidade, nome e K/V do aplicativo.

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

screenrig app update app_01EXAMPLEAPP00000000000 ./lobby-board

Aguarde data.operation.state: "succeeded", depois use playlist replace-release para revisar a página exata, primitivo, nova versão e telas afetadas. Aplique com o token de impacto retornado e um controle de revisão opcional conforme descrito no fluxo de trabalho da playlist. Os pins existentes da playlist permanecem inalterados até a aplicação. Em caso de conflito de revisão, leia o app novamente antes de decidir se deve tentar novamente; não crie um aplicativo substituto apenas para contornar o conflito.

Listar os aplicativos do projeto.

app list

Sem parâmetros.

screenrig app list

Leia um aplicativo.

app show <id>

screenrig app show app_01EXAMPLEAPP00000000000

latest_ready_release está ausente até que uma primeira publicação fique pronta. O estado da publicação vive na operação e no lançamento, não no aplicativo.

Excluir um aplicativo e todas as suas versões.

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

screenrig app delete app_01EXAMPLEAPP00000000000

Não há exclusão por lançamento. Enquanto uma tela mostra um dos lançamentos da aplicação, a exclusão responde application_in_use: dê a essas telas outro conteúdo primeiro. A exclusão não verifica playlists que fixam um lançamento sem mostrá-lo, então atualize ou exclua essas playlists também.

Listar as chaves armazenadas para um aplicativo.

kv list --app-id ID

screenrig kv list --app-id app_01EXAMPLEAPP00000000000

Leia uma chave.

kv get --app-id ID <key>

screenrig kv get --app-id app_01EXAMPLEAPP00000000000 menu

Escreva uma chave do JSON, um arquivo ou bytes 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"}'

Excluir uma chave.

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

screenrig kv delete --app-id app_01EXAMPLEAPP00000000000 menu

Criar um webhook que grava uma chave e receber sua URL e segredo uma vez.

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

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

O envelope é o webhook: data.id (kvw_…), data.key, data.url (https://api.screenrig.ai/api/applications/<app_id>/kv-webhooks/<id>/write) e data.secret (srkw_…). Insira a URL e o segredo no sistema de envio agora. Nenhum comando posterior mostrará este segredo novamente.

Listar webhooks de um aplicativo, do mais antigo para o mais recente.

kv webhook list --app-id ID

screenrig kv webhook list --app-id app_01EXAMPLEAPP00000000000

Cada item possui id, key, description, url, created_at e, após ser gravado, last_used_at. Uma lista nunca carrega um segredo.

Excluir um webhook. Sua URL para de funcionar imediatamente, e a chave mantém seu valor.

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

screenrig kv webhook delete kvw_01EXAMPLEWEBHOOK00000 --app-id app_01EXAMPLEAPP00000000000

Substituir o segredo de um webhook e receber o novo uma vez.

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

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

O envelope carrega o novo segredo em data.secret. O segredo antigo para de funcionar imediatamente, então insira o novo no sistema de envio.

Alterar um webhook de cartão: sua descrição, mapeamento, estado ativado ou assinatura.

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

O envelope é o webhook. data.signing_secret aparece uma única vez, na resposta que ativou a assinatura.

Ler o log de entregas de um webhook de cartão, do mais recente para o mais antigo, dos últimos sete dias.

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

screenrig kv webhook deliveries kvw_01EXAMPLEWEBHOOK00000 --card crd_01EXAMPLEBOARD0000000000

Cada item tem at, outcome (written, unchanged, refused, invalid ou handshake), reason (por exemplo credentials, signature, disabled, body, mapping, card_data_invalid ou rate_limited), detail, status, bytes, revision e request_id. Nenhum corpo, cabeçalho ou credencial é armazenado, e uma postagem para um endereço errado não deixa linha.

Prepare uma playlist de tela cheia editável a partir de arquivos de mídia locais, IDs de mídia prontos, IDs de lançamento de aplicativo ou URLs 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

A preparação grava o documento local e pode enviar mídia; ela não cria uma playlist remota nem atribui uma tela. Inspecione o documento e depois screen publish. Veja Preparar, publicar e editar playlists.

Valide um documento de playlist localmente antes de criar ou atualizar. Sem rede.

playlist validate <file>

screenrig playlist validate ./lobby-loop.json

Erros nomeiam caminhos JSON exatos. Uma aprovação significa que a forma local e a semântica cruzada são válidas; autorização, prontidão de mídia, contagens de seletor dinâmico, durações e disponibilidade remota ainda requerem verificações no servidor. Criação e atualização executam essa verificação antes da gravação. O resultado também traz achados lint de geometria que não reprovam a verificação: motion_overuse, collision, safe_margin e adjacent_repeat. Para ver como uma página fica, publique-a e execute screen screenshot.

Cria uma playlist a partir de um documento JSON, de um modelo ou do modelo integrado Aviso urgente.

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 do envelope é o id pl_ que screen assign recebe. Quando a alteração aguarda revisão, data é {status: pending_review, review, playlist}: a playlist existe com approved_revision: 0 e nenhuma tela pode exibi-la até que uma pessoa aprove (playlist_not_approved). Um modelo é uma playlist que declara fields; nunca é exibido em uma tela (playlist_is_template), e uma playlist criada a partir dele é uma playlist comum, que se pode atribuir, agendar e revisar.

Substituir um documento de playlist.

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

screenrig playlist update pl_01EXAMPLEPLAYLIST000000 ./lobby-loop.json

Quando a alteração aguarda revisão, a playlist ao vivo continua tocando sem mudanças até que uma pessoa aprove a proposta.

Leia uma playlist, incluindo sua revisão atual.

playlist show <id>

screenrig playlist show pl_01EXAMPLEPLAYLIST000000

Retorna a versão ao vivo. approved_revision é 0 para uma playlist que nenhuma pessoa aprovou ainda, e approval nomeia a revisão aberta enquanto uma mudança espera; reviews show ID retorna a proposta.

Listar as playlists do projeto.

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

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

Mostra os campos de um modelo ou os valores de uma cópia, ou altera os valores e atualiza a cópia.

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

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

Sem opções, mostra os campos de um modelo e quantas playlists foram criadas a partir dele, ou os valores de uma cópia, a revisão do modelo de que foi criada e se o modelo tem uma mais recente. Cada alteração, e --refresh sozinho, recria as páginas da cópia a partir da revisão atual do modelo, e é assim que uma mudança de marca feita no modelo chega às cópias existentes; nada é enviado automaticamente. Os valores são verificados como na criação. Com acesso Propose, uma alteração vira uma revisão.

Lista as playlists criadas a partir de um modelo e a revisão do modelo de que cada uma foi criada.

playlist instances <id>

screenrig playlist instances pl_01EXAMPLETEMPLATE00000

outdated marca uma playlist criada a partir de uma revisão mais antiga do modelo; playlist fields ID --refresh a atualiza.

Listar as revisões de uma playlist, da mais recente para a mais antiga.

playlist revisions <id> [--after CURSOR]

screenrig playlist revisions pl_01EXAMPLEPLAYLIST000000

Cada revisão diz o que a criou (created, edited, promoted com a revisão copiada, ou baseline, a revisão que a playlist tinha quando seu histórico começou), quem a fez, quando, quantas páginas tem e se é a atual. Uma página tem 50 revisões; next_cursor lê a próxima.

Ler uma revisão e a playlist como estava nela.

playlist revision show <id> --revision N

screenrig playlist revision show pl_01EXAMPLEPLAYLIST000000 --revision 3

Tornar uma revisão anterior atual novamente, copiando-a como uma nova revisão.

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

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

As páginas, a trilha sonora e o formato da revisão passam a ser a próxima revisão. O nome continua o mesmo, as revisões anteriores continuam na lista e toda tela que mostra a playlist é atualizada. Promover exige uma credencial que publica ao vivo; uma cujas alterações aguardam revisão recebe forbidden. Uma revisão cujo conteúdo já é o atual não muda nada.

Excluir uma playlist.

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

screenrig playlist delete pl_01EXAMPLEPLAYLIST000000

Exporta arquivos de imagem e vídeo, áudio da trilha sonora e URLs de iframe como um pacote portátil de playlist.

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

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

O pacote contém um manifesto, o documento da playlist e arquivos de imagem, vídeo e áudio da trilha sonora endereçados por conteúdo. Os seletores dinâmicos all, tag e folder são fixados em IDs exatos, as URLs de iframe são preservadas e os comentários são excluídos.

Cartões, streams e páginas adslot interrompem a exportação antes do download dos arquivos de mídia. Aplicativos também a interrompem por padrão; --skip-applications remove as primitivas de aplicativo e as páginas vazias ou controladas por um aplicativo, informando os IDs das primitivas e páginas ignoradas. Deve restar pelo menos uma página. Cartões, streams e páginas adslot continuam interrompendo a exportação com essa opção.

Para obter um documento editável que preserve as referências a cartões e aplicativos, use screenrig playlist show pl_01EXAMPLEPLAYLIST000000 --output playlist.json. O documento usa recursos existentes do mesmo projeto.

Criar uma playlist a partir de um diretório de pacote ou atualizar uma existente a partir dele.

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

Nomes de exibição da playlist podem se repetir. A importação cria uma playlist separada mesmo quando o nome coincide; use --update com um ID para substituir uma playlist existente.

Importação valida todo o pacote localmente antes de tocar no projeto: manifesto, documento, caminhos, tipos de mídia, tamanhos e hashes. Mídias existentes são reutilizadas com correspondência exata de nome de arquivo, tipo de mídia, tamanho em bytes, hash e tag; o resto é enviado sem conversão, e a playlist é escrita somente após todos os objetos estarem prontos.

Importação nunca exclui ou poda mídia remota. Se uma etapa posterior falhar após o início do upload, o erro lista os objetos confirmados prontos e informa se a escrita da playlist começou. Repetir o mesmo pacote reutiliza esses objetos.

Pareie um Player com o código exibido na tela dele.

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

Listar telas. Telas arquivadas são omitidas, a menos que você as solicite.

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

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

Cada linha carrega o tags da tela. Com --human, a tabela adiciona uma coluna TAGS quando qualquer tela listada possui tags.

Leia uma tela, incluindo revisão, atribuição e estado online.

screen show <id>

screenrig screen show scr_01EXAMPLESCREEN00000000

tags lista as tags da frota da tela. effective_playlist, takeover e playlist_schedule reportam o que a tela reproduz e por quê; veja Programações e takeover. health e as capacidades do host do Player estão em Saúde e energia do dispositivo. online é verdadeiro enquanto um Player está conectado, incluindo uma breve janela de reconexão. last_online_at e last_ip opcionais aparecem após a primeira conexão. observation opcional reporta as superfícies que um Player pintou: id, width, height, pixel_ratio e presentation. Todos são somente leitura; screen update não pode enviá-los, e uma tela arquivada ainda retorna sua linha.

commands lista os últimos 10 reinícios, recarregamentos, limpezas de cache, reinícios do app e atualizações da tela, do mais antigo para o mais recente, cada um com seu type, seu state (queued, sent, done, failed, expired, cancelled ou superseded), seu source (schedule para um reinício emitido por uma programação de reinício; ausente para um pedido por uma pessoa), seu expires_at e quando foi enviado ou concluído. reboot_schedule e next_reboot_at informam a programação de reinício da tela e o início de sua próxima janela de reinício. Uma limpeza de cache, reinício do app ou atualização que o Player finalizou também traz seu cause e um detail curto, que --human imprime como uma coluna CAUSE e uma linha abaixo da tabela. suspension traz o message e o since de uma tela suspensa. Uma tela arquivada por screen replace informa replaced_by, a tela para a qual seu dispositivo foi movido. Com --human, screen show imprime cada um deles.

last_outage informa a última queda da tela: offline_since, back_at e duration_s e, quando um relatório de saúde a determina, uma likely_cause entre device_restart, app_crash, app_restart, network ou platform; ela está ausente quando o screenRIG não consegue determiná-la. Uma reinicialização é decidida quando a tela volta, enquanto uma causa de rede ou do screenRIG espera o próximo relatório de saúde do Player, que pode levar até quinze minutos. glass traz os veredictos que o screenRIG tirou dos relatórios de reprodução e das capturas de tela. Com --human, screen show imprime Last outage e Likely cause, e Playlist stalled, Blank screen ou Frozen picture para um veredicto que encontrou um problema; Notificações diz o que os veredictos deixam de fora.

Altere o nome da tela, atribuição de playlist ou fuso horário em uma única chamada.

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

screenrig screen update scr_01EXAMPLESCREEN00000000 --name "Lobby"

Em revisão, uma alteração apenas de --playlist-id é proposta como screen assign; uma sessão Propor não pode alterar outros campos.

Criar uma nova playlist a partir de um arquivo preparado e atribuí-la a uma tela.

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

screenrig screen publish scr_LOBBY lobby.json

Isto cria uma nova playlist e a atribui. Não atualiza uma playlist existente pelo nome. Inspecione primeiro o documento preparado. Repita a entrada idêntica para retomar uma falha ambígua. A leitura da atribuição não prova a reprodução; solicite uma captura de tela separadamente. Em revisão, retorna stage: pending_review com ambas as revisões. Veja Preparar, publicar e editar playlists.

Aponte uma tela, ou uma frota de telas, para uma playlist.

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

Se a playlist agendar qualquer página e a tela não tiver fuso horário, o CLI recusa antes de enviar qualquer coisa e nomeia o comando screen set-timezone para executar. Nenhuma revisão é consumida por essa recusa. Em uma frota, cada tela aplica essa regra por conta própria: uma tela sem fuso horário falha em seu resultado e as outras são atribuídas.

Para publicar em uma frota, crie a playlist uma vez com playlist create, depois execute screen assign --tag TAG --playlist-id ID. screen publish direciona uma tela.

Defina o fuso horário civil em que uma playlist programada é lida.

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

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

Programações da página são horários civis, portanto sem sentido sem um fuso. Alterar o fuso renova a revisão do manifesto.

Ocultar uma tela e escurecer seu vidro.

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

screenrig screen archive scr_01EXAMPLESCREEN00000000

Arquivar oculta a tela da listagem padrão e escurece o vidro. Não desvincula o Player.

Restaure uma tela arquivada para a listagem padrão.

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

screenrig screen unarchive scr_01EXAMPLESCREEN00000000

Um Player também pode arquivar sua própria tela: um reset confirmado em um Player que mantém uma chave, ou desparear um Player de navegador pareado por cookie. screen show então reporta archive_reason como device_reset ou device_unpair (project para um arquivo que você solicitou), com archived_at. A tela mantém sua vinculação de dispositivo por todos os motivos, então um Player que ainda mantém essa chave ou cookie de dispositivo permanece escuro e retoma na desarquivação sem novo pareamento. O Player que foi resetado ou despareado descarta sua chave ou cookie e pareia novamente como uma nova tela. Uma chave substituída por uma recuperação de tela confirmada permanece aposentada.

Uma tela arquivada como replaced por screen replace não mantém vinculação de dispositivo, então desarquivar recusa essa tela e screen delete a remove.

Mostrar um aviso em uma tela no lugar do conteúdo dela, até que seja retomada.

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

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

Uma tela suspensa mostra a mensagem no lugar do conteúdo dela. Nada mais muda: sua playlist, programação, takeover e controle de exibição permanecem e continuam evoluindo, e screen resume mostra o que a tela estaria mostrando agora. screen show reporta suspension com o message e o since; suspender uma tela já suspensa substitui a mensagem e mantém since. Suspender aumenta a revisão da tela, e o Player busca novamente de imediato. Uma tela arquivada responde screen_archived.

Encerrar a suspensão de uma tela para que ela volte a mostrar seu próprio conteúdo.

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

screenrig screen resume scr_01EXAMPLESCREEN00000000

Retomar volta a mostrar o conteúdo próprio da tela, a partir do que a tela estaria mostrando agora, e o Player busca novamente de imediato. Uma tela que não está suspensa responde inalterada, sem mudança de revisão. Uma tela arquivada responde screen_archived.

Excluir uma tela.

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

screenrig screen delete scr_01EXAMPLESCREEN00000000

Excluir remove uma tela apenas enquanto nenhuma chave de Player estiver vinculada a ela, e screen show reporta deletable: true para essa tela. Um Player que pareia por código, seja nativo ou de navegador, mantém uma chave, e a chave permanece vinculada à sua tela, então excluir essa tela responde 409 screen_archive_required (código de saída 5): arquive-a em vez disso. Somente um Player de navegador pareado por cookie não mantém chave, e sua tela pode ser excluída esteja pareada ou ainda pendente.

Mover para esta tela o dispositivo pareado como outra tela, mantendo as configurações e o histórico desta tela.

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

screenrig screen replace scr_01EXAMPLESCREEN00000000 --with scr_01EXAMPLENEWSCREEN000000

Pareie primeiro o novo hardware como sua própria tela e depois substitua. A chave do dispositivo, ou a credencial de um Player de navegador, agora dá acesso a <id>, que mantém seu nome, tags, fuso horário, playlist, programações, takeover, programação e substituição de exibição, video wall, comentários, campos, localização e histórico, e assume o host e o Player da tela substituta. Sua saúde, status, armazenamento e comandos na fila recomeçam do zero. A tela indicada em --with é arquivada com archive_reason replaced e replaced_by apontando para <id>. Ela não mantém vinculação de dispositivo, então screen unarchive não pode restaurá-la e screen delete a remove. A chave que <id> mantinha é aposentada após uma janela de tolerância de quinze minutos; depois disso, o dispositivo antigo é recusado. Ambas as telas devem estar ativas e ter um Player pareado: uma tela que ainda aguarda pareamento responde resource_conflict, uma arquivada responde screen_archived, e um video wall precisa de um Player substituto que declare display.wall (wall_unsupported). O pedido sempre traz uma chave de idempotência, e uma nova tentativa exata retorna a resposta original.

Emitir um novo ID público para uma tela.

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

screenrig screen rotate-public-id scr_01EXAMPLESCREEN00000000

Criar o link de uma tela, ou substituí-lo, e imprimir sua URL do Player.

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

screenrig screen link create scr_01EXAMPLESCREEN00000000

Imprime data.url, a URL do Player (https://play.screenrig.ai/player/#screen=…) para colar como URL de uma fonte de navegador no vMix ou no OBS, que não guarda armazenamento e, de outro modo, perderia o pareamento a cada carregamento. O Player roda a partir da URL a cada carregamento: a URL é todo o pareamento. Criar o link de novo o substitui (data.replaced é true): a URL antiga para de funcionar imediatamente e o Player aberto a partir dela mostra um aviso sem conteúdo. A URL é uma credencial que abre a tela: é impressa sob um rótulo sensível, mantida fora do log de operação e exibida de novo por screen link show. Abra-a em um único lugar. Uma tela que não foi pareada responde resource_conflict (código de saída 5), e uma tela arquivada responde screen_archived. Após uma requisição interrompida, execute de novo o mesmo comando: ele reutiliza a chave de idempotência salva e retorna o mesmo link.

Imprimir o link de uma tela e sua URL do Player.

screen link show <id>

screenrig screen link show scr_01EXAMPLESCREEN00000000

Imprime data.url sob um rótulo sensível com data.hint (os quatro últimos caracteres do segredo), data.created_at e data.last_used_at depois que um Player abre o link. Uma credencial somente leitura recebe url vazio com url_redacted true, e a saída humana informa que a URL foi retida; um login Manage a recebe. Uma tela sem link responde screen_link_not_found (código de saída 4) e nomeia o comando que cria um. screen show imprime Screen link: on (…HINT) para uma tela que tem um, e nunca sua URL.

Desativar o link de uma tela.

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

screenrig screen link delete scr_01EXAMPLESCREEN00000000

A URL para de funcionar imediatamente e toda sessão que ela abriu termina: uma fonte de navegador que ainda a exibe mostra um aviso e nenhum conteúdo até receber uma nova URL. A tela, seu pareamento e seu conteúdo não são alterados. Tem sucesso, sem alterar nada, quando a tela não tem link.

Peça ao Player de uma tela, ou a todos os Players de uma frota, para recarregar uma vez.

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

A resposta traz um reload_id, um state e um expires_at. Uma tela online recebe o recarregamento imediatamente (state sent); uma tela offline o mantém como queued e o recebe quando fica online antes de expires_at, 24 horas após o pedido, a menos que --expires-in diga o contrário. Um recarregamento mais recente substitui um que ainda está na fila; screen show lista os commands da tela e screen command cancel cancela um que ainda está na fila. Em uma frota, o reload de cada resultado traz o mesmo state. Um Player web recarrega na próxima troca de página; um Player nativo reconecta, refaz o manifesto e verifica atualizações. Um Player ignora um recarregamento dentro de dez minutos do último que executou. Recarregar funciona em telas ativas e arquivadas e não altera a revisão da tela.

Publique uma mensagem transitória como chrome de palco em uma tela ao vivo ou em uma frota.

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"

Um toast não é um primitivo: não ocupa slot de canvas, não tem camada, e não participa de prontidão ou crossfade. O último vence, não há fila nem cancelamento, e o envelope aceito é só { expires_at }. Nunca coloque credenciais ou outro material secreto no texto.

Mostrar o nome de uma tela sobre o conteúdo dela por um tempo, para encontrá-la no local.

screen identify <id> [--duration DURATION]

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

O Player desenha uma sobreposição em tela cheia sobre seu conteúdo, com o nome da tela bem grande e o id dela pequeno logo abaixo. A reprodução continua por baixo, e uma identificação mais recente substitui a sobreposição. O envelope aceito traz identify_id, duration_ms e um expires_at 60 segundos após o pedido, de modo que uma tela offline nunca a mostra depois. Somente um Player que declara a capacidade identify mostra a sobreposição: qualquer outra tela responde 409 identify_unsupported (código de saída 5) e nada é enviado; atualize o Player ou mostre o nome com screen toast. Uma tela arquivada responde screen_archived e uma tela que ainda aguarda pareamento responde resource_conflict. Identificar não altera a revisão da tela.

Capture uma imagem estática de uma tela ativa, ou de todas as telas de uma frota, e grave no disco.

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

O comando bloqueia até que o WebP esteja no disco; não há --no-wait. O envelope relata screen_id, capture_id, path, bytes, sha256, width e height, e nunca bytes da imagem. O mais recente vence: uma requisição posterior substitui uma captura em andamento. Uma captura de tela do Player web desenha cada página iframe como um bloco cinza-escuro com o rótulo “Embedded web page” e cada aplicativo como ele mesmo se renderiza; a imagem não traz marcação do bloco, então não prova que uma página iframe foi renderizada.

Para vários IDs ou --tag, a resposta é um resultado da frota com action: "screenshot", o selector, e o diretório output; cada resultado ok carrega path, bytes, sha256, width e height. Com --tag, o CLI lista primeiro as telas marcadas, seguindo cada página da lista; cada página é cobrada e as capturas são gratuitas, e vários IDs não precisam de lista. --idempotency-key é recusado nesta forma, pois cada captura usa sua própria chave. Se uma captura falhar inesperadamente, o resultado dessa tela é unexpected_error, nenhuma nova captura começa, as telas ainda aguardando relatam not_attempted, e o código de saída é 1.

Definir, adicionar, remover ou limpar as tags em uma tela ou frota.

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

Uma tag tem de 1 a 32 letras ou dígitos, e uma tela carrega no máximo 16 tags únicas. Tags selecionam frotas; nunca são autorização e nunca chegam ao Player. Mudar tags atualiza a revisão da tela, não a do manifesto. Para uma tela o envelope é a tela atualizada. --add e --remove leem a tela primeiro e escrevem o novo conjunto protegido por --expect-rev ou a revisão recém-lida, então uma mudança concorrente retorna revision_conflict (exit 6) ao invés de ser sobrescrita; execute o comando novamente. Em uma frota, --add e --remove aplicam-se atomica e individualmente ao conjunto armazenado de cada tela, e uma tela que ultrapassaria 16 tags falha em seu próprio resultado com invalid_request.

Sempre que as tags mudam (screen tag, uma atualização de tela pela API, o editor de tags do painel), o levels da resposta lista, em gained e lost, as campanhas cujo público de tag a tela passou a integrar ou deixou, cada uma com seu source (campaign), id, a contagem de screens e, quando a campanha tem alcance, reach_before e reach_after. Um screen tag da frota os soma em toda a frota. Leia levels.lost antes de chamar uma edição de tag de inofensiva: remover a última tag correspondente das telas de uma campanha esvazia esse grupo e dispara as notificações reach_dropped e group_empty.

Mostrar a programação da playlist de uma tela e a playlist que ela seleciona atualmente.

screen schedule show <id>

screenrig screen schedule show scr_CAFE

A saída JSON pode ir direto para screen schedule set --file.

Substituir a programação da playlist em uma tela ou frota.

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

Cada playlist nomeada em uma programação é validada como uma atribuição, e a tela precisa de um fuso horário e uma playlist padrão atribuída. Quando nenhuma entrada vigora, a playlist atribuída é reproduzida. Se uma playlist programada não puder ser exibida depois, suas entradas são puladas e screen.playlist_unavailable é registrado.

Remover a programação da playlist de uma tela ou frota.

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

screenrig screen schedule clear --tag Cafe

Mostrar o que mudaria ao substituir o cronograma de playlists de uma tela, sem fazê-lo.

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

Nada é gravado. As entradas são verificadas como screen schedule set as verifica, então uma prévia recusa o que o set recusa. data.gained e data.lost dizem se a tela ganharia ou perderia níveis do seu cronograma; uma entrada com "paused": true não está em nenhuma tela, então publicá-la a ganha. data.calendar.before e data.calendar.after são o calendário da tela como está e como ficaria de --calendar-from a --calendar-to.

Listar as revisões do cronograma de playlists de uma tela, a mais recente primeiro.

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

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

data.items contém no máximo 50 revisões, cada uma com revision (a revisão da tela na gravação, por isso os números têm lacunas onde a tela mudou de outra forma), created_at, change, current, author quando conhecido e entries, o cronograma inteiro após essa gravação (none significa que a tela não tinha cronograma). change é edited (um set, um clear ou uma importação de cronograma), restored (uma cópia da revisão anterior que restored_from nomeia) ou baseline. Enquanto data.next_cursor for uma string, restam revisões mais antigas: execute o comando de novo com --after definido com esse valor. As revisões somem com a exclusão definitiva da tela. Acesso somente leitura basta.

Colocar de volta numa tela o cronograma de uma revisão anterior copiando-o para a frente.

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

As entradas da revisão N tornam-se o cronograma da tela, a mesma gravação que screen schedule set com essas entradas (ou screen schedule clear quando essa revisão não tinha nenhuma), verificadas como são verificadas agora: uma playlist excluída desde então a recusa. Com acesso Propose, ou em um projeto que exige revisão das mudanças dos agentes, a restauração aguarda uma pessoa como o set, e nada muda na tela até que ela aprove. As revisões anteriores ficam como estavam.

Exiba uma playlist em uma tela ou frota antes de campanhas, da programação e da atribuição.

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 é a abreviação de screen takeover set ID. Um takeover novo substitui o anterior. Quando termina, a tela retorna automaticamente a uma campanha em vigor, à sua programação ou à sua playlist atribuída. Um takeover cuja playlist não pode ser exibida termina. Uma reexecução --for após uma falha ambígua calcula um novo fim e é enviada como uma nova solicitação.

Encerrar a tomada de controle em uma tela ou frota.

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

screenrig screen takeover clear --tag Lobby

Listar as campanhas do projeto na ordem em que as telas as leem.

campaign list

Sem parâmetros.

screenrig campaign list

data.items contém no máximo 100 campanhas, maior prioridade primeiro e, dentro de uma prioridade, a mais recente primeiro. Uma campanha pausada é listada e não se aplica em lugar nenhum.

Leia uma campanha.

campaign show <id>

screenrig campaign show cmp_LUNCH

Retorna name, playlist_id, audience (a regra exata), priority, paused, os from, until, windows, monthly, dates, except, interaction, displays e start que estão definidos, e revision, o valor para --expect-rev em uma gravação posterior. reach informa quantas telas o público-alvo reúne: published quando a campanha foi publicada pela última vez (criada, ou atualizada com um novo público-alvo, playlist ou estado de pausa), current e at para a contagem mais recente, e empty_groups, as folhas tag:NAME e folder:ID do público-alvo que não correspondem a nenhuma tela. Uma tag, pasta, arquivamento ou exclusão que muda a contagem é recontada em cerca de 15 segundos; campaign list também traz reach, e as notificações reach_dropped e group_empty a observam. Um id de ads campaigns list responde not_found (saída 4) aqui.

Mudar as telas de um público-alvo para uma playlist, sempre ou enquanto suas regras vigoram.

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

Tags têm de 1 a 32 letras ou dígitos. DAYS é daily, um dia (mon), um intervalo (mon-fri; fri-mon atravessa o fim da semana) ou uma lista separada por vírgulas (sat,sun). Sem um horário, a janela é o dia inteiro, e um fim igual ou anterior ao início cruza a meia-noite e pertence ao dia de início. Em uma regra --audience, cada membro tem exatamente um entre all, any, tag, screen_id ou folder, os grupos se aninham em no máximo 3 níveis, um público-alvo tem no máximo 500 regras, e {"all":[]} equivale a todas as telas.

Após uma criação interrompida ou ambígua, execute novamente o comando idêntico dentro de 24 horas: ele reutiliza a chave de idempotência salva, e o servidor retorna a mesma campanha em vez de criar outra.

Alterar uma campanha; as telas do seu público-alvo antigo e do novo são resolvidas novamente em até um minuto.

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

Passe pelo menos uma alteração; apenas os campos que você passar mudam. Um novo --playlist-id é verificado como na criação. Após uma solicitação interrompida ou ambígua, execute novamente o comando idêntico: ele reutiliza a chave de idempotência salva, e o servidor retorna a atualização que já aconteceu em vez de aplicá-la novamente.

Interromper uma campanha em todas as telas sem excluí-la.

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

screenrig campaign pause cmp_LUNCH

As telas que a exibiam voltam ao que exibiriam sem ela em até um minuto. campaign resume a inicia novamente.

Iniciar novamente uma campanha pausada.

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

screenrig campaign resume cmp_LUNCH

Toda tela do público-alvo à qual a campanha pode se aplicar muda para a playlist da campanha em até um minuto enquanto a campanha vigora.

Excluir uma campanha.

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

screenrig campaign delete cmp_LUNCH

A campanha não volta. Toda tela que a exibe volta ao que exibiria sem ela em até um minuto; playlists, telas e tags permanecem. campaign pause interrompe uma campanha e a mantém.

Mostrar as telas que uma campanha alcança e a situação de cada uma.

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