Vovó Ajuda

API da Vovó 1

Gerada a partir do próprio código da Vovó, então sempre bate com esta versão. Texto vindo de viewers chega sempre como texto puro, nunca como HTML.

Eventos simples

Iguais em todas as plataformas; {platform} diz qual. Para o que só uma plataforma tem, use o evento dela, mais abaixo.

follow

Alguém seguiu o canal. Vem de twitch.follow.

sub

Alguém se inscreveu, renovou ou ganhou uma inscrição. Vem de twitch.sub.

raid

Outro canal mandou uma raid para este. Vem de twitch.raid.

chat

Uma mensagem no chat. Vem de twitch.chat.

tip

Alguém mandou dinheiro ou bits. Vem de twitch.cheer.

Twitch

twitch.follow

Um follow na Twitch.

twitch.sub

Uma inscrição, renovação ou inscrição presenteada na Twitch.

twitch.raid

Uma raid na Twitch.

twitch.chat

Uma mensagem no chat da Twitch.

twitch.viewers

Quantas pessoas assistem à live. A Twitch é lida mais ou menos uma vez por minuto enquanto a live está no ar; isto chega quando o número muda, e com live falso quando a live acaba.

twitch.cheer

Bits enviados na Twitch.

twitch.redemption

Uma recompensa de pontos do canal resgatada.

twitch.redemption.resolved

Um resgate na fila da recompensa foi aprovado ou rejeitado (rejeitado devolve os pontos).

twitch.hypetrain

Um hype train começou, andou ou terminou.

Da Vovó e do OBS

button

O botão dela no pad foi apertado.

hotkey

Um atalho global foi apertado, com o jogo na frente ou não. O gatilho diz a combinação com uma condição, keys é Ctrl+Alt+1, e o app escuta enquanto o perfil está no ar.

timer

Um timer disparou. O gatilho diz de quanto em quanto tempo com uma condição, every é um número de segundos (5 ou mais); sem ela, dispara a cada minuto. Conta a partir de quando o gatilho aparece, e para durante o pânico.

control

Um dos controles da ação foi mudado no pad. O novo valor também fica em vovo.state, na chave do controle, então uma página aberta depois o mostra. Uma ação que oferece controles recebe isto sem precisar adicioná-lo como gatilho.

settings

O que foi escolhido das configurações da ação mudou, em Personalizar: vovo.settings, as variáveis --vovo-<chave> e os atributos data-vovo-<chave> já têm os novos valores. Uma ação que declara configurações recebe isto sem precisar adicioná-lo como gatilho.

panel

Algo foi feito no painel da ação (panel no manifesto dela, mostrado em Painéis, na barra lateral): um botão apertado, um formulário enviado, ou um botão numa linha de uma lista. Como o control, uma ação com painel recebe isto sem adicioná-lo como gatilho; só quem opera a live o dispara.

webhook

Um webhook de entrada foi chamado.

obs.scene

O OBS trocou de cena.

media.track

O que toca neste computador mudou: outra faixa, ou play e pausa. Vem de qualquer app que conta ao Windows o que está tocando (Spotify, um navegador, um player).

audio.level

O volume do microfone, umas 20 vezes por segundo enquanto muda: para uma boca que mexe, um medidor, um brilho. A Vovó só escuta enquanto um overlay aberto mostra uma ação que espera isto; o som em si nunca sai do computador, só o volume.

screen.color

A cor da tela principal, algumas vezes por segundo enquanto muda: para um brilho ou uma moldura que acompanha o jogo. Lida só enquanto um overlay aberto mostra uma ação que espera isto; o overlay de tela da Vovó nunca entra.

input.move

Como quem faz a live se move num jogo, até 60 vezes por segundo enquanto muda: o quanto a câmera girou, para onde anda e se pula. Para uma cena que balança com a câmera, inclina no strafe e afunda no pulo. Vem do mouse, das teclas de movimento (W, A, S e D pelo lugar no teclado, qualquer que seja o layout, ou as setas, e a barra de espaço) e do primeiro controle conectado (os analógicos e o botão A), sempre como uma direção, nunca como qual tecla. Lido só enquanto um overlay aberto mostra uma ação que espera isto, nada do resto do teclado, e as teclas não enquanto a janela da própria Vovó está na frente (o mouse e um controle sim, a não ser que o computador pause também). Um jogo aberto como administrador pode esconder a entrada dele da Vovó, que roda sem isso.

speech.text

O que quem faz a live falou no microfone, escrito uma frase por vez, para legendas: pelo Whisper neste computador, ou pela OpenAI quando quem faz a live escolheu (Configurações > Voz, Fala em texto). O microfone só é lido enquanto um overlay aberto mostra uma ação ouvindo isto; cada frase chega quando a pausa dela termina, um ou dois segundos depois de dita, e nada é guardado.

screen.shared

Uma tela compartilhada entrou no ar ou saiu dele: uma tela, uma janela ou uma aba do navegador, a de quem faz a live (capturada pela própria Vovó, ou pela página de compartilhar dela no navegador), ou a de um convidado que quem faz a live pôs no ar. Uma ação que a posiciona (vovo.screen.place) a mostra. Chega de novo, com on ainda verdadeiro, quando outra coisa toma o lugar do que era compartilhado.

camera

Uma câmera que a ação posicionou (vovo.camera.place) começou a aparecer na página dela, ou parou: quem faz a live ligou ou desligou a câmera, o pânico a desligou, ela foi desconectada, ou outro programa está usando. Como settings, uma ação que posiciona uma câmera recebe isto sem adicionar como gatilho.

persona.answer

A persona respondeu alguém, aprovada quando a aprovação está ligada. O app já manda no chat e fala, quando está configurado; uma ação mostra.

tts.spoken

O app leu algo em voz alta no ar: uma mensagem do chat que quem faz a live escolheu ler, ou o texto de uma recompensa, depois de aprovado. Ele mesmo fala, na voz de leitura (Configurações > Voz); uma ação mostra, ou dá à boca de um personagem o que fazer. Uma linha que a própria persona escreveu no chat vem com persona verdadeiro, e o app só a fala na voz da persona quando a persona está configurada para falar, então uma ação que dá voz à persona a diz no lugar dele.

music.request

Um viewer pediu uma música do player da Vovó, pela recompensa ou pelo comando no chat (Configurações > Música), e isto é o que aconteceu com o pedido: espera aprovação, entrou na fila, começou a tocar, foi descartado, ou foi recusado e por quê. A Vovó não escreve nada no chat; uma ação responde lá, ou mostra quem pediu o que toca.

sound.played

Um botão de som do pad tocou o som dele, ou o que sorteou entre os sons dele.

video.played

Um botão de vídeo do pad tocou o vídeo dele sobre o palco, ou o que sorteou entre os vídeos dele.

remote.talk

Alguém falou no ar pelo celular, segurando o botão de falar como num walkie-talkie: a voz dele toca agora em todos os overlays da live, pela página da cena. Uma ação mostra quem está falando, enquanto fala.

call.started

A chamada de voz que a ação pediu (vovo.call.start) está aberta: o modelo está lá, ouvindo silêncio, e o que ele diz ainda não toca, até o vovo.call.answer. Toda página que mostra a ação ouve isto, então cada uma toca o seu telefone e atende no mesmo passo.

call.answered

A chamada foi atendida (vovo.call.answer, de qualquer página): o microfone chega ao modelo e a voz dele toca na live.

call.text

O que acabou de ser dito na chamada, por escrito, poucas palavras por vez e enquanto se fala: os dois lados podem se sobrepor. Para uma legenda ou uma transcrição; a voz quem toca é a página da cena.

call.ended

A chamada acabou, ou nem abriu: a voz parou em todas as páginas.

overlay.connected

Uma página de overlay do perfil ativo conectou: o OBS carregou ou recarregou uma cena. As ações da própria página também ouvem, assim que carregam.

JavaScript

Templates

{campo} dentro de um template é preenchido com aquele campo do evento, como texto puro.

CSS

Permissões

A ação pede estas no manifesto, e quem a instala as aprova.