Skip to content

holyrics/API-Server

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
README-en.md
README-en.md
 
 
README.md
README.md
 
 

Repository files navigation

API-Server

PT | EN

O programa Holyrics disponibiliza uma interface de comunicação para receber requisições tanto pela rede local quanto pela internet.
Ao realizar uma requisição, a implementação padrão desta documentação será utilizada.
Mas também é possível implementar um método JavaScript no próprio programa Holyrics para que as requisições sejam redirecionadas para esse método e executar ações customizadas conforme necessidade.
Utilize o método POST e o Content-Type: application/json para realizar as requisições.
É necessário adicionar na URL da requisição o parâmetro token, que é criado nas configurações API Server, opção 'gerenciar permissões'.
Você pode criar múltiplos tokens e definir as permissões de cada token.

Para acessar as configurações API Server:
Menu arquivo > Configurações > API Server

v2.25.0+ Adicionada compatibilidade com ETag

Exemplo de requisição pela rede local

Você pode passar o token na URL para realizar a requisição.
Porém por se tratar de conexão local sem SSL, se você quiser uma maior segurança, utilize o método "hash" para enviar as requisições sem precisar informar o token de acesso na requisição.

URL padrão - Utilizando token

http://[IP]:[PORT]/api/{action}?token=abcdef

URL padrão - Utilizando hash

http://[IP]:[PORT]/api/{action}?dtoken=xyz123&sid=456&rid=3

dtoken
hash gerado para cada requisição a partir de um 'nonce' (token temporário) obtido pelo servidor

sid
ID da sessão, obtido junto com o nonce

rid: request id
Enviado pelo cliente, um número positivo que deve ser sempre maior do que o utilizado na requisição anterior

Requisição

Utilizando token
curl -X 'POST' \
  'http://ip:port/api/GetCPInfo?token=abcdef' \
  -H 'Content-Type: application/json' \
  -d '{}'

Utilizando hash
nonce = '1a2b3c';  <- token temporário
rid   = 4;         <- id da requisição
token = 'abcdef';  <- token de acesso
data  = '{}';      <- conteúdo da requisição

dtoken é o resumo sha256 da concatenação das informações da requisição conforme exemplo
dtoken = sha256(nonce + ':' + rid + ':' + token + ':' + data);
resultado: f3391f69cbe03940bd0d4a63ee191092aab2f3573f56b410a9cf94da05d4cdb5

curl -X 'POST' \
  'http://ip:port/api/GetCPInfo?sid=abc&rid=4&dtoken=f3391f69cbe03940bd0d4a63ee191092aab2f3573f56b410a9cf94da05d4cdb5' \
  -H 'Content-Type: application/json' \
  -d '{}'

Resposta

{
    "status": "ok",
    "data": {
        "text": "",
        "show": false,
        "display_ahead": false,
        "alert_text": "",
        "alert_show": false,
        "countdown_show": false,
        "countdown_time": 0
    }
}

Requisição

Utilizando token
curl -X 'POST' \
  'http://ip:port/api/SetTextCP?token=abcdef' \
  -H 'Content-Type: application/json' \
  -d '{"text": "Example", "show": true, "display_ahead": true}'

Utilizando hash
nonce = '1a2b3c';
rid   = 5;
token = 'abcdef';
data  = '{"text": "Example", "show": true, "display_ahead": true}';

dtoken = sha256(nonce + ':' + rid + ':' + token + ':' + data);
resultado: 02a7789759694c535cd032489bf101110837c972d76cec51c7ad7e797696749d

curl -X 'POST' \
  'http://ip:port/api/SetTextCP?sid=abc&rid=5&dtoken=02a7789759694c535cd032489bf101110837c972d76cec51c7ad7e797696749d' \
  -H 'Content-Type: application/json' \
  -d '{"text": "Example", "show": true, "display_ahead": true}'

Resposta

{ "status": "ok" }

No caso de erro, status irá retornar error, exemplo:

{
    "status": "error",
    "error": "invalid token"
}

Como obter um nonce

Utilize a ação 'Auth' sem incluir parâmetros na URL para obter um nonce

Requisição
http://ip:port/api/Auth

Resposta
{
    "status": "ok",
    "data": {
        "sid": "u80fbjbcknir",
        "nonce":"b58ba4f605bed27c40a20be53ee3cf3d"
    }
}

Utilize a ação 'Auth' novamente para se autenticar, passando os parâmetros na URL

nonce = 'b58ba4f605bed27c40a20be53ee3cf3d';
rid   = 0;       <- deve ser zero para autenticação
token = '1234';  <- token de acesso
data  = 'auth';  <- deve ser 'auth' para autenticação

dtoken = sha256(nonce + ':' + rid + ':' + token + ':' + data);
resultado: 5d632009dfde5e9771b4f98f1b28c88ac2f73ae1f9d81b62a9af241a304c4d7a

http://ip:port/api/Auth?sid=u80fbjbcknir&rid=0&dtoken=5d632009dfde5e9771b4f98f1b28c88ac2f73ae1f9d81b62a9af241a304c4d7a

Resposta
{ "status": "ok" }

Exemplo de requisição pela rede internet

Utilize o valor API_KEY disponível nas configurações do API Server para realizar as requisições no endpoint do servidor do Holyrics juntamente com o token de acesso.

Requisição - send

Apenas envia a requisição sem aguardar retorno

URL padrão

https://api.holyrics.com.br/send/{action}

Requisição

curl -X 'POST' \
  'https://api.holyrics.com.br/send/SetTextCP' \
  -H 'Content-Type: application/json' \
  -H 'api_key: API_KEY' \
  -H 'token: abcdef' \
  -d '{"text": "Example", "show": true, "display_ahead": true}'

Resposta

{ "status": "ok" }

O status das requisições send informa apenas se a requisição foi enviada ao Holyrics aberto no computador.

Requisição - request

Envia a requisição e aguarda a resposta

URL padrão

https://api.holyrics.com.br/request/{action}

Requisição

curl -X 'POST' \
  'https://api.holyrics.com.br/request/GetCPInfo' \
  -H 'Content-Type: application/json' \
  -H 'api_key: API_KEY' \
  -H 'token: abcdef' \
  -d '{}'

Resposta

{
  "status": "ok",           <-  status do envio da requisição ao Holyrics
  "response_status": "ok",  <-  status da resposta da requisição enviada
  "response": {             <-  resposta da requisição
    "status": "ok",
    "data": {
        "text": "Example",
        "show": true,
        "display_ahead": true,
        "alert_text": "",
        "alert_show": false,
        "countdown_show": false,
        "countdown_time": 0
    }
  }
}

Exemplos de erro no envio da requisição:

{
    "status": "error",
    "error": {
        "code": 9,
        "key": "device_disconnected",
        "message": "Device disconnected"
    }
}

{
    "status": "error",
    "error": {
        "code": 403,
        "key": "invalid_api_key",
        "message": "Invalid API Key"
    }
}

Exemplos de erro na resposta da requisição:

{
  "status": "ok",           <-  a requisição foi enviada ao computador
  "response_status": "ok",  <-  a resposta foi recebida
  "response": {             <-  resposta recebida do computador
      "status": "error",
      "error": "invalid token"
    }
  }
}

{
    "status": "ok",               <-  a requisição foi enviada ao computador
    "response_status": "timeout"  <-  o tempo aguardando a resposta foi esgotado
}

Exemplo de implementação JavaScript

Utilize os métodos da classe JSLIB para criar sua própria implementação.
Se você criar sua própria implementação, é necessário retornar 'true' se quiser que o programa consuma a requisição utilizando a implementação padrão.
Qualquer valor retornado que seja diferente de 'true', o programa irá considerar que a requisição já foi consumida e vai respondê-la com o valor retornado.

function request(action, headers, content, info) {
    switch (action) {
        case 'my_custom_action':
            //executar sua própria ação e resposta
            return {'status': 'ok'}; //  <-  Resposta da requisição
    }
    //Retornando 'true' para o programa consumir esta requisição com a implementação padrão
    return true;
}

Parâmetros do método

action - Nome da ação

headers - Contém os cabeçalhos da requisição. Exemplo: headers.Authorization

content - Objeto com o conteúdo extraído da requisição. Exemplo: content.theme.id

info - Informações da requisição.
info.client_address Endereço da origem da requisição
info.token token de acesso utilizado na requisição
info.local true se a origem da requisição for da rede local
info.web true se a origem da requisição for da internet

Ações disponíveis

GetTokenInfo

  • v2.25.0

Obtém a informação do token

Resposta:

Nome Tipo Descrição
data.version String Versão no formato: X.Y.Z
data.permissions String Ações permitidas para o token, separados por vírgula

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "version": "2.25.0",
    "permissions": "GetSongs,GetFavorites"
  }
}

CheckPermissions

  • v2.25.0

Verifica se o token tem as permissões requeridas.
Retorna status=ok se o token tiver todas as permissões requeridas no parâmetro actions.
Retorna code 401 se o token não tiver todas as permissões requeridas.

Parâmetros:

Nome Tipo Descrição
actions String Lista de ações requeridas para o token, separados por vírgula

Resposta:

Nome Tipo Descrição

Disponível se status=error
error.unauthorized_actions String (opcional) Ações não permitidas, separados por vírgula
error.request_status String (opcional) pending foi criada uma notificação solicitando permissão ao usuário na interface do programa
 
denied a solicitação de permissão foi negada

Exemplo:

Requisição
{
  "actions": "GetSongs,GetFavorites"
}

Resposta
{
  "status": "error",
  "error": {
    "unauthorized_actions": "GetFavorites",
    "request_status": "pending"
  }
}

GetLyrics

GetSong

  • v2.19.0

Retorna uma música.

Parâmetros:

Nome Tipo Descrição
id String ID da música
fields String (opcional) Nome dos campos separados por vírgula. Se este campo for declarado, apenas os campos especificados serão retornados v2.24.0+

Resposta:

Nome Tipo Descrição
data Lyrics Música ou NULL se não for encontrado

Exemplo:

Requisição
{
  "id": "123"
}

Resposta
{
  "status": "ok",
  "data": {
    "id": "123",
    "title": "",
    "artist": "",
    "author": "",
    "note": "",
    "key": "",
    "bpm": 0,
    "time_sig": "",
    "groups": [
      {
        "name": "Group 1"
      },
      {
        "name": "Group 2"
      }
    ],
    "archived": false
  }
}

GetSongs

  • v2.21.0

Retorna a lista de músicas

Parâmetros:

Nome Tipo Descrição
fields String (opcional) Nome dos campos separados por vírgula. Se este campo for declarado, apenas os campos especificados serão retornados v2.24.0+

Resposta:

Nome Tipo
data Array<Lyrics>

Exemplo:

Requisição
{
  "fields": "id,title,artist,author"
}

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "0",
      "title": "",
      "artist": "",
      "author": "",
      "note": "",
      "copyright": "",
      "key": "",
      "bpm": 0.0,
      "time_sig": "",
      "groups": [],
      "extras": {
        "extra": ""
      },
      "archived": false
    },
    {
      "...": "..."
    },
    {
      "...": "..."
    }
  ]
}

SearchLyrics

SearchSong

  • v2.19.0

Realiza uma busca na lista de letras do usuário

Parâmetros:

Nome Tipo Descrição
input String Filtro
text String Texto a ser pesquisado
title Boolean (opcional) Padrão: true
artist Boolean (opcional) Padrão: true
note Boolean (opcional) Padrão: true
lyrics Boolean (opcional) Padrão: false
group String (opcional)
fields String (opcional) Nome dos campos separados por vírgula. Se este campo for declarado, apenas os campos especificados serão retornados v2.24.0+

Resposta:

Nome Tipo
data Array<Lyrics>

Exemplo:

Requisição
{
  "text": "abc"
}

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "123",
      "title": "abc1",
      "artist": "",
      "author": "",
      "note": "",
      "key": "",
      "bpm": 0,
      "time_sig": "",
      "groups": [],
      "archived": false
    },
    {
      "id": "456",
      "title": "abc2",
      "artist": "",
      "author": "",
      "note": "",
      "key": "",
      "bpm": 0,
      "time_sig": "",
      "groups": [],
      "archived": false
    }
  ]
}

ShowLyrics

ShowSong

  • v2.19.0

Inicia uma apresentação de letra de música.

Parâmetros:

Nome Tipo Descrição
id String ID do item
initial_index Number (opcional) Índice inicial da apresentação Padrão: 0 v2.23.0+

Método sem retorno

Exemplo:

Requisição
{
  "id": "123"
}

GetText

  • v2.21.0

Retorna um texto.

Parâmetros:

Nome Tipo Descrição
id String ID do texto
fields String (opcional) Nome dos campos separados por vírgula. Se este campo for declarado, apenas os campos especificados serão retornados v2.24.0+

Resposta:

Nome Tipo Descrição
data Text Texto ou NULL se não for encontrado

Exemplo:

Requisição
{
  "id": "xyz"
}

Resposta
{
  "status": "ok",
  "data": {
    "id": "",
    "title": "",
    "folder": "",
    "theme": null,
    "slides": [
      {
        "text": "Slide 1 line 1\nSlide 1 line 2",
        "background_id": null
      },
      {
        "text": "Slide 2 line 1\nSlide 2 line 2",
        "background_id": null
      },
      {
        "text": "Slide 3 line 1\nSlide 3 line 2",
        "background_id": null
      }
    ],
    "extras": {}
  }
}

GetTexts

  • v2.21.0

Retorna a lista de textos

Parâmetros:

Nome Tipo Descrição
fields String (opcional) Nome dos campos separados por vírgula. Se este campo for declarado, apenas os campos especificados serão retornados v2.24.0+

Resposta:

Nome Tipo
data Array<Text>

Exemplo:

Requisição
{
  "fields": "id,title,folder"
}

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "",
      "title": "",
      "folder": "",
      "theme": null
    },
    {
      "...": "..."
    },
    {
      "...": "..."
    }
  ]
}

SearchText

  • v2.21.0

Realiza uma busca na lista de textos do usuário

Parâmetros:

Nome Tipo Descrição
input String Filtro
text String Texto a ser pesquisado
fields String (opcional) Nome dos campos separados por vírgula. Se este campo for declarado, apenas os campos especificados serão retornados v2.24.0+

Resposta:

Nome Tipo
data Array<Lyrics>

Exemplo:

Requisição
{
  "text": "example"
}

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "",
      "title": "",
      "folder": "",
      "theme": null
    },
    {
      "...": "..."
    },
    {
      "...": "..."
    }
  ]
}

ShowText

  • v2.19.0

Inicia uma apresentação de um item da aba texto.

Parâmetros:

Nome Tipo Descrição
id String ID do item
initial_index Number (opcional) Índice inicial da apresentação Padrão: 0 v2.23.0+

Método sem retorno

Exemplo:

Requisição
{
  "id": "abc"
}

ShowVerse

  • v2.19.0

Inicia uma apresentação de versículo da Bíblia.
Obs: É possível exibir, no máximo, 100 versículos diferentes em uma mesma requisição.

Parâmetros:

Nome Tipo Descrição
input Object id, ids ou references
id String (opcional) Para exibir um versículo. ID do item no formato LLCCCVVV.
Exemplo: '19023001' (livro 19, capítulo 023, versículo 001)
ids Array<String> (opcional) Para exibir uma lista de versículos. Lista com o ID de cada versículo.
Exemplo: ['19023001', '43003016', '45012002']
references String (opcional) Referências. Exemplo: João 3:16 ou Rm 12:2 ou Gn 1:1-3 Sl 23.1
version String (opcional) Nome ou abreviação da tradução utilizada v2.21.0+
quick_presentation Boolean (opcional) true para exibir o versículo através de uma janela popup de apresentação rápida.
Permite, por exemplo, iniciar a apresentação de um versículo sem encerrar a apresentação atual, voltando pra apresentação atual quando encerrar a apresentação do versículo. Padrão: false v2.24.0+

Método sem retorno

Exemplo:

Requisição
{
  "id": "19023001",
  "ids": [
    "19023001",
    "43003016",
    "45012002"
  ],
  "references": "Rm 12:2  Gn 1:1-3  Sl 23"
}

GetAudios

GetVideos

GetImages

GetFiles

  • v2.19.0

Retorna a lista de arquivos da respectiva aba: áudio, vídeo, imagem, arquivo

Parâmetros:

Nome Tipo Descrição
folder String (opcional) Nome da subpasta para listar os arquivos
filter String (opcional) Filtrar arquivos pelo nome
include_metadata Boolean (opcional) Adicionar metadados na resposta Padrão: false v2.22.0+
include_thumbnail Boolean (opcional) Adicionar thumbnail na resposta (80x45) Padrão: false v2.22.0+

Resposta:

Nome Tipo Descrição
data Array<Object>
data.*.name String Nome do item
data.*.isDir Boolean Retorna true se for uma pasta ou false se for arquivo.
data.*.properties Object Mapa com as propriedades customizadas definidas para o arquivo v2.24.0+

Disponível se include_metadata=true
data.*.length Number Tamanho do arquivo (bytes). Disponível se isDir=false v2.22.0+
data.*.modified_time String Data de modificação do arquivo. Data e hora no formato: YYYY-MM-DD HH:MM v2.22.0+
data.*.modified_time_millis String Data de modificação do arquivo. (timestamp) v2.24.0+
data.*.duration_ms Number Duração do arquivo. Disponível se o arquivo for: audio ou vídeo v2.22.0+
data.*.width Number Largura. Disponível se o arquivo for: imagem ou vídeo v2.22.0+
data.*.height Number Altura. Disponível se o arquivo for: imagem ou vídeo v2.22.0+
data.*.position String Ajuste da imagem. Disponível para imagens. Pode ser: adjust extend fill v2.22.0+
data.*.blur Boolean Aplicar efeito blur v2.22.0+
data.*.transparent Boolean Exibir imagens com transparência v2.22.0+
data.*.last_executed_time String Data da última execução do arquivo. Data e hora no formato: YYYY-MM-DD HH:MM v2.24.0+
data.*.last_executed_time_millis Number Data da última execução do arquivo. (timestamp) v2.24.0+

Disponível se include_thumbnail=true
data.*.thumbnail String Imagem no formato base64 v2.22.0+

Exemplo:

Requisição
{
  "folder": "folder_name",
  "filter": "abc"
}

Resposta
{
  "status": "ok",
  "data": [
    {
      "name": "abcd",
      "isDir": true,
      "properties": {}
    },
    {
      "name": "abcd.jpg",
      "isDir": false,
      "properties": {}
    }
  ]
}

GetAudio

GetVideo

GetImage

GetFile

  • v2.24.0

Retorna os dados de um arquivo da lista de arquivos da respectiva aba: áudio, vídeo, imagem, arquivo

Parâmetros:

Nome Tipo Descrição
name String Nome do arquivo (incluindo subpasta)
include_metadata Boolean (opcional) Adicionar metadados na resposta Padrão: false
include_thumbnail Boolean (opcional) Adicionar thumbnail na resposta (80x45) Padrão: false

Resposta:

Nome Tipo Descrição
data Object
data.name String Nome do item
data.isDir Boolean Retorna true se for uma pasta ou false se for arquivo.
data.properties Object Mapa com as informações customizadas salvas no arquivo

Disponível se include_metadata=true
data.length Number Tamanho do arquivo (bytes). Disponível se isDir=false
data.modified_time String Data de modificação do arquivo. Data e hora no formato: YYYY-MM-DD HH:MM
data.modified_time_millis Number Data de modificação do arquivo. (timestamp)
data.duration_ms Number Duração do arquivo. Disponível se o arquivo for: audio ou vídeo
data.width Number Largura. Disponível se o arquivo for: imagem ou vídeo
data.height Number Altura. Disponível se o arquivo for: imagem ou vídeo
data.position String Ajuste da imagem. Disponível para imagens. Pode ser: adjust extend fill
data.blur Boolean Aplicar efeito blur
data.transparent Boolean Exibir imagens com transparência
data.last_executed_time String Data da última execução do arquivo. Data e hora no formato: YYYY-MM-DD HH:MM
data.last_executed_time_millis Number

Disponível se include_thumbnail=true
data.thumbnail String Imagem no formato base64

Exemplo:

Requisição
{
  "name": "filename.mp3",
  "include_metadata": true
}

Resposta
{
  "status": "ok",
  "data": {
    "name": "",
    "isDir": false,
    "length": 0,
    "modified_time": "",
    "modified_time_millis": 0,
    "duration_ms": 0,
    "width": 0,
    "height": 0,
    "position": "",
    "blur": false,
    "transparent": false,
    "last_executed_time": "",
    "last_executed_time_millis": 0,
    "properties": {}
  }
}

SetAudioItemProperty

SetVideoItemProperty

SetImageItemProperty

SetFileItemProperty

  • v2.24.0

Altera as informações customizadas de um arquivo

Parâmetros:

Nome Tipo Descrição
name String Nome do arquivo (incluindo subpasta)
properties Object Mapa chave/valor com as informações que serão alteradas. Os valores passados serão MESCLADOS com os valores existentes. Ou seja, não é necessário enviar parâmetros que não serão alterados (ou removidos).

Método sem retorno

Exemplo:

Requisição
{
  "name": "filename.mp3",
  "properties": {
    "key": "value 1",
    "abc": "value 2",
    "example": "value 3"
  }
}

PlayAudio

  • v2.19.0

Executa um áudio ou uma lista de áudios (pasta)

Parâmetros:

Nome Tipo Descrição
file String Nome do arquivo ou da pasta. Exemplo: arquivo.mp3 ou pasta ou pasta/arquivo.mp3
settings PlayMediaSettings (opcional) Configurações para execução da mídia v2.21.0+

Método sem retorno

Exemplo:

Requisição
{
  "file": "audio.mp3"
}

PlayVideo

  • v2.19.0

Executa um vídeo ou uma lista de vídeos (pasta)

Parâmetros:

Nome Tipo Descrição
file String Nome do arquivo ou da pasta. Exemplo: arquivo.mp4 ou pasta ou pasta/arquivo.mp4
settings PlayMediaSettings (opcional) Configurações para execução da mídia v2.21.0+

Método sem retorno

Exemplo:

Requisição
{
  "file": "video.mp4"
}

ShowImage

  • v2.19.0

Apresenta uma imagem ou uma lista de imagens (pasta)

Parâmetros:

Nome Tipo Descrição
file String Nome do arquivo ou da pasta. Exemplo: arquivo.jpg ou pasta ou pasta/arquivo.jpg
automatic Automatic (opcional) Se informado, a apresentação dos itens será automática

Método sem retorno

Exemplo:

Requisição
{
  "file": "image.jpg"
}

ExecuteFile

  • v2.21.0

Executa um arquivo. Somente extensões seguras ou adicionadas na lista de exceção.

Parâmetros:

Nome Tipo Descrição
file String Nome do arquivo

Método sem retorno

Exemplo:

Requisição
{
  "file": "file.txt"
}

AudioExists

VideoExists

ImageExists

FileExists

  • v2.21.0

Verifica se existe o arquivo com o nome informado

Parâmetros:

Nome Tipo Descrição
file String Nome do arquivo

Resposta:

Nome Tipo
data Boolean

Exemplo:

Requisição
{
  "file": "file.mp3"
}

Resposta
{
  "status": "ok",
  "data": true
}

ShowAnnouncement

  • v2.19.0

Apresenta um anúncio ou uma lista de anúncios

Parâmetros:

Nome Tipo Descrição
id String (opcional) ID do anúncio. Pode ser all para exibir todos
ids Array<String> (opcional) Lista com o ID de cada anúncio
name String (opcional) Nome do anúncio
names Array<String> (opcional) Lista com o nome de cada anúncio
automatic Automatic (opcional) Se informado, a apresentação dos itens será automática

Método sem retorno

Exemplo:

Requisição
{
  "id": "all",
  "ids": [],
  "name": "",
  "names": [],
  "automatic": {
    "seconds": 10,
    "repeat": true
  }
}

GetCustomMessages

  • v2.19.0

Lista das mensagens personalizadas

Resposta:

Nome Tipo
data Array<CustomMessage>

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "123",
      "name": "Carro",
      "message_model": "Atenção proprietário do veículo    , placa   -  .",
      "message_example": "Atenção proprietário do veículo modelo cor, placa placa - motivo_carro.",
      "variables": [
        {
          "position": 32,
          "name": "modelo",
          "only_number": false,
          "uppercase": false,
          "suggestions": []
        },
        {
          "position": 34,
          "name": "cor",
          "only_number": false,
          "uppercase": false,
          "suggestions": []
        },
        {
          "position": 43,
          "name": "placa",
          "only_number": false,
          "uppercase": true,
          "suggestions": []
        },
        {
          "position": 47,
          "name": "motivo_carro",
          "only_number": false,
          "uppercase": false,
          "suggestions": [
            "Favor comparecer ao estacionamento",
            "Faróis acesos",
            "Alarme disparado",
            "Remover o veículo do local",
            "Comparecer ao estacionamento com urgência"
          ]
        }
      ]
    }
  ]
}

ShowCustomMessage

  • v2.19.0

Exibir uma mensagem personalizada. Obs.: Uma mensagem personalizada não é exibida diretamente na tela. é criada uma notificação no canto da tela para o operador aceitar e exibir.

Parâmetros:

Nome Tipo Descrição
name String Nome da mensagem personalizada
position_? Object (opcional) Variável adicionada na posição especificada conforme valor retornado em variables.*.position da classe CustomMessage.
params Object (opcional) Método alternativo. Mapa chave/valor onde a chave é o nome do campo variables.*.name da classe CustomMessage. Se necessário adicionar o mesmo parâmetro, adicione *_n no final do nome, começando em 2
Exemplo: params.name, params.name_2, params.name_3 v2.21.0+
note String Informação extra exibida na janela popup para o operador

Método sem retorno

Exemplo:

Requisição
{
  "name": "Carro",
  "position_32": "modelo",
  "position_34": "cor",
  "position_43": "placa",
  "position_47": "motivo",
  "note": "..."
}

ShowQuickPresentation

  • v2.19.0

Apresentação rápida de um texto

Parâmetros:

Nome Tipo Descrição
text String Texto que será exibido. Styled Text a partir da v2.19.0
Opcional se slides for declarado
slides Array<QuickPresentationSlide> Parâmetro alternativo para apresentações mais complexas
Opcional se text for declarado v2.23.0+
theme ThemeFilter (opcional) Filtrar tema selecionado para exibição
custom_theme Theme (opcional) Tema personalizado utilizado para exibir o texto v2.21.0+
automatic Automatic (opcional) Se informado, a apresentação dos itens será automática
initial_index Number (opcional) Índice inicial da apresentação Padrão: 0 v2.23.0+

Método sem retorno

Exemplo:

Requisição
{
  "text": "Example",
  "theme": {
    "name": "Theme name"
  }
}

ShowCountdown

  • v2.20.0

Exibir uma contagem regressiva na tela público

Parâmetros:

Nome Tipo Descrição
time String HH:MM ou MM:SS
exact_time Boolean (opcional) Se true, time deve ser HH:MM (hora e minuto exato). Se false, time deve ser MM:SS (quantidade de minutos e segundos) Padrão: false
text_before String (opcional) Texto exibido na parte superior da contagem regressiva
text_after String (opcional) Texto exibido na parte inferior da contagem regressiva
zero_fill Boolean (opcional) Preencher o campo 'minuto' com zero à esquerda Padrão: false
hide_zero_minute Boolean (opcional) Ocultar a exibição dos minutos quando for zero Padrão: false v2.25.0+
countdown_relative_size Number (opcional) Tamanho relativo da contagem regressiva Padrão: 250
theme ThemeFilter (opcional) Filtrar tema selecionado para exibição v2.21.0+
countdown_style FontSettings (opcional) Fonte personalizada para a contagem regressiva v2.21.0+
custom_theme Theme (opcional) Tema personalizado v2.21.0+

Método sem retorno

Exemplo:

Requisição
{
  "time": "05:00",
  "zero_fill": true
}

GetQuizList

  • v2.26.0

Obter os grupos de múltipla escolha existentes

Resposta:

Nome Tipo
data Array<QuizGroup>

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "name": "",
    "questions": {
      "name": "",
      "title": "...",
      "alternatives": [
        "Item 1",
        "Item 2",
        "Item 3"
      ],
      "correct_alternative_number": 2,
      "source": ""
    },
    "settings": {
      "correct_answer_color_font": "00796B",
      "correct_answer_color_background": "CCFFCC",
      "incorrect_answer_color_font": "721C24",
      "incorrect_answer_color_background": "F7D7DB",
      "question_and_alternatives_different_slides": false,
      "display_alternatives_one_by_one": true,
      "alternative_separator_char": ".",
      "alternative_char_type": "alpha"
    }
  }
}

ShowQuiz

  • v2.20.0

Iniciar uma apresentação no formato múltipla escolha

Parâmetros:

Nome Tipo Descrição
questions Array<QuizQuestion> Questões para exibir
settings QuizSettings Configurações

Método sem retorno

Exemplo:

Requisição
{
  "questions": [
    {
      "name": "Name",
      "title": "Example 1",
      "alternatives": [
        "Example 1a",
        "Example 2a",
        "Example 3a",
        "Example 4a"
      ],
      "correct_alternative_number": 2
    },
    {
      "title": "Example 2",
      "alternatives": [
        "Example 1b",
        "Example 2b",
        "Example 3b",
        "Example 4b"
      ],
      "correct_alternative_number": 2
    }
  ],
  "settings": {
    "display_alternatives_one_by_one": false,
    "alternative_char_type": "number"
  }
}

QuizAction

  • v2.20.0

Executar uma ação em uma apresentação de múltipla escolha

Parâmetros:

Nome Tipo Descrição
action String (opcional) Um dos seguintes valores: previous_slide next_slide previous_question next_question show_result close
hide_alternative Number (opcional) Ocultar uma alternativa. Começa em 1
select_alternative Number (opcional) Selecionar uma alternativa. Começa em 1
countdown Number (opcional) Iniciar uma contagem regressiva. [1-120]

Método sem retorno

Exemplo:

Requisição
{
  "action": "next_slide"
}

GetAutomaticPresentations

GetAPs

  • v2.21.0

Retorna a lista de apresentações automáticas

Resposta:

Nome Tipo Descrição
data Array<Object>
data.*.name String Nome do arquivo. Exemplo: arquivo.ap

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "name": "file 1.ap"
    },
    {
      "name": "file 2.ap"
    },
    {
      "name": "file 3.ap"
    }
  ]
}

GetAutomaticPresentation

GetAP

  • v2.21.0

Retorna uma apresentação automática

Parâmetros:

Nome Tipo Descrição
file String Nome do arquivo. Exemplo: arquivo.ap

Resposta:

Nome Tipo
data AutomaticPresentation

Exemplo:

Requisição
{
  "file": "filename.ap"
}

Resposta
{
  "status": "ok",
  "data": {
    "name": "filename.ap",
    "duration": 300000,
    "starts_with": "title",
    "song": {},
    "timeline": []
  }
}

PlayAutomaticPresentation

PlayAP

  • v2.19.0

Executa um item apresentação automática

Parâmetros:

Nome Tipo Descrição
file String Nome do arquivo. Exemplo: arquivo.ap
theme Object (opcional) Filtrar tema selecionado para exibição
theme.id String (opcional) ID do tema
theme.name String (opcional) Nome do tema
theme.edit Theme (opcional) Configurações para modificar o Tema selecionado para exibição v2.21.0+
custom_theme Theme (opcional) Tema personalizado utilizado para exibir a apresentação automática v2.21.0+

Método sem retorno

Exemplo:

Requisição
{
  "file": "filename"
}

GetAutomaticPresentationPlayerInfo

GetAPPlayerInfo

  • v2.20.0

Retorna as informações da apresentação automática em exibição

Resposta:

Nome Tipo Descrição
data.name String Nome do item
data.playing Boolean Verifica se o player está em execução
data.time_ms Number Tempo atual da mídia em milissegundos
data.volume Number Volume atual do player. Mínimo=0, Máximo=100
data.mute Boolean Verifica se a opção mudo está ativada
data.duration_ms Number Tempo total em milissegundos v2.21.0+

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "data": {
      "name": "example",
      "playing": true,
      "time_ms": 34552,
      "volume": 90,
      "mute": false
    }
  }
}

AutomaticPresentationPlayerAction

APPlayerAction

  • v2.20.0

Executa ações no player

Parâmetros:

Nome Tipo Descrição
action String (opcional) Nome da ação que será executada no player. play, pause, stop
volume Number (opcional) Altera o volume do player. Mínimo=0, Máximo=100
mute Boolean (opcional) Altera a opção mudo
time_ms Boolean (opcional) Alterar o tempo atual da mídia em milissegundos

Método sem retorno

Exemplo:

Requisição
{
  "action": "play",
  "volume": 80
}

GetMediaPlayerInfo

  • v2.19.0

Retorna as informações do player

Resposta:

Nome Tipo Descrição
data.name String Nome da mídia atual no player
data.path String Caminho completo da mídia no player
data.relative_path String Caminho relativo da mídia no player. Pode ser null. v2.24.0+
data.playing Boolean Verifica se o player está em execução
data.duration_ms Number Tempo total em milissegundos
data.time_ms Number Tempo atual da mídia em milissegundos
data.time_elapsed String Tempo decorrido no formato HH:MM:SS
data.time_remaining String Tempo restante no formato HH:MM:SS
data.volume Number Volume atual do player. Mínimo=0, Máximo=100
data.mute Boolean Verifica se a opção mudo está ativada
data.repeat Boolean Verifica se a opção repetir está ativada
data.execute_single Boolean Verifica se o player está definido para executar somente o item atual da lista
data.shuffle Boolean Verifica se a opção aleatório está ativada
data.fullscreen Boolean Verifica se a opção tela cheia está ativada

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "name": "video.mp4",
    "path": "C:\\Holyrics\\Holyrics\\files\\media\\video\\video.mp4",
    "relative_path": "video\\video.mp4",
    "playing": false,
    "duration_ms": 321456,
    "time_ms": -1,
    "time_elapsed": "00:00",
    "time_remaining": "00:00",
    "volume": 80,
    "mute": false,
    "repeat": true,
    "execute_single": true,
    "shuffle": false,
    "fullscreen": false
  }
}

MediaPlayerAction

  • v2.19.0

Executa ações no player

Parâmetros:

Nome Tipo Descrição
action String (opcional) Nome da ação que será executada no player. play, pause, stop, next, previous
volume Number (opcional) Altera o volume do player. Mínimo=0, Máximo=100
mute Boolean (opcional) Altera a opção mudo
repeat Boolean (opcional) Altera a opção repetir
shuffle Boolean (opcional) Altera a opção aleatório
execute_single Boolean (opcional) Altera a configuração do player para executar somente o item atual da lista
fullscreen Boolean (opcional) Altera a opção tela cheia do player
time_ms Boolean (opcional) Alterar o tempo atual da mídia em milissegundos v2.20.0+

Método sem retorno

Exemplo:

Requisição
{
  "action": "stop",
  "volume": 80,
  "mute": false,
  "repeat": false,
  "shuffle": false,
  "execute_single": false,
  "fullscreen": false
}

GetLyricsPlaylist

GetSongPlaylist

  • v2.19.0

Lista de reprodução de letras

Resposta:

Nome Tipo
data Array<Lyrics>

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "123",
      "title": "",
      "artist": "",
      "author": "",
      "note": "",
      "key": "",
      "bpm": 0,
      "time_sig": "",
      "groups": [],
      "archived": false
    },
    {
      "id": "456",
      "title": "",
      "artist": "",
      "author": "",
      "note": "",
      "key": "",
      "bpm": 0,
      "time_sig": "",
      "groups": [],
      "archived": false
    }
  ]
}

AddLyricsToPlaylist

AddSongsToPlaylist

  • v2.19.0

Adicionar letra de música na lista de reprodução

Parâmetros:

Nome Tipo Descrição
id String (opcional) ID da letra
ids Array<String> (opcional) Lista com id de cada letra
index Number (opcional) Posição na lista onde o item será adicionado (inicia em zero). Os itens são adicionados no final da lista por padrão. Padrão: -1
media_playlist Boolean (opcional) Adicionar as letras na lista de reprodução de mídia Padrão: false
event_id String (opcional) Para alterar a lista de reprodução de um culto ou evento específico.
Quando event_id não for declarado, a lista de reprodução atualmente selecionada na interface será editada.
Atenção, disponível somente a partir da versão 2.26.0, significa que em versões anteriores este método sempre vai alterar a lista de reprodução atualmente selecionada na interface, ignorando este parâmetro event_id Padrão: null v2.26.0+

Método sem retorno

Exemplo:

Requisição
{
  "id": "123",
  "ids": [
    123,
    456,
    789
  ],
  "index": 3,
  "media_playlist": false
}

RemoveFromLyricsPlaylist

RemoveFromSongPlaylist

  • v2.19.0

Remover letra de música na lista de reprodução

Parâmetros:

Nome Tipo Descrição
id String (opcional) ID da letra
ids Array<String> (opcional) Lista com id de cada letra
index Number (opcional) Posição do item na lista que será removido (inicia em zero).
indexes Array<Number> (opcional) Lista com a posição de cada item na lista que será removido. (Inicia em zero)
event_id String (opcional) Para alterar a lista de reprodução de um culto ou evento específico.
Quando event_id não for declarado, a lista de reprodução atualmente selecionada na interface será editada.
Atenção, disponível somente a partir da versão 2.26.0, significa que em versões anteriores este método sempre vai alterar a lista de reprodução atualmente selecionada na interface, ignorando este parâmetro event_id Padrão: null v2.26.0+

Método sem retorno

Exemplo:

Requisição
{
  "id": "123",
  "ids": [
    "123",
    "456",
    "789"
  ],
  "index": 3,
  "indexes": [
    3,
    4,
    5
  ]
}

SetLyricsPlaylistItem

SetSongPlaylistItem

  • v2.22.0

Alterar um item da lista de reprodução de letra de música

Parâmetros:

Nome Tipo Descrição
index Number Índice do item na lista
song_id String Novo item
event_id String (opcional) Para alterar a lista de reprodução de um culto ou evento específico.
Quando event_id não for declarado, a lista de reprodução atualmente selecionada na interface será editada.
Atenção, disponível somente a partir da versão 2.26.0, significa que em versões anteriores este método sempre vai alterar a lista de reprodução atualmente selecionada na interface, ignorando este parâmetro event_id Padrão: null v2.26.0+

Método sem retorno

Exemplo:

Requisição
{
  "index": 2,
  "song_id": "123"
}

GetMediaPlaylist

  • v2.19.0

Lista de reprodução de mídia

Resposta:

Nome Tipo
data Array<Item>

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "xyz",
      "type": "image",
      "name": "image.jpg"
    },
    {
      "id": "abc",
      "type": "video",
      "name": "video.mp4"
    }
  ]
}

SetMediaPlaylistItem

  • v2.22.0

Alterar um item da lista de reprodução de mídia

Parâmetros:

Nome Tipo Descrição
index Number Índice do item na lista
item AddItem Novo item
event_id String (opcional) Para alterar a lista de reprodução de um culto ou evento específico.
Quando event_id não for declarado, a lista de reprodução atualmente selecionada na interface será editada.
Atenção, disponível somente a partir da versão 2.26.0, significa que em versões anteriores este método sempre vai alterar a lista de reprodução atualmente selecionada na interface, ignorando este parâmetro event_id Padrão: null v2.26.0+

Método sem retorno

Exemplo:

Requisição
{
  "index": 0,
  "item": {
    "type": "song",
    "id": "123"
  }
}

MediaPlaylistAction

  • v2.19.0

Executa um item da lista de reprodução de mídia

Parâmetros:

Nome Tipo Descrição
id String ID do item

Método sem retorno

Exemplo:

Requisição
{
  "id": "abc"
}

GetNextSongPlaylist

  • v2.22.0

Retorna a próxima música da lista de reprodução. Pode ser null

Resposta:

Nome Tipo
data Lyrics

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "id": "123",
    "title": "",
    "artist": "",
    "author": "",
    "note": "",
    "key": "",
    "bpm": 0,
    "time_sig": "",
    "groups": [],
    "archived": false
  }
}

GetNextMediaPlaylist

  • v2.22.0

Retorna o próximo item executável da lista de reprodução de mídia. Pode ser null

Resposta:

Nome Tipo
data Item

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "id": "abc123",
    "type": "song",
    "name": ""
  }
}

ShowNextSongPlaylist

  • v2.22.0

Executa a próxima música da lista de reprodução

Método sem retorno

ShowNextMediaPlaylist

  • v2.22.0

Executa o próximo item da lista de reprodução de mídia

Método sem retorno

GetPreviousSongPlaylist

  • v2.22.0

Retorna a música anterior da lista de reprodução. Pode ser null

Resposta:

Nome Tipo
data Lyrics

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "id": "123",
    "title": "",
    "artist": "",
    "author": "",
    "note": "",
    "key": "",
    "bpm": 0,
    "time_sig": "",
    "groups": [],
    "archived": false
  }
}

GetPreviousMediaPlaylist

  • v2.22.0

Retorna o item anterior executável da lista de reprodução de mídia. Pode ser null

Resposta:

Nome Tipo
data Item

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "id": "abc123",
    "type": "song",
    "name": ""
  }
}

ShowPreviousSongPlaylist

  • v2.22.0

Executa a música anterior da lista de reprodução

Método sem retorno

ShowPreviousMediaPlaylist

  • v2.22.0

Executa o item anterior da lista de reprodução de mídia

Método sem retorno

AddToPlaylist

  • v2.20.0

Adicionar itens à lista de reprodução de mídias

Parâmetros:

Nome Tipo Descrição
items Array<AddItem> Lista com os itens que serão adicionados
index Number (opcional) Posição na lista onde o item será adicionado (inicia em zero). Os itens são adicionados no final da lista por padrão. Padrão: -1
ignore_duplicates Boolean (opcional) Não duplicar itens ao adicionar novos itens, ou seja, não adiciona um item se ele já estiver na lista. Padrão: false
event_id String (opcional) Para alterar a lista de reprodução de um culto ou evento específico.
Quando event_id não for declarado, a lista de reprodução atualmente selecionada na interface será editada.
Atenção, disponível somente a partir da versão 2.26.0, significa que em versões anteriores este método sempre vai alterar a lista de reprodução atualmente selecionada na interface, ignorando este parâmetro event_id Padrão: null v2.26.0+

Método sem retorno

Exemplo:

Requisição
{
  "items": [
    {
      "type": "title",
      "name": "Título",
      "background_color": "000080"
    },
    {
      "type": "song",
      "id": 12345678
    },
    {
      "type": "verse",
      "id": "19023001"
    },
    {
      "type": "verse",
      "ids": [
        "19023001",
        "43003016"
      ]
    },
    {
      "type": "verse",
      "references": "Sl 23.1 Rm 12:2"
    },
    {
      "type": "text",
      "id": "abcxyz"
    },
    {
      "type": "audio",
      "name": "example.mp3"
    },
    {
      "type": "video",
      "name": "example.mp4"
    },
    {
      "type": "image",
      "name": "example.jpg"
    },
    {
      "type": "automatic_presentation",
      "name": "example.ap"
    },
    {
      "type": "title",
      "name": "Título 2"
    },
    {
      "type": "announcement",
      "id": 12345678
    },
    {
      "type": "announcement",
      "ids": [
        123,
        456
      ]
    },
    {
      "type": "announcement",
      "name": "example"
    },
    {
      "type": "announcement",
      "names": [
        "example 2",
        "example 3"
      ]
    },
    {
      "type": "announcement",
      "id": "all",
      "automatic": {
        "seconds": 8,
        "repeat": false
      }
    },
    {
      "type": "title",
      "name": "Título 3"
    },
    {
      "type": "countdown",
      "time": "03:15"
    },
    {
      "type": "countdown_cp",
      "minutes": 15,
      "stop_at_zero": true
    },
    {
      "type": "cp_text",
      "text": "example"
    },
    {
      "type": "script",
      "id": "abcxyz"
    },
    {
      "type": "api",
      "id": "abcxyz"
    }
  ]
}

RemoveFromMediaPlaylist

  • v2.19.0

Remover itens da lista de reprodução de mídia

Parâmetros:

Nome Tipo Descrição
id String (opcional) ID do item
ids Array<String> (opcional) Lista com id de cada item
index Number (opcional) Posição do item na lista que será removido (inicia em zero).
indexes Array<Number> (opcional) Lista com a posição de cada item na lista que será removido. (Inicia em zero)
event_id String (opcional) Para alterar a lista de reprodução de um culto ou evento específico.
Quando event_id não for declarado, a lista de reprodução atualmente selecionada na interface será editada.
Atenção, disponível somente a partir da versão 2.26.0, significa que em versões anteriores este método sempre vai alterar a lista de reprodução atualmente selecionada na interface, ignorando este parâmetro event_id Padrão: null v2.26.0+

Método sem retorno

Exemplo:

Requisição
{
  "id": "abc",
  "ids": [
    "abc",
    "xyz"
  ],
  "index": 3,
  "indexes": [
    2,
    3
  ]
}

SetPlaylistItemDuration

  • v2.21.0

Alterar duração de um item da lista de reprodução de mídia.

Parâmetros:

Nome Tipo Descrição
id String (opcional) ID do item
index Number (opcional) Posição do item na lista (inicia em zero).
duration Number (opcional) Duração do item (em segundos)

Método sem retorno

Exemplo:

Requisição
{
  "id": "xyz",
  "duration": 300
}

GetSlideDescriptions

  • v2.21.0

Lista das descrições do slide disponíveis

Resposta:

Nome Tipo
data Array<SlideDescription>

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "name": "Chorus",
      "tag": "C",
      "aliases": [],
      "font_color": "FFFFFF",
      "bg_color": "000080",
      "background": null
    },
    {
      "...": "..."
    },
    {
      "...": "..."
    }
  ]
}

GetFavorites

  • v2.19.0

Itens da barra de favoritos

Resposta:

Nome Tipo
data Array<FavoriteItem>

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "1",
      "name": "abc"
    },
    {
      "id": "2",
      "name": "xyz"
    },
    {
      "id": "3",
      "name": "123"
    }
  ]
}

FavoriteAction

  • v2.19.0

Executa um item da barra de favoritos

Parâmetros:

Nome Tipo Descrição
id String ID do item

Método sem retorno

Exemplo:

Requisição
{
  "id": "abcxyz"
}

GetApis

  • v2.21.0

Retorna a lista de APIs

Resposta:

Nome Tipo Descrição
data Array<Object>
data.*.id String ID do item
data.*.name String Nome do item

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "xyz1",
      "name": "abc1"
    },
    {
      "id": "xyz2",
      "name": "abc2"
    }
  ]
}

GetScripts

  • v2.21.0

Retorna a lista de scripts

Resposta:

Nome Tipo Descrição
data Array<Object>
data.*.id String ID do item
data.*.name String Nome do item

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "xyz1",
      "name": "abc1"
    },
    {
      "id": "xyz2",
      "name": "abc2"
    }
  ]
}

ApiAction

  • v2.19.0

Executa a ação de um item API existente no programa

Parâmetros:

Nome Tipo Descrição
id String ID do item

Método sem retorno

Exemplo:

Requisição
{
  "id": "abcxyz"
}

ScriptAction

  • v2.19.0

Executa a ação de um item Script existente no programa

Parâmetros:

Nome Tipo Descrição
id String ID do item

Método sem retorno

Exemplo:

Requisição
{
  "id": "abc"
}

ApiRequest

  • v2.19.0

Executa uma requisição para o receptor associado e retorna a resposta do receptor.
A partir da v2.23.0 é possível passar o host ou ip diretamente, porém é necessário adicionar o host/ip na lista de requisições permitidas.
menu arquivo > configurações > avançado > javascript > configurações > requisições permitidas

Parâmetros:

Nome Tipo Descrição
id String id do receptor
raw Object dados da requisição

Resposta:

Tipo Descrição
Object Retorno da requisição ou NULL para erro/timeout

Exemplo:

Requisição
{
  "id": "abcxyz",
  "raw": {
    "request-type": "GetSourceActive",
    "sourceName": "example"
  }
}

Resposta
{
  "status": "ok",
  "data": {
    "sourceActive": "example"
  }
}

ModuleAction

  • v2.26.0

Executar uma ação pública de um módulo

Parâmetros:

Nome Tipo Descrição
module_id String id do módulo
action_id String id da ação
action_type String (opcional) Valores aceitos: call open
call: Executa a ação
open: Abre uma janela popup para o usuário inserir/editar os parâmetros e executar a ação Padrão: call
async Boolean (opcional) Executar a ação de forma assíncrona, ou seja, sem retornar a resposta da ação. Disponível se action_type=call Padrão: false
timeout Number (opcional) 100 ~ 4000 Tempo limite para execução da ação. Disponível se action_type=call Padrão: 500
notification Boolean (opcional) Exibir uma notificação em vez de exibir o popup diretamente na tela para o usuário. Disponível se action_type=open Padrão: false
input Object (opcional) Mapa chave/valor com os parâmetros para execução da ação, onde cada chave é o respectivo id do input declarado na ação do módulo

Resposta:

Tipo Descrição
Object Resposta da ação. Disponível se action_type=call && async=false

Exemplo:

Requisição
{
  "module_id": "",
  "action_id": "",
  "action_type": "",
  "async": false,
  "timeout": 0,
  "notification": false,
  "input": {
    "a": "abc",
    "b": "xyz"
  }
}

Resposta
{
  "status": "ok",
  "data": {}
}

GetCurrentPresentation

  • v2.19.0

Item sendo apresentado no momento ou null se não tiver apresentação sendo exibida

Parâmetros:

Nome Tipo Descrição
include_slides Boolean (opcional) Retornar a lista de slides da apresentação atual. Indisponível para apresentação de versículos. Padrão: false v2.21.0+
include_slide_comment Boolean (opcional) Incluir comentários (se houver) no texto dos slides. Disponível se include_slides=true. Padrão: false v2.21.0+
include_slide_preview Boolean (opcional) Incluir imagem preview do slide. Disponível se include_slides=true. Padrão: false v2.21.0+
slide_preview_size String (opcional) Tamanho do preview no formato WxH (ex. 320x180). (max 640x360)
Disponível se include_slide_preview=true Padrão: false v2.21.0+

Resposta:

Nome Tipo Descrição
data.id String ID do item
data.type String Tipo do item. Pode ser: song verse text audio image announcement automatic_presentation quick_presentation
data.name String Nome do item
data.slide_number Number Começa em 1 v2.20.0+
data.total_slides Number Total de slides v2.20.0+
data.slide_type String Um dos seguintes valores: default wallpaper blank black final_slide v2.20.0+
data.slides Array<PresentationSlideInfo> Lista com os slides da apresentação atual. Disponível se include_slides=true v2.21.0+

Exemplo:

Requisição
{}

Resposta
{
  "status": "ok",
  "data": {
    "id": "abc123",
    "type": "song",
    "name": "",
    "song_id": "123"
  }
}

CloseCurrentPresentation

  • v2.19.0

Encerra a apresentação atual

Método sem retorno

GetF8

GetF9

GetF10

  • v2.19.0

Retorna o estado atual da respectiva opção F8 (papel de parede), F9 (tela vazia) ou F10 (tela preta)

Resposta:

Tipo Descrição
Boolean true ou false

Exemplo:

Resposta
{
  "status": "ok",
  "data": false
}

SetF8

SetF9

SetF10

  • v2.19.0

Altera o estado atual da respectiva opção F8 (papel de parede), F9 (tela vazia) ou F10 (tela preta)

Parâmetros:

Nome Tipo Descrição
enable Boolean true ou false

Método sem retorno

Exemplo:

Requisição
{
  "enable": true
}

ToggleF8

ToggleF9

ToggleF10

  • v2.19.0

Troca o estado atual da respectiva opção F8 (papel de parede), F9 (tela vazia) ou F10 (tela preta)

Método sem retorno

ActionNext

  • v2.19.0

Executa um comando de avançar na apresentação atual

Método sem retorno

ActionPrevious

  • v2.19.0

Executa um comando de voltar na apresentação atual

Método sem retorno

ActionGoToIndex

  • v2.19.0

Altera o slide em exibição a partir do índice do slide

Parâmetros:

Nome Tipo Descrição
index Number Índice do slide na apresentação (começa em zero)

Método sem retorno

Exemplo:

Requisição
{
  "index": 3
}

ActionGoToSlideDescription

  • v2.19.0

Altera o slide em exibição a partir do nome da descrição do slide

Parâmetros:

Nome Tipo Descrição
name String Nome da descrição do slide

Método sem retorno

Exemplo:

Requisição
{
  "name": "Verse 1"
}

GetCurrentBackground

  • v2.19.0

Retorna o plano de fundo da apresentação em exibição.

Resposta:

Nome Tipo Descrição
data Background Plano de fundo atual ou NULL se não houver apresentação em exibição

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "id": "abc",
    "type": "my_video",
    "name": "Video Name",
    "tags": [
      "circle",
      "blue"
    ],
    "bpm": 80,
    "midi": {
      "code": 85,
      "velocity": 81
    }
  }
}

GetCurrentTheme

  • v2.22.0

Retorna o tema da apresentação em exibição.

Resposta:

Nome Tipo Descrição
data Background Tema atual ou NULL se não houver apresentação em exibição

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "id": "123",
    "type": "theme",
    "name": "Theme Name",
    "tags": [
      "circle",
      "blue"
    ],
    "bpm": 80
  }
}

GetBackgrounds

  • v2.19.0

Lista dos temas e planos de fundo

Parâmetros:

Nome Tipo Descrição
input Object (opcional) Filtro
type String (opcional) Pode ser: theme my_video my_image video image
tag String (opcional)
tags Array<String> (opcional)
intersection Boolean (opcional) Se o campo tags estiver preenchido com múltiplos itens, a opção intersection define o tipo de junção. Se true, o filtro retornará apenas itens que contém todas as tags informadas, se false, o filtro retornará os itens que têm pelo menos uma tag das tags informadas Padrão: false

Resposta:

Nome Tipo
data Array<Background>

Exemplo:

Requisição
{
  "type": "my_video",
  "tag": "circle",
  "tags": [],
  "intersection": true
}

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "xyz",
      "type": "theme",
      "name": "Theme Name",
      "tags": [
        "circle",
        "blue"
      ],
      "midi": {
        "code": 85,
        "velocity": 80
      }
    },
    {
      "id": "abc",
      "type": "my_video",
      "name": "Video Name",
      "tags": [
        "circle",
        "blue"
      ],
      "bpm": 80,
      "midi": {
        "code": 85,
        "velocity": 81
      }
    }
  ]
}

GetBackgroundTags

  • v2.26.0

Lista das Tags criadas para organização de Temas e Backgrounds

Parâmetros:

Nome Tipo Descrição
input Object (opcional) Filtro
type String (opcional) Pode ser: theme my_video my_image video image

Resposta:

Nome Tipo Descrição
data Array<String> Lista com o nome das Tags

Exemplo:

Requisição
{
  "type": "my_video"
}

SetCurrentBackground

  • v2.19.0

Altera o plano de fundo (ou tema) da apresentação atual. Se mais de um item for encontrado de acordo com os filtros, será escolhido um item da lista de forma aleatória

Parâmetros:

Nome Tipo Descrição
input Object (opcional) Filtro
id String (opcional) ID do tema ou plano de fundo
name String (opcional) Nome do tema ou plano de fundo
type String (opcional) Pode ser: theme my_video my_image video image
tag String (opcional)
tags Array<String> (opcional)
intersection Boolean (opcional) Se o campo tags estiver preenchido com múltiplos itens, a opção intersection define o tipo de junção. Se true, o filtro retornará apenas itens que contém todas as tags informadas, se false, o filtro retornará os itens que têm pelo menos uma tag das tags informadas Padrão: false
edit Theme (opcional) Configurações para modificar o Tema selecionado para exibição v2.21.0+
custom_theme Theme (opcional) Tema personalizado v2.21.0+

Método sem retorno

Exemplo:

Requisição
{
  "id": "123",
  "name": "",
  "type": "my_video",
  "tag": "blue",
  "tags": [],
  "intersection": false
}

GetThumbnail

  • v2.21.0

Retorna a imagem miniatura de um item no programa

Parâmetros:

Nome Tipo Descrição
id String (opcional) ID do item
ids Array<String> (opcional) ID dos itens
type String Tipo do item. Pode ser: video image announcement theme background api script

Resposta:

Nome Tipo Descrição
data Array<Object>
data.*.type String Tipo do item
data.*.id String ID do item
data.*.image String Imagem no formato base64

Exemplo:

Requisição
{
  "id": "image.jpg",
  "type": "image"
}

Resposta
{
  "status": "ok",
  "data": [
    {
      "type": "image",
      "id": "image.jpg",
      "image": "..."
    }
  ]
}

GetColorMap

  • v2.20.0

Retorna as informações de cor predominante de um respectivo tipo de item.
O array retornado contém 8 índices, e cada índice corresponde ao trecho conforme imagem de exemplo a seguir.

Color Map Example

Parâmetros:

Nome Tipo Descrição
type String Um dos seguintes valores:
background - um item de tema ou plano de fundo
presentation - apresentação atual em exibição
image - uma imagem da aba 'imagens'
video - um vídeo da aba 'vídeos'
printscreen - um printscreen atual de uma tela do sistema
source Object (opcional) O item de acordo com o tipo informado:
background - ID do tema ou plano de fundo
presentation - não é necessário informar um valor, a apresentação da tela público será retornada
image - o nome do arquivo da aba 'imagens'
video - o nome do arquivo da aba 'vídeos'
printscreen opcional - o nome da tela (public, screen_2, screen_3, ...); o padrão é public

Resposta:

Nome Tipo Descrição
data Array<Object>
data.*.hex String Cor no formato hexadecimal
data.*.red Number Vermelho 0 ~ 255
data.*.green Number Verde 0 ~ 255
data.*.blue Number Azul 0 ~ 255

Exemplo:

Requisição
{
  "type": "background",
  "source": 12345678
}

Resposta
{
  "status": "ok",
  "data": [
    {
      "hex": "0000FF",
      "red": 0,
      "green": 0,
      "blue": 255
    },
    {
      "...": "..."
    },
    {
      "...": "..."
    },
    {
      "...": "..."
    }
  ]
}

GetAlert

  • v2.20.0

Retorna as configurações da mensagem de alerta

Resposta:

Nome Tipo Descrição
data.text String Texto atual do alerta
data.show Boolean Se a exibição do alerta está ativada

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "text": "Example",
    "show": false
  }
}

SetAlert

  • v2.19.0

Altera as configurações da mensagem de alerta

Parâmetros:

Nome Tipo Descrição
text String (opcional) Alterar o texto de alerta
show Boolean (opcional) Exibir/ocultar o alerta

Método sem retorno

Exemplo:

Requisição
{
  "text": "",
  "show": false
}

GetCurrentSchedule

  • v2.19.0

Programação atual (selecionada na janela principal do programa)

Parâmetros:

Nome Tipo Descrição
include_lyrics_slides Boolean (opcional) v2.24.0+
include_lyrics_history Boolean (opcional) v2.24.0+

Resposta:

Nome Tipo
data Array<Schedule>

Exemplo:

Requisição
{}

Resposta
{
  "status": "ok",
  "data": {
    "type": "event",
    "name": "",
    "datetime": "2016-05-10 12:00",
    "lyrics_playlist": [
      {
        "id": "123",
        "title": "",
        "artist": "",
        "author": "",
        "note": "",
        "key": "",
        "bpm": 0,
        "time_sig": "",
        "groups": [
          {
            "name": "Group 1"
          },
          {
            "name": "Group 2"
          }
        ],
        "archived": false
      }
    ],
    "media_playlist": [
      {
        "id": "xyz",
        "type": "image",
        "name": "image.jpg"
      },
      {
        "id": "abc",
        "type": "video",
        "name": "video.mp4"
      }
    ],
    "responsible": null,
    "members": [],
    "roles": [],
    "notes": ""
  }
}

GetSchedules

  • v2.19.0

Retorna a lista de programação de um mês específico

Parâmetros:

Nome Tipo Descrição
month Number Mês (1-12)
year Number Ano

Resposta:

Nome Tipo
data Array<Schedule>

Exemplo:

Requisição
{
  "month": 3,
  "year": 2022
}

Resposta
{
  "status": "ok",
  "data": [
    {
      "type": "service",
      "name": "",
      "datetime": "2022-03-06 19:00",
      "lyrics_playlist": [],
      "media_playlist": [],
      "responsible": null,
      "members": [],
      "roles": [],
      "notes": ""
    },
    {
      "type": "event",
      "name": "",
      "datetime": "2022-03-12 20:00",
      "lyrics_playlist": [],
      "media_playlist": [],
      "responsible": null,
      "members": [],
      "roles": [],
      "notes": ""
    },
    {
      "type": "service",
      "name": "",
      "datetime": "2022-03-13 19:00",
      "lyrics_playlist": [],
      "media_playlist": [],
      "responsible": null,
      "members": [],
      "roles": [],
      "notes": ""
    },
    {
      "type": "service",
      "name": "",
      "datetime": "2022-03-20 19:00",
      "lyrics_playlist": [],
      "media_playlist": [],
      "responsible": null,
      "members": [],
      "roles": [],
      "notes": ""
    },
    {
      "type": "service",
      "name": "",
      "datetime": "2022-03-27 19:00",
      "lyrics_playlist": [],
      "media_playlist": [],
      "responsible": null,
      "members": [],
      "roles": [],
      "notes": ""
    }
  ]
}

GetSavedPlaylists

  • v2.19.0

Retorna as listas de reprodução salvas

Resposta:

Nome Tipo Descrição
data Array<Object>
data.*.id String ID do item
data.*.name String Nome do item
data.*.items Array<Item> Itens salvos na lista

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "xyzabc",
      "name": "",
      "items": [
        {
          "id": "xyz",
          "type": "image",
          "name": "image.jpg"
        },
        {
          "id": "abc",
          "type": "video",
          "name": "video.mp4"
        }
      ]
    },
    {
      "id": "abcdef",
      "name": "",
      "items": [
        {
          "id": "abc",
          "type": "audio",
          "name": "audio.mp3"
        },
        {
          "id": "xyz",
          "type": "song",
          "name": "",
          "song_id": "123"
        }
      ]
    }
  ]
}

LoadSavedPlaylist

  • v2.19.0

Preenche a lista de mídias da lista de reprodução selecionada atualmente no programa com a lista informada

Parâmetros:

Nome Tipo Descrição
name String Nome da lista de reprodução salva
merge Boolean Adiciona os itens no final da lista em vez de substituir Padrão: false v2.24.0+

Método sem retorno

Exemplo:

Requisição
{
  "name": ""
}

GetHistory

  • v2.19.0

Histórico de "Música tocada"

Parâmetros:

Nome Tipo Descrição
id String ID da letra da música
in_millis Boolean (opcional) true para retornar o valor em Timestamp v2.24.0+

Resposta:

Nome Tipo Descrição
data Array<String> Data e hora no formato: YYYY-MM-DD HH:MM

Exemplo:

Requisição
{
  "id": "123"
}

Resposta
{
  "status": "ok",
  "data": [
    "2022-04-03 19:32",
    "2022-07-10 20:10",
    "2023-01-01 19:15"
  ]
}

GetHistories

  • v2.19.0

Histórico de todas as marcações de "Música tocada"

Parâmetros:

Nome Tipo Descrição
in_millis Boolean (opcional) true para retornar o valor em Timestamp v2.24.0+

Resposta:

Nome Tipo Descrição
data Array<Object>
data.*.music_id String ID da música
data.*.history Array<String> Data e hora no formato: YYYY-MM-DD HH:MM

Exemplo:

Requisição
{}

Resposta
{
  "status": "ok",
  "data": [
    {
      "music_id": "123",
      "history": [
        "2022-04-03 19:32",
        "2022-07-10 20:10",
        "2023-01-01 19:15"
      ]
    },
    {
      "music_id": "456",
      "history": [
        "2022-05-05 19:20",
        "2022-08-08 20:30",
        "2023-01-10 20:02"
      ]
    }
  ]
}

GetNearestHistory

  • v2.24.0

Obtém a data do histórico de "Música tocada" mais próxima de uma data e hora passada por parâmetro (ou da data e hora atual do sistema)

Parâmetros:

Nome Tipo Descrição
id String ID da letra da música
datetime String (opcional) Formatos aceitos: timestamp YYYY-MM-DD YYYY/MM/DD YYYY-MM-DD HH:MM:SS YYYY/MM/DD HH:MM:SS DD-MM-YYYY DD/MM/YYYY DD-MM-YYYY HH:MM:SS DD/MM/YYYY HH:MM:SS Padrão: Date.now()
type String (opcional) Filtro de busca. Pode ser:
any qualquer valor mais próximo da data especificada
before_datetime valor mais próximo que seja anterior ou igual à data especificada (value <= datetime)
after_datetime valor mais próximo que seja igual ou posterior à data especificada (value >= datetime) Padrão: any

Resposta:

Nome Tipo Descrição
data Object Pode ser null
data.datetime String Data e hora no formato: YYYY-MM-DD HH:MM
data.datetime_millis Number Timestamp

Exemplo:

Requisição
{
  "id": "123",
  "datetime": "2024-12-16",
  "type": "after_datetime"
}

Resposta
{
  "status": "ok",
  "data": {
    "datetime": "2024-12-16 19:30:00",
    "datetime_millis": 1734388200000
  }
}

GetSongGroup

  • v2.25.0

Grupo de música

Parâmetros:

Nome Tipo Descrição
name String

Resposta:

Nome Tipo
data Group

Exemplo:

Requisição
{
  "name": "Example"
}

Resposta
{
  "status": "ok",
  "data": {
    "id": "example",
    "name": "example",
    "songs": [
      "123",
      "456"
    ],
    "add_chorus_between_verses": false,
    "hide_in_interface": false,
    "metadata": {
      "modified_time_millis": 1234
    }
  }
}

GetSongGroups

  • v2.24.0

Lista de grupos de música

Resposta:

Nome Tipo
data Array<Group>

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "example 1",
      "name": "example 1",
      "songs": [
        "123",
        "456"
      ],
      "add_chorus_between_verses": false,
      "hide_in_interface": false,
      "metadata": {
        "modified_time_millis": 1234
      }
    },
    {
      "id": "example 2",
      "name": "example 2",
      "songs": [
        "123",
        "456"
      ],
      "add_chorus_between_verses": false,
      "hide_in_interface": false,
      "metadata": {
        "modified_time_millis": 1234
      }
    }
  ]
}

GetTeams

  • v2.22.0

Lista de times

Resposta:

Nome Tipo
data Array<Team>

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "abc",
      "name": "abc",
      "description": ""
    },
    {
      "id": "xyz",
      "name": "xyz",
      "description": ""
    }
  ]
}

GetMembers

  • v2.19.0

Lista de integrantes

Parâmetros:

Nome Tipo Descrição
only_active Boolean Padrão: true v2.25.0+

Resposta:

Nome Tipo
data Array<Member>

Exemplo:

Requisição
{
  "only_active": true
}

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "abc",
      "name": ""
    },
    {
      "id": "xyz",
      "name": ""
    }
  ]
}

GetRoles

  • v2.19.0

Lista de funções

Parâmetros:

Nome Tipo Descrição
only_active Boolean Padrão: true v2.25.0+

Resposta:

Nome Tipo
data Array<Role>

Exemplo:

Requisição
{
  "only_active": true
}

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "abc",
      "name": ""
    },
    {
      "id": "xyz",
      "name": ""
    }
  ]
}

GetServices

  • v2.22.0

Lista de cultos

Parâmetros:

Nome Tipo Descrição
only_active Boolean Padrão: true v2.25.0+

Resposta:

Nome Tipo
data Array<Service>

Exemplo:

Requisição
{
  "only_active": true
}

Resposta
{
  "status": "ok",
  "data": [
    {
      "name": "",
      "week": "all",
      "day": "sun",
      "hour": 19,
      "minute": 0,
      "description": "",
      "hide_week": [
        "second"
      ]
    },
    {
      "name": "Supper Worship",
      "week": "second",
      "day": "sun",
      "hour": 19,
      "minute": 0,
      "description": ""
    }
  ]
}

GetEvents

  • v2.22.0

Lista de eventos

Parâmetros:

Nome Tipo Descrição
month Number Mês (1-12)
year Number Ano

Resposta:

Nome Tipo
data Array<Event>

Exemplo:

Requisição
{
  "month": 8,
  "year": 2022
}

Resposta
{
  "status": "ok",
  "data": [
    {
      "name": "Event name",
      "datetime": "2022-08-19 18:00",
      "wallpaper": ""
    },
    {
      "name": "Event name",
      "datetime": "2022-08-20 18:00",
      "wallpaper": ""
    }
  ]
}

GetAnnouncement

  • v2.22.0

Anúncio

Parâmetros:

Nome Tipo Descrição
id String (opcional) ID do anúncio
name String (opcional) Nome do anúncio

Resposta:

Nome Tipo
data Announcement

Exemplo:

Requisição
{
  "id": "123"
}

Resposta
{
  "status": "ok",
  "data": {
    "id": "abc",
    "name": "",
    "text": "",
    "archived": false
  }
}

GetAnnouncements

  • v2.22.0

Lista de anúncios

Resposta:

Nome Tipo
data Array<Announcement>

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "abc",
      "name": "",
      "text": "",
      "archived": false
    },
    {
      "id": "xyz",
      "name": "",
      "text": "",
      "archived": false
    }
  ]
}

GetModules

  • v2.26.0

Lista de módulos

Parâmetros:

Nome Tipo Descrição
input Object (opcional) Filtro
id String (opcional)
name String (opcional)
jscommunity_id String (opcional)
info_id String (opcional)
active Boolean (opcional)
enabled_by_user Boolean (opcional)
conditional_execution Boolean (opcional)

Resposta:

Nome Tipo
data Array<Module>

Exemplo:

Requisição
{}

Resposta
{
  "status": "ok",
  "data": {
    "id": "abc",
    "jscommunity_id": "xyz",
    "info_id": "xyz",
    "name": "Example",
    "active": false,
    "enabled_by_user": false,
    "conditional_execution": false,
    "show_panel": true,
    "available_in_main_window": true,
    "available_in_bible_window": true,
    "actions": {}
  }
}

GetCommunicationPanelInfo

GetCPInfo

GetCPSettings

  • v2.19.0

Configuração atual do painel de comunicação

Resposta:

Nome Tipo Descrição
data.text String Texto atual
data.show Boolean Se o texto atual está em exibição
data.display_ahead Boolean Se a opção 'exibir à frente de tudo' está ativada
data.alert_text String Texto atual do alerta
data.alert_show Boolean Se a exibição do alerta está ativada
data.countdown_show Boolean Se uma contagem regressiva está em exibição
data.countdown_time Number O tempo atual da contagem regressiva em exibição (em segundos)
data.stopwatch_show Boolean Se um cronômetro está em exibição v2.20.0+
data.stopwatch_time Number O tempo atual do cronômetro em exibição (em segundos) v2.20.0+
data.theme String ID do tema v2.20.0+
data.countdown_font_relative_size Number Tamanho relativo da contagem regressiva v2.20.0+
data.countdown_font_color String Cor da fonte da contagem regressiva v2.20.0+
data.stopwatch_font_color String Cor da fonte do cronômetro v2.20.0+
data.time_font_color String Cor da fonte da hora v2.20.0+
data.display_clock_as_background Boolean Exibir relógio como plano de fundo v2.20.0+
data.display_clock_on_alert Boolean Exibir relógio no alerta v2.20.0+
data.countdown_display_location String Local de exibição da contagem regressiva ou cronômetro. FULLSCREEN FULLSCREEN_OR_ALERT ALERT v2.20.0+
data.display_clock_with_countdown_fullscreen Boolean Exibir relógio junto da contagem regressiva ou cronômetro quando exibido em tela cheia v2.20.0+
data.display_vlc_player_remaining_time Boolean Exibir tempo restante da mídia em execução no VLC Player v2.20.0+
data.attention_icon_color String Cor do ícone do botão Atenção v2.23.0+
data.attention_background_color String Cor do fundo do ícone do botão Atenção v2.23.0+
data.countdown_hide_zero_minute Boolean Ocultar a exibição dos minutos quando for zero v2.25.0+
data.countdown_hide_zero_hour Boolean Ocultar a exibição das horas quando for zero v2.25.0+
data.stopwatch_hide_zero_minute Boolean Ocultar a exibição dos minutos quando for zero v2.25.0+
data.stopwatch_hide_zero_hour Boolean Ocultar a exibição das horas quando for zero v2.25.0+

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "text": "",
    "show": false,
    "display_ahead": false,
    "alert_text": "",
    "alert_show": false,
    "countdown_show": false,
    "countdown_time": 0
  }
}

SetCommunicationPanelSettings

SetCPSettings

  • v2.20.0

Alterar configuração atual do painel de comunicação.

Parâmetros:

Nome Tipo Descrição
text String Texto atual
show Boolean Exibir o texto atual
display_ahead Boolean Opção 'exibir à frente de tudo'
theme Object ID ou nome do tema padrão
theme.id String
theme.name String
custom_theme Theme (opcional) Tema personalizado v2.21.0+
alert_text String Texto atual do alerta
alert_show Boolean Ativar a exibição do alerta
countdown_font_relative_size Number Tamanho relativo da contagem regressiva
countdown_font_color String Cor da fonte da contagem regressiva
stopwatch_font_color String Cor da fonte do cronômetro
time_font_color String Cor da fonte da hora
display_clock_as_background Boolean Exibir relógio como plano de fundo
display_clock_on_alert Boolean Exibir relógio no alerta
countdown_display_location String Local de exibição da contagem regressiva ou cronômetro. FULLSCREEN FULLSCREEN_OR_ALERT ALERT
display_clock_with_countdown_fullscreen Boolean Exibir relógio junto da contagem regressiva ou cronômetro quando exibido em tela cheia
display_vlc_player_remaining_time Boolean Exibir tempo restante da mídia em execução no VLC Player
attention_icon_color String Cor do ícone do botão Atenção v2.23.0+
attention_background_color String Cor do fundo do ícone do botão Atenção v2.23.0+
countdown_hide_zero_minute Boolean Ocultar a exibição dos minutos quando for zero v2.25.0+
countdown_hide_zero_hour Boolean Ocultar a exibição das horas quando for zero v2.25.0+
stopwatch_hide_zero_minute Boolean Ocultar a exibição dos minutos quando for zero v2.25.0+
stopwatch_hide_zero_hour Boolean Ocultar a exibição das horas quando for zero v2.25.0+

Método sem retorno

Exemplo:

Requisição
{
  "display_clock_as_background": false,
  "display_clock_on_alert": true
}

StartCountdownCommunicationPanel

StartCountdownCP

  • v2.19.0

Inicia uma contagem regressiva no painel de comunicação

Parâmetros:

Nome Tipo Descrição
minutes Number Quantidade de minutos
seconds Number Quantidade de segundos
yellow_starts_at Number (opcional) Valor em segundos para definir a partir de quanto tempo a contagem regressiva ficará amarela
stop_at_zero Boolean (opcional) Parar a contagem regressiva ao chegar em zero Padrão: false
text String (opcional) Texto para exibição. Por padrão, o texto é exibido antes da parte numérica. Para formatação especial, utilize a variável @cp_countdown no meio do texto para indicar o local de exibição da parte numérica. v2.24.0+
alert_text String (opcional) Texto alternativo para ser exibido quando a exibição for no alerta. Por padrão, o texto é exibido antes da parte numérica. Para formatação especial, utilize a variável @cp_countdown no meio do texto para indicar o local de exibição da parte numérica. v2.24.0+

Método sem retorno

Exemplo:

Requisição
{
  "minutes": 5,
  "seconds": 0,
  "yellow_starts_at": 60,
  "stop_at_zero": false
}

StopCountdownCommunicationPanel

StopCountdownCP

  • v2.19.0

Encerra a contagem regressiva atual do painel de comunicação

Método sem retorno

StartTimerCommunicationPanel

StartTimerCP

  • v2.20.0

Inicia um cronômetro no painel de comunicação

Parâmetros:

Nome Tipo Descrição
text String (opcional) Texto para exibição. Por padrão, o texto é exibido antes da parte numérica. Para formatação especial, utilize a variável @cp_countdown no meio do texto para indicar o local de exibição da parte numérica. v2.24.0+
alert_text String (opcional) Texto alternativo para ser exibido quando a exibição for no alerta. Por padrão, o texto é exibido antes da parte numérica. Para formatação especial, utilize a variável @cp_countdown no meio do texto para indicar o local de exibição da parte numérica. v2.24.0+

Método sem retorno

Exemplo:

Requisição
{}

StopTimerCommunicationPanel

StopTimerCP

  • v2.20.0

Encerra o cronômetro atual do painel de comunicação

Método sem retorno

SetTextCommunicationPanel

SetTextCP

  • v2.19.0

Alterar o texto do painel de comunicação

Parâmetros:

Nome Tipo Descrição
text String (opcional) Alterar o texto do painel de comunicação. Styled Text a partir da v2.19.0
show Boolean (opcional) Exibir/ocultar o texto
display_ahead Boolean (opcional) Alterar a opção 'exibir à frente de tudo'
theme Object (opcional) ID ou nome do Tema utilizado para exibir o texto v2.21.0+
custom_theme Theme (opcional) Tema personalizado para exibir o texto v2.21.0+

Método sem retorno

Exemplo:

Requisição
{
  "text": "",
  "show": true,
  "display_ahead": true
}

SetAlertCommunicationPanel

SetAlertCP

  • v2.19.0

Alterar as configurações de alerta do painel de comunicação

Parâmetros:

Nome Tipo Descrição
text String (opcional) Alterar o texto de alerta
show Boolean (opcional) Exibir/ocultar o alerta

Método sem retorno

Exemplo:

Requisição
{
  "text": "",
  "show": false
}

CommunicationPanelCallAttention

CPCallAttention

  • v2.20.0

Executa a opção 'chamar atenção' disponível no painel de comunicação

Método sem retorno

GetWallpaperSettings

  • v2.19.0

Configurações do papel de parede

Resposta:

Nome Tipo Descrição
data.image_base64 String Imagem do papel de parede em base 64
data.enabled Boolean Exibir papel de parede
data.fill_color String Cor em hexadecimal definida na opção preencher.
data.extend Boolean deprecated Substituído por adjust_type
Estender papel de parede
data.adjust_type String Ajuste da imagem: Pode ser: ADJUST EXTEND FILL ADJUST_BLUR v2.22.0+
data.show_clock Boolean Exibir relógio
data.by_screen Object Configuração independente por tela v2.23.0+
data.by_screen.default WallpaperSettings Configuração padrão v2.23.0+
data.by_screen.public WallpaperSettings Configuração personalizada para a tela ou null se estiver utilizando a configuração padrão v2.23.0+
data.by_screen.screen_n WallpaperSettings n >= 2 v2.23.0+

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "image_base64": "",
    "enabled": false,
    "fill_color": "#000000",
    "extend": false,
    "show_clock": false
  }
}

SetWallpaperSettings

  • v2.19.0

Alterar as configurações do papel de parede

Parâmetros:

Nome Tipo Descrição
file String (opcional) Local do arquivo na aba Imagens
enabled Boolean (opcional) Exibir papel de parede
fill_color String (opcional) Cor em hexadecimal definida na opção preencher. NULL para desativar
extend Boolean (opcional) deprecated Substituído por adjust_type
Estender papel de parede
adjust_type String Ajuste da imagem: Pode ser: ADJUST EXTEND FILL ADJUST_BLUR v2.22.0+
show_clock Boolean (opcional) Exibir relógio
by_screen Object (opcional) Configuração independente por tela v2.23.0+
by_screen.default WallpaperSettings (opcional) Configuração padrão v2.23.0+
by_screen.public WallpaperSettings (opcional) Configuração personalizada para a tela ou null se estiver utilizando a configuração padrão v2.23.0+
by_screen.screen_n WallpaperSettings (opcional) n >= 2 v2.23.0+

Resposta:

Tipo Descrição
Object Retorna true ou uma lista com os erros ocorridos

Exemplo:

Requisição
{
  "file": "wallpapers/image.jpg",
  "enabled": true,
  "fill_color": "#000000",
  "extend": true,
  "show_clock": false
}

Resposta
{
  "status": "ok",
  "data": true
}

GetDisplaySettings

  • v2.19.0

Lista das configurações de exibição de cada tela

Resposta:

Nome Tipo
data Array<DisplaySettings>

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "public",
      "name": "Public",
      "slide_info": {
        "info_1": {
          "show_page_count": false,
          "show_slide_description": false,
          "horizontal_align": "right",
          "vertical_align": "bottom"
        },
        "info_2": {
          "show": false,
          "layout_row_1": "<title>< (%author_or_artist%)>",
          "horizontal_align": "right",
          "vertical_align": "bottom"
        },
        "font": {
          "name": null,
          "bold": null,
          "italic": null,
          "color": null
        },
        "height": 7,
        "paint_theme_effect": true
      },
      "slide_translation": "",
      "margin": {
        "top": 0.0,
        "right": 0.0,
        "bottom": 0.0,
        "left": 0.0
      },
      "area": {
        "x": 1920,
        "y": 0,
        "width": 1920,
        "height": 1080
      },
      "total_area": {
        "x": 1920,
        "y": 0,
        "width": 1920,
        "height": 1080
      },
      "hide": false
    },
    {
      "id": "screen_2",
      "name": "Screen 2",
      "stage_view": {
        "enabled": true,
        "preview_mode": "FIRST_LINE_OF_THE_NEXT_SLIDE_WITH_SEPARATOR",
        "uppercase": false,
        "remove_line_break": false,
        "show_comment": true,
        "show_advanced_editor": false,
        "show_communication_panel": true,
        "custom_theme": 123,
        "apply_custom_theme_to_bible": true,
        "apply_custom_theme_to_text": true
      },
      "slide_info": {
        "info_1": {
          "show_page_count": false,
          "show_slide_description": false,
          "horizontal_align": "right",
          "vertical_align": "bottom"
        },
        "info_2": {
          "show": false,
          "layout_row_1": "<title>< (%author_or_artist%)>",
          "horizontal_align": "right",
          "vertical_align": "bottom"
        },
        "font": {
          "name": null,
          "bold": null,
          "italic": null,
          "color": null
        },
        "height": 7,
        "paint_theme_effect": true
      },
      "slide_translation": "",
      "bible_version_tab": 1,
      "margin": {
        "top": 0.0,
        "right": 0.0,
        "bottom": 0.0,
        "left": 0.0
      },
      "area": {
        "x": 3840,
        "y": 0,
        "width": 1920,
        "height": 1080
      },
      "total_area": {
        "x": 3840,
        "y": 0,
        "width": 1920,
        "height": 1080
      },
      "hide": false
    },
    {
      "id": "stream_image",
      "name": "Stream - Image",
      "stage_view": {
        "enabled": true,
        "preview_mode": "FIRST_LINE_OF_THE_NEXT_SLIDE_WITH_SEPARATOR",
        "uppercase": false,
        "remove_line_break": false,
        "show_comment": true,
        "show_advanced_editor": false,
        "show_communication_panel": true,
        "custom_theme": null,
        "apply_custom_theme_to_bible": true,
        "apply_custom_theme_to_text": true
      },
      "slide_info": {
        "info_1": {
          "show_page_count": false,
          "show_slide_description": false,
          "horizontal_align": "right",
          "vertical_align": "bottom"
        },
        "info_2": {
          "show": false,
          "layout_row_1": "<title>< (%author_or_artist%)>",
          "horizontal_align": "right",
          "vertical_align": "bottom"
        },
        "font": {
          "name": null,
          "bold": null,
          "italic": null,
          "color": null
        },
        "height": 7,
        "paint_theme_effect": true
      },
      "slide_translation": "",
      "bible_version_tab": 1,
      "show_items": {
        "lyrics": true,
        "text": true,
        "verse": true,
        "image": true,
        "alert": true,
        "announcement": true
      }
    },
    {
      "id": "stream_html_1",
      "name": "Stream - HTML 1",
      "stage_view": {
        "enabled": true,
        "preview_mode": "FIRST_LINE_OF_THE_NEXT_SLIDE_WITH_SEPARATOR",
        "uppercase": false,
        "remove_line_break": false,
        "show_comment": true,
        "show_advanced_editor": false,
        "show_communication_panel": true,
        "custom_theme": null,
        "apply_custom_theme_to_bible": true,
        "apply_custom_theme_to_text": true
      },
      "slide_translation": "",
      "bible_version_tab": 1,
      "show_items": {
        "lyrics": true,
        "text": true,
        "verse": true,
        "image": true,
        "alert": true,
        "announcement": true
      }
    }
  ]
}

SetDisplaySettings

  • v2.19.0

Alterar as configurações de exibição de uma tela

Parâmetros:

Nome Tipo Descrição
input DisplaySettings Novas configurações. As configurações são individualmente opcionais. Preencha apenas os campos que deseja alterar.

Resposta:

Tipo Descrição
Object Retorna true ou uma lista com os erros ocorridos

Exemplo:

Requisição
{
  "id": "screen_2",
  "stage_view": {
    "enabled": true,
    "preview_mode": "FIRST_LINE_OF_THE_NEXT_SLIDE_WITH_SEPARATOR",
    "uppercase": true
  },
  "margin": {
    "top": 0,
    "right": 0,
    "bottom": 10,
    "left": 0
  }
}

Resposta
{
  "status": "ok",
  "data": true
}

GetDisplaySettingsPresets

  • v2.26.0

Lista com os modelos salvos de configurações de exibição

Parâmetros:

Nome Tipo Descrição
type Object Tipo de preset. Valores aceitos: public return image html

Resposta:

Nome Tipo
data Array<DisplaySettingsPreset>

Exemplo:

Requisição
{
  "type": "public"
}

Resposta
{
  "status": "ok",
  "data": {
    "id": "abcxyz",
    "name": "Example",
    "settings": {
      "slide_info": {
        "info_1": {
          "show_page_count": false,
          "show_slide_description": false,
          "horizontal_align": "right",
          "vertical_align": "bottom"
        },
        "info_2": {
          "show": false,
          "layout_row_1": "<title>< (%author_or_artist%)>",
          "horizontal_align": "right",
          "vertical_align": "bottom"
        },
        "font": {
          "name": null,
          "bold": null,
          "italic": null,
          "color": null
        },
        "height": 7,
        "paint_theme_effect": true
      },
      "slide_translation": "",
      "margin": {
        "top": 0.0,
        "right": 0.0,
        "bottom": 0.0,
        "left": 0.0
      },
      "area": {
        "x": 1920,
        "y": 0,
        "width": 1920,
        "height": 1080
      },
      "hide": false
    }
  }
}

GetTransitionEffectSettings

  • v2.21.0

Lista da configuração dos efeitos de transição

Resposta:

Nome Tipo Descrição
music Array<TransitionEffectSettings>
bible Array<TransitionEffectSettings>
image Array<TransitionEffectSettings>
announcement Array<TransitionEffectSettings>

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "music": {
      "enabled": true,
      "type": "fade",
      "duration": 500,
      "only_area_within_margin": false,
      "merge": false,
      "division_point": 30,
      "increase_duration_blank_slides": false
    },
    "bible": {
      "...": "..."
    },
    "image": {
      "...": "..."
    },
    "announcement": {
      "...": "..."
    }
  }
}

SetTransitionEffectSettings

  • v2.21.0

Alterar as configurações de um efeito de transição

Parâmetros:

Nome Tipo Descrição
id Object ID do item
settings TransitionEffectSettings Novas configurações. As configurações são individualmente opcionais. Preencha apenas os campos que deseja alterar.

Resposta:

Tipo Descrição
Object Retorna true ou uma lista com os erros ocorridos

Exemplo:

Requisição
{
  "id": "music",
  "settings": {
    "enabled": true,
    "type": "fade",
    "duration": 500,
    "only_area_within_margin": false,
    "merge": false,
    "division_point": 30,
    "increase_duration_blank_slides": false
  }
}

Resposta
{
  "status": "ok",
  "data": true
}

GetBibleVersions

  • v2.21.0

deprecated Substituído por: hly('GetBibleVersionsV2')
Retorna a lista de versões disponíveis da Bíblia, e também dos atalhos associados

Resposta:

Nome Tipo Descrição
data Array<Object>
data.*.key String Abreviação da versão ou o nome do atalho, se começar com '#shortcut '
data.*.title String Nome da versão
data.*.version String (opcional) Abreviação da versão. Disponível se o item for um atalho, ou seja se 'key' começar com '#shortcut '
data.*.language Object Idioma v2.24.0+
data.*.language.id String ID do item v2.24.0+
data.*.language.iso String ISO 639 two-letter language code v2.24.0+
data.*.language.name String Nome em inglês v2.24.0+
data.*.language.alt_name String Nome no próprio idioma definido em language. Pode ser null. v2.24.0+

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "key": "en_kjv",
      "title": "King James Version"
    },
    {
      "key": "en_akjv",
      "title": "American King James Version"
    },
    {
      "key": "#shortcut Example",
      "title": "King James Version",
      "version": "en_kjv"
    }
  ]
}

GetBibleVersionsV2

  • v2.23.0

Retorna a lista de versões disponíveis da Bíblia, e também dos atalhos associados

Resposta:

Nome Tipo Descrição
data Array<Object>
data.*.key String ID do item
data.*.version String ID da versão da Bíblia
data.*.title String Nome da versão ou nome do atalho
data.*.language Object Idioma v2.24.0+
data.*.language.id String ID do item v2.24.0+
data.*.language.iso String ISO 639 two-letter language code v2.24.0+
data.*.language.name String Nome em inglês v2.24.0+
data.*.language.alt_name String Nome no próprio idioma definido em language. Pode ser null. v2.24.0+

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "key": "en_kjv",
      "version": "en_kjv",
      "title": "King James Version",
      "language": {
        "id": "en",
        "iso": "en",
        "name": "English",
        "alt_name": "English"
      }
    },
    {
      "key": "pt_acf",
      "version": "pt_acf",
      "title": "Almeida Corrigida Fiel",
      "language": {
        "id": "pt",
        "iso": "pt",
        "name": "Portuguese",
        "alt_name": "Português"
      }
    }
  ]
}

GetBibleSettings

  • v2.21.0

Configurações do módulo Bíblia

Resposta:

Nome Tipo
data Array<BibleSettings>

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "tab_version_1": "pt_???",
    "tab_version_2": "es_???",
    "tab_version_3": "en_???",
    "show_x_verses": 1,
    "uppercase": false,
    "show_only_reference": false,
    "show_second_version": false,
    "show_third_version": false,
    "book_panel_type": "grid",
    "book_panel_order": "automatic",
    "book_panel_order_available_items": [
      "automatic",
      "standard",
      "ru",
      "tyv"
    ],
    "multiple_verses_separator_type": "double_line_break",
    "versification": true,
    "theme": {
      "public": 123,
      "screen_n": null
    }
  }
}

SetBibleSettings

  • v2.21.0

Alterar as configurações do módulo Bíblia

Parâmetros:

Nome Tipo Descrição
input BibleSettings Novas configurações. As configurações são individualmente opcionais. Preencha apenas os campos que deseja alterar.

Resposta:

Tipo Descrição
Object Retorna true ou uma lista com os erros ocorridos

Exemplo:

Requisição
{
  "tab_version_1": "pt_acf",
  "show_x_verses": 1,
  "theme": {
    "public": "123"
  }
}

Resposta
{
  "status": "ok",
  "data": true
}

GetPresentationFooterSettings

  • v2.23.0

Configurações do rodapé de apresentação

Resposta:

Nome Tipo Descrição
data.rows Number Quantidade de linhas. 1 ~ 4
data.preview_mode String Valores aceitos: text image
data.minimized Boolean

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "rows": 2,
    "preview_mode": "text",
    "minimized": false
  }
}

SetPresentationFooterSettings

  • v2.23.0

Alterar as configurações do rodapé de apresentação

Parâmetros:

Nome Tipo Descrição
rows Number Quantidade de linhas. 1 ~ 4
preview_mode String Valores aceitos: text image
minimized Boolean

Resposta:

Tipo Descrição
Object Retorna true ou uma lista com os erros ocorridos

Exemplo:

Requisição
{
  "rows": 2,
  "preview_mode": "text",
  "minimized": false
}

Resposta
{
  "status": "ok",
  "data": {}
}

GetBpm

  • v2.19.0

Retorna o valor BPM atual definido no programa

Resposta:

Tipo Descrição
Number Valor BPM atual

Exemplo:

Resposta
{
  "status": "ok",
  "data": 80
}

SetBpm

  • v2.19.0

Altera o valor BPM atual do programa

Parâmetros:

Nome Tipo Descrição
bpm Number Valor BPM

Método sem retorno

Exemplo:

Requisição
{
  "bpm": 80
}

GetHue

  • v2.19.0

Retorna o valor matiz atual definido no programa

Resposta:

Tipo Descrição
Number Valor matiz atual. Mínimo=0, Máximo=360. Retorna null se desativado.

Exemplo:

Resposta
{
  "status": "ok",
  "data": 120
}

SetHue

  • v2.19.0

Altera o valor matiz atual do programa

Parâmetros:

Nome Tipo Descrição
hue Number Valor matiz. Mínimo=0, Máximo=360 ou null para desativar.

Método sem retorno

Exemplo:

Requisição
{
  "hue": null
}

GetRuntimeEnvironment

GetRE

  • v2.19.0

Retorna o nome do ambiente de execução definido atualmente nas configurações do programa.

Resposta:

Tipo Descrição
String Nome do ambiente de execução

Exemplo:

Resposta
{
  "status": "ok",
  "data": "runtime environment name"
}

SetRuntimeEnvironment

SetRE

  • v2.19.0

Altera o ambiente de execução atual.

Parâmetros:

Nome Tipo Descrição
name String Nome do ambiente de execução

Método sem retorno

Exemplo:

Requisição
{
  "name": "runtime environment name"
}

SetLogo

  • v2.19.0

Alterar as configurações da funcionalidade Logo do programa (menu ferramentas)

Parâmetros:

Nome Tipo Descrição
enable Boolean (opcional) Ativar/desativar a funcionalidade
hide Boolean (opcional) Exibir/ocultar a funcionalidade

Método sem retorno

Exemplo:

Requisição
{
  "enable": true,
  "hide": true
}

GetSyncStatus

  • v2.19.0

Retorna o estado atual da sincronização online via Google Drive™

Resposta:

Nome Tipo Descrição
data.enabled Boolean Se a sincronização está ativada
data.started Boolean Se a sincronização foi iniciada (internet disponível, por exemplo)
data.progress Number Progresso da sincronização de 0 a 100

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "enabled": true,
    "started": true,
    "progress": 99
  }
}

GetInterfaceInput

  • v2.21.0

Retorna o valor de um campo da interface do programa

Parâmetros:

Nome Tipo Descrição
id String ID do item. Pode ser:
main_lyrics_tab_search
main_text_tab_search
main_audio_tab_search
main_video_tab_search
main_image_tab_search
main_file_tab_search
main_automatic_presentation_tab_search
main_selected_theme
main_selected_song_group_filter
main_selected_tab_event

Resposta:

Tipo Descrição
String Conteúdo do item

Exemplo:

Requisição
{
  "id": "main_lyrics_tab_search"
}

Resposta
{
  "status": "ok",
  "data": "input value"
}

SetInterfaceInput

  • v2.21.0

Altera o valor de um campo da interface do programa

Parâmetros:

Nome Tipo Descrição
id String ID do item. Pode ser:
main_lyrics_tab_search
main_text_tab_search
main_audio_tab_search
main_video_tab_search
main_image_tab_search
main_file_tab_search
main_automatic_presentation_tab_search
main_selected_theme
main_selected_song_group_filter
main_selected_tab_event
value String Novo valor
focus Boolean (opcional) Fazer o componente receber o foco do sistema

Método sem retorno

Exemplo:

Requisição
{
  "id": "main_lyrics_tab_search",
  "value": "new input value",
  "focus": true
}

SelectVerse

  • v2.21.0

Seleciona um versículo na janela da Bíblia

Parâmetros:

Nome Tipo Descrição
id String (opcional) ID do versículo
reference String (opcional) Referência do versículo

Método sem retorno

Exemplo:

Requisição
{
  "id": "43003016"
}

OpenDrawLots

  • v2.21.0

Abre a janela de sorteio a partir de uma lista de itens

Parâmetros:

Nome Tipo Descrição
items Array<String> Lista com os itens para serem sorteados

Método sem retorno

Exemplo:

Requisição
{
  "items": [
    "Item 1",
    "Item 2",
    "Item 3"
  ]
}

GetMediaDuration

  • v2.21.0

Retorna a duração da mídia

Parâmetros:

Nome Tipo Descrição
type String Tipo do item. Pode ser: video, audio, automatic_presentation
name String Nome do item

Resposta:

Nome Tipo Descrição
data.type String
data.name String
data.duration Number Duração em segundos
data.duration_ms Number Duração em milissegundos

Exemplo:

Requisição
{
  "type": "audio",
  "name": "file.mp3"
}

Resposta
{
  "status": "ok",
  "data": {
    "type": "audio",
    "name": "file.mp3",
    "duration": 128,
    "duration_ms": 128320
  }
}

GetVersion

  • v2.22.0

Retorna informações da versão do programa em execução

Resposta:

Nome Tipo Descrição
data.version String Versão do programa
data.platform String Sistema operacional. Pode ser: win uni osx
data.platformDescription String Nome detalhado do sistema operacional
data.baseDir String v2.24.0+
data.language String v2.24.0+
data.platformLanguage String v2.26.0+
data.theme String Um dos seguintes valores: DEFAULT DARK_SOFT DARK_MEDIUM DARK_STRONG v2.24.0+
data.jscVersion String JS Community Version y.m.d v2.24.0+
data.ip_list Array<String> v2.26.0+

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "data": {
      "version": "2.22.0",
      "platform": "win",
      "platformDescription": "Windows 10",
      "baseDir": "C:\\Holyrics",
      "language": "pt",
      "theme": "DARK_STRONG",
      "jscVersion": "24.10.12"
    }
  }
}

GetAPIServerInfo

  • v2.26.0

Retorna informações do servidor API

Resposta:

Nome Tipo Descrição
data.enabled_local Boolean Se está ativado para acesso local
data.enabled_web Boolean Se está ativado para acesso pela internet
data.port Number
data.ip_list Array<String>

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "enabled_local": false,
    "enabled_web": false,
    "port": 8091,
    "ip_list": [
      "192.168.0.123"
    ]
  }
}

GetRealTimeSongKey

  • v2.24.0

Parâmetros:

Nome Tipo Descrição
id String ID da música

Resposta:

Nome Tipo Descrição
data.key String C C# Db D D# Eb E F F# Gb G G# Ab A A# Bb B Cm C#m Dbm Dm D#m Ebm Em Fm F#m Gbm Gm G#m Abm Am A#m Bbm Bm

Exemplo:

Requisição
{
  "id": "123"
}

Resposta
{
  "status": "ok",
  "data": {
    "key": "Em"
  }
}

SetRealTimeSongKey

  • v2.24.0

Parâmetros:

Nome Tipo Descrição
id String ID da música
key String C C# Db D D# Eb E F F# Gb G G# Ab A A# Bb B Cm C#m Dbm Dm D#m Ebm Em Fm F#m Gbm Gm G#m Abm Am A#m Bbm Bm

Método sem retorno

Exemplo:

Requisição
{
  "id": "123",
  "key": "Am"
}

ActionNextQuickPresentation

  • v2.24.0

Método sem retorno

ActionPreviousQuickPresentation

  • v2.24.0

Método sem retorno

CloseCurrentQuickPresentation

  • v2.24.0

Método sem retorno

GetCurrentQuickPresentation

  • v2.24.0

Resposta:

Nome Tipo Descrição
data.id String ID do versículo atual
data.slide_number Number Começa em 1
data.total_slides Number Total de versículos
data.slide_type String Um dos seguintes valores: default wallpaper blank black final_slide
data.slides Array<Object> Lista com os versículos da apresentação atual
data.slides.*.number Number Número do slide. Começa em 1.
data.slides.*.reference String Referência do versículo. Exemplo: John 3:16

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "id": "43003016",
    "slide_number": 1,
    "total_slides": 3,
    "slide_type": "default",
    "slides": [
      {
        "number": 1,
        "reference": "43003016"
      },
      {
        "number": 2,
        "reference": "43003017"
      },
      {
        "number": 3,
        "reference": "43003018"
      }
    ]
  }
}

GetTriggers

  • v2.24.0

Retorna a lista de gatilhos salvos

Resposta:

Nome Tipo Descrição
data Array<Object>
data.*.id String ID do item
data.*.enabled Boolean
data.*.when String Pode ser: displaying closing change event
data.*.type String Tipo do item. Pode ser:
when=displaying: any_song any_text any_verse any_announcement any_audio any_video any_image any_automatic_presentation any_song_slide any_text_slide any_ppt_slide any_theme any_background any_title_subitem any_webcam any_audio_folder any_video_folder any_image_folder any_ppt any_countdown any_automatic_presentation_slide f8 f9 f10

when=closing: any_song any_text any_verse any_announcement any_audio any_video any_image any_automatic_presentation any_webcam any_audio_folder any_video_folder any_image_folder any_ppt f8 f9 f10

when=change: countdown_seconds_public countdown_seconds_communication_panel timer_seconds_communication_panel wallpaper wallpaper_service stage playlist bpm hue player_volume player_mute player_pause player_repeat player_list_or_single player_shuffle bible_version_1 bible_version_2 bible_version_3 bible_any_version

when=event: new_message_chat verse_presentation_changed playlist_changed file_modified player_progress draw_lots_item_drawn
data.*.item.title String
data.*.item.reference Object
data.*.receiver.type String Pode ser: get post ws tcp udp midi javascript community multiple_actions obs_v4 obs_v5 lumikit vmix osc soundcraft ha ptz tbot openai
data.*.description String
data.*.tags Array<String>

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "xyz",
      "enabled": true,
      "when": "displaying",
      "type": "any_song",
      "item": {
        "title": "",
        "reference": {}
      },
      "receiver": {
        "type": "obs_v5"
      },
      "description": "",
      "tags": []
    }
  ]
}

GetScheduledTasks

  • v2.26.0

Retorna a lista de tarefas agendadas

Resposta:

Nome Tipo
data Array<ScheduledTask>

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "abc",
      "enabled": true,
      "time": "18:50:00",
      "days": [
        "sun"
      ],
      "item": {},
      "tags": []
    },
    {
      "id": "xyz",
      "enabled": true,
      "time": "18:55:00",
      "days": [
        "sun"
      ],
      "item": {},
      "tags": []
    }
  ]
}

GetGlobalSettings

  • v2.25.0

Parâmetros:

Nome Tipo Descrição
filter String (opcional) Nome das configurações, separadas por vírgula

Resposta:

Tipo
GlobalSettings

Exemplo:

Requisição
{
  "filter": "show_favorite_bar_main_window,fade_in_out_duration"
}

Resposta
{
  "status": "ok",
  "data": {
    "show_favorite_bar_main_window": true,
    "fade_in_out_duration": 500
  }
}

SetGlobalSettings

  • v2.25.0

Parâmetros:

Nome Tipo Descrição
input GlobalSettings

Resposta:

Nome Tipo Descrição
data Object Conjunto chave/valor com o resultado da alteração de cada item.
true se o valor foi alterado com sucesso, ou uma string com o motivo do erro.

Exemplo:

Requisição
{
  "show_favorite_bar_main_window": true,
  "fade_in_out_duration": 100
}

Resposta
{
  "status": "ok",
  "data": {
    "show_favorite_bar_main_window": true,
    "fade_in_out_duration": "invalid value: 100"
  }
}

GetStyledModels

  • v2.25.0

Resposta:

Tipo
StyledModel

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "key": "title",
      "properties": {
        "b": "true",
        "size": "120"
      }
    },
    {
      "key": "footer",
      "properties": {
        "i": "true",
        "size": "80"
      }
    }
  ]
}

GetStyledModelsAsMap

  • v2.25.0

Resposta:

Tipo Descrição
Object Conjunto chave/valor
StyledModel#key : StyledModel#properties

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "title": {
      "b": "true",
      "size": "120"
    },
    "footer": {
      "i": "true",
      "size": "80"
    }
  }
}

GetMidiSettings

  • v2.26.0

Resposta:

Nome Tipo Descrição
data.codes Object Conjunto chave/valor
A chave é o id da respectiva ação e o valor é o código MIDI 0 ~ 127
IDs disponíveis: presentation_action_next presentation_action_previous presentation_action_exit presentation_action_blank presentation_action_black presentation_action_wallpaper presentation_action_next_playlist_item presentation_action_previous_playlist_item media_player_play_pause media_player_stop media_player_next media_player_previous media_player_mute media_player_fullscreen media_player_volume presentation_action_go_to_slide select_item_from_song_playlist select_item_from_media_playlist multiple_choice shortcut_1 shortcut_2 shortcut_3 shortcut_4 shortcut_5 shortcut_6 shortcut_7 shortcut_8 shortcut_9 shortcut_10 shortcut_11 shortcut_12 shortcut_13 shortcut_14 shortcut_15 shortcut_16
data.settings Object Configurações
data.settings.base_octave Object Número base de início da oitava para código midi = 0 (zero).
Ou seja, se base_octave=-1, então código midi=0 é igual a C-1
Pode ser -1 ou -2

Exemplo:

Resposta
{
  "status": "ok",
  "data": {
    "codes": {
      "presentation_action_next": 0,
      "presentation_action_previous": 1,
      "presentation_action_exit": 2,
      "presentation_action_blank": 3,
      "presentation_action_black": 4,
      "presentation_action_wallpaper": 5,
      "media_player_play_pause": 6,
      "media_player_stop": 7,
      "media_player_next": 8,
      "media_player_previous": 9,
      "media_player_mute": 10,
      "media_player_fullscreen": 11,
      "media_player_volume": 12,
      "presentation_action_go_to_slide": 13,
      "select_item_from_song_playlist": 14,
      "select_item_from_media_playlist": 15,
      "shortcut_1": 16,
      "shortcut_2": 17,
      "shortcut_3": 18,
      "shortcut_4": 19,
      "shortcut_5": 20,
      "shortcut_6": 21,
      "shortcut_7": 22,
      "shortcut_8": 23,
      "shortcut_9": 24,
      "shortcut_10": 25,
      "shortcut_11": 26,
      "shortcut_12": 27,
      "shortcut_13": 28,
      "shortcut_14": 29,
      "shortcut_15": 30,
      "shortcut_16": 31
    },
    "settings": {
      "base_octave": -1
    }
  }
}

GetRuleGroupList

  • v2.26.0

Retorna os grupos de regras salvas

Resposta:

Nome Tipo
data Array<RuleGroup>

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "abc",
      "name": "Example",
      "match_mode": "all",
      "rules": [
        {
          "id": "...",
          "enabled": true,
          "description": "",
          "type": {
            "id": "day_of_week",
            "name": "",
            "settings_type": "custom"
          },
          "data": {
            "days": [
              "sun",
              "tue",
              "thu",
              "sat"
            ]
          }
        },
        {
          "id": "hhmtGGcqjhpz",
          "enabled": false,
          "description": "",
          "type": {
            "id": "day_of_month",
            "name": "",
            "settings_type": "native",
            "native_type": "number",
            "operator": "is_between"
          },
          "data": {
            "values": [
              "12",
              "15"
            ]
          }
        }
      ],
      "metadata": {
        "modified_time_millis": "0"
      }
    }
  ]
}

GetRuleGroup

  • v2.26.0

Retorna um grupo de regras salva

Parâmetros:

Nome Tipo Descrição
id String ID do grupo de regras

Resposta:

Nome Tipo
data RuleGroup

Exemplo:

Requisição
{
  "id": "abc"
}

Resposta
{
  "status": "ok",
  "data": {
    "id": "abc",
    "name": "Example",
    "match_mode": "all",
    "rules": [
      {
        "id": "...",
        "enabled": true,
        "description": "",
        "type": {
          "id": "day_of_week",
          "name": "",
          "settings_type": "custom"
        },
        "data": {
          "days": [
            "sun",
            "tue",
            "thu",
            "sat"
          ]
        }
      },
      {
        "id": "hhmtGGcqjhpz",
        "enabled": false,
        "description": "",
        "type": {
          "id": "day_of_month",
          "name": "",
          "settings_type": "native",
          "native_type": "number",
          "operator": "is_between"
        },
        "data": {
          "values": [
            "12",
            "15"
          ]
        }
      }
    ],
    "metadata": {
      "modified_time_millis": "0"
    }
  }
}

TestRuleGroup

  • v2.26.0

Retorna o resultado do teste de um grupo de regras salvas (ou de uma regra específica do respectivo grupo)

Parâmetros:

Nome Tipo Descrição
id String ID do grupo de regras
rule_id String (opcional) ID da regra específica a ser testada em vez de testar todo o grupo

Resposta:

Nome Tipo Descrição
data Boolean true or false

Exemplo:

Requisição
{
  "id": "abc"
}

GetTransitionEffectTemplateSettingsList

  • v2.26.0

Retorna a lista com os modelos de efeito de transição

Resposta:

Nome Tipo
data Array<TransitionEffectTemplateSettings>

Exemplo:

Resposta
{
  "status": "ok",
  "data": [
    {
      "id": "abc",
      "name": "Example 01",
      "enabled": true,
      "type": "fade",
      "duration": 700,
      "only_area_within_margin": false,
      "merge": false,
      "division_point": 30,
      "increase_duration_blank_slides": false,
      "metadata": {
        "modified_time_millis": "0"
      }
    },
    {
      "id": "xyz",
      "name": "Example 02",
      "enabled": true,
      "type": "fade",
      "duration": 700,
      "only_area_within_margin": false,
      "merge": false,
      "division_point": 30,
      "increase_duration_blank_slides": false,
      "metadata": {
        "modified_time_millis": "0"
      }
    },
    {
      "id": "abcxyz",
      "name": "Example 03",
      "enabled": true,
      "type": "zoom",
      "duration": 800,
      "only_area_within_margin": false,
      "zoom_type": "increase",
      "directions": {
        "top_left": false,
        "top_center": false,
        "top_right": false,
        "middle_left": false,
        "middle_center": true,
        "middle_right": false,
        "bottom_left": false,
        "bottom_center": false,
        "bottom_right": false
      },
      "metadata": {
        "modified_time_millis": "0"
      }
    }
  ]
}

GetTransitionEffectTemplateSettings

  • v2.26.0

Retorna um modelo de efeito de transição

Parâmetros:

Nome Tipo Descrição
id String ID do modelo

Resposta:

Nome Tipo
data TransitionEffectTemplateSettings

Exemplo:

Requisição
{
  "id": "abcxyz"
}

Resposta
{
  "status": "ok",
  "data": {
    "id": "abcxyz",
    "name": "Example 03",
    "enabled": true,
    "type": "zoom",
    "duration": 800,
    "only_area_within_margin": false,
    "zoom_type": "increase",
    "directions": {
      "top_left": false,
      "top_center": false,
      "top_right": false,
      "middle_left": false,
      "middle_center": true,
      "middle_right": false,
      "bottom_left": false,
      "bottom_center": false,
      "bottom_right": false
    },
    "metadata": {
      "modified_time_millis": "0"
    }
  }
}

SetTransitionEffectTemplateSettings

  • v2.26.0

Alterar as configurações de um modelo de efeito de transição

Parâmetros:

Nome Tipo Descrição
id Object ID do item
settings TransitionEffectSettings Novas configurações. As configurações são individualmente opcionais. Preencha apenas os campos que deseja alterar.

Resposta:

Tipo Descrição
Object Retorna true ou uma lista com os erros ocorridos

Exemplo:

Requisição
{
  "id": "abcxyz",
  "settings": {
    "type": "zoom",
    "duration": 800,
    "zoom_type": "increase",
    "directions": {
      "middle_left": true,
      "middle_center": true,
      "middle_right": true
    }
  }
}

Resposta
{
  "status": "ok",
  "data": {}
}

CreateItem

  • v2.25.0

Cria um novo item

Esta ação requer uma assinatura Holyrics Plan para ser executada
Para utilizar esta ação é necessário liberar a permissão nas configurações
menu arquivo > configurações > avançado > javascript > configurações > permissões avançadas
Ou se estiver utilizando a implementação de um módulo, liberar permissão nas configurações do módulo e utilizar o método hly da classe Module module.hly(action, input)

A estrutura do objeto passado como parâmetro deve ser de acordo com a tabela a seguir

Ação

Tipo

CreateSong

Lyrics

CreateText

Text

CreateTheme

Theme

CreateTeam

Team

CreateRole

Role

CreateMember

Member

CreateEvent

Event

CreateSongGroup

Group

Resposta:

Tipo Descrição
Object Retorna o item criado

Exemplo:

Requisição
{
  "status": "ok",
  "data": {
    "title": "Title",
    "artist": "Artist",
    "author": "Author",
    "slides": [
      {
        "text": "Example",
        "slide_description": "Verse 1",
        "translations": {
          "pt": "Exemplo"
        }
      },
      {
        "text": "Example",
        "slide_description": "Chorus",
        "translations": {
          "pt": "Exemplo"
        }
      },
      {
        "text": "Example",
        "slide_description": "Verse 2",
        "translations": {
          "pt": "Exemplo"
        }
      }
    ],
    "title_translations": {
      "pt": "Título"
    },
    "orde": "1,2,3,2,2",
    "key": "G",
    "bpm": 80,
    "time_sig": "4/4"
  }
}

Resposta
{
  "status": "ok",
  "data": {
    "id": "123",
    "title": "Title",
    "artist": "Artist",
    "author": "Author",
    "slides": [
      {
        "text": "Example",
        "slide_description": "Verse 1",
        "translations": {
          "pt": "Exemplo"
        }
      },
      {
        "text": "Example",
        "slide_description": "Chorus",
        "translations": {
          "pt": "Exemplo"
        }
      },
      {
        "text": "Example",
        "slide_description": "Verse 2",
        "translations": {
          "pt": "Exemplo"
        }
      }
    ],
    "title_translations": {
      "pt": "Título"
    },
    "orde": "1,2,3,2,2",
    "key": "G",
    "bpm": 80,
    "time_sig": "4/4"
  }
}

EditItem

  • v2.25.0

Edita um item existente

Esta ação requer uma assinatura Holyrics Plan para ser executada
Para utilizar esta ação é necessário liberar a permissão nas configurações
menu arquivo > configurações > avançado > javascript > configurações > permissões avançadas
Ou se estiver utilizando a implementação de um módulo, liberar permissão nas configurações do módulo e utilizar o método hly da classe Module module.hly(action, input)
 
Todos os parâmetros são opcionais, exceto: id
Somente os parâmetros declarados serão alterados, ou seja, não é necessário informar o objeto completo para alterar somente um parâmetro.
Parâmetros definidos como read-only não são editáveis
A estrutura do objeto passado como parâmetro deve ser de acordo com a tabela a seguir

Ação

Tipo

EditSong

Lyrics

EditText

Text

EditTheme

Theme

EditTeam

Team

EditRole

Role

EditMember

Member

EditEvent

Event

EditSongGroup

Group

Método sem retorno

DeleteItem

  • v2.25.0

Apaga um item existente

Esta ação requer uma assinatura Holyrics Plan para ser executada
Para utilizar esta ação é necessário liberar a permissão nas configurações
menu arquivo > configurações > avançado > javascript > configurações > permissões avançadas
Ou se estiver utilizando a implementação de um módulo, liberar permissão nas configurações do módulo e utilizar o método hly da classe Module module.hly(action, input)

Informe o id do respectivo item para removê-lo.

Ação

DeleteSong

DeleteText

DeleteTheme

DeleteTeam

DeleteRole

DeleteMember

DeleteEvent

DeleteSongGroup

Parâmetros:

Nome Tipo Descrição
id String ID do respectivo item

Método sem retorno

Exemplo:

Requisição
{
  "id": "123"
}

AddSongsToSongGroup

  • v2.25.0

Adiciona músicas a um grupo

Esta ação requer uma assinatura Holyrics Plan para ser executada
Para utilizar esta ação é necessário liberar a permissão nas configurações
menu arquivo > configurações > avançado > javascript > configurações > permissões avançadas
Ou se estiver utilizando a implementação de um módulo, liberar permissão nas configurações do módulo e utilizar o método hly da classe Module module.hly(action, input)

Parâmetros:

Nome Tipo Descrição
group String Nome do grupo
songs String Lista com o id das músicas, separados por vírgula

Método sem retorno

Exemplo:

Requisição
{
  "group": "Name",
  "songs": "123,456"
}

RemoveSongsFromSongGroup

  • v2.25.0

Remove músicas de um grupo

Esta ação requer uma assinatura Holyrics Plan para ser executada
Para utilizar esta ação é necessário liberar a permissão nas configurações
menu arquivo > configurações > avançado > javascript > configurações > permissões avançadas
Ou se estiver utilizando a implementação de um módulo, liberar permissão nas configurações do módulo e utilizar o método hly da classe Module module.hly(action, input)

Parâmetros:

Nome Tipo Descrição
group String Nome do grupo
songs String Lista com o id das músicas, separados por vírgula

Método sem retorno

Exemplo:

Requisição
{
  "group": "Name",
  "songs": "123,456"
}

SetCurrentSchedule

  • v2.26.0

Alterar o culto ou evento atualmente selecionado na interface

Esta ação requer uma assinatura Holyrics Plan para ser executada

Parâmetros:

Nome Tipo Descrição
event_id String ID do evento Pode ser obtido de um objeto Schedule

Método sem retorno

Exemplo:

Requisição
{
  "event_id": "abcxyz"
}

Classes

Lyrics

Nome Tipo Descrição
id String ID da música
title String Título da música
artist String Artista da música
author String Autor da música
note String Anotação da música
copyright String Copyright da música
slides Array<Object> v2.21.0+
slides.*.text String Texto do slide v2.21.0+
slides.*.styled_text String Texto do slide com formatação styled (quando disponível) v2.24.0+
slides.*.slide_description String Descrição do slide v2.21.1+
slides.*.background_id String ID do tema ou plano de fundo salvo para o slide v2.21.0+
slides.*.translations Object Traduções para o slide.
Conjunto chave/valor. v2.25.0+
formatting_type String basic styled advanced

Ao utilizar este objeto em métodos de criação ou edição, se formatting_type=basic for utilizado, o valor da variável slides.*.text será utilizado, caso contrário, o valor da variável slides.*.styled_text será utilizado Padrão: basic v2.25.0+
order String Ordem dos slides (índice a partir do 1), separado por vírgula v2.21.0+
arrangements Array<SongArrangement> v2.25.1+
title_translations Object Traduções para o slide título.
Conjunto chave/valor. v2.25.0+
key String Tom da música.
Pode ser: C C# Db D D# Eb E F F# Gb G G# Ab A A# Bb B Cm C#m Dbm Dm D#m Ebm Em Fm F#m Gbm Gm G#m Abm Am A#m Bbm Bm
bpm Number BPM da música
time_sig String Tempo da música.
Pode ser: 2/2 2/4 3/4 4/4 5/4 6/4 3/8 6/8 7/8 9/8 12/8
groups Array<Group> Grupos onde a música está adicionada read-only
linked_audio_file String Caminho do arquivo de áudio linkado com a música v2.22.0+
linked_backing_track_file String Caminho do arquivo de áudio (playback) linkado com a música v2.22.0+
streaming Object URI ou ID dos streamings v2.22.0+
streaming.audio Object Áudio v2.22.0+
streaming.audio.spotify String v2.22.0+
streaming.audio.youtube String v2.22.0+
streaming.audio.deezer String v2.22.0+
streaming.backing_track Object Playback v2.22.0+
streaming.backing_track.spotify String v2.22.0+
streaming.backing_track.youtube String v2.22.0+
streaming.backing_track.deezer String v2.22.0+
midi Midi Atalho MIDI do item
extras Object Mapa de objetos extras (adicionados pelo usuário) v2.21.0+
theme String ID do tema salvo para a música v2.25.0+
archived Boolean Se a música está arquivada
metadata.modified_time_millis Number Data de modificação do arquivo. (timestamp) v2.25.0+ read-only
Ver exemplo 
{
  "id": "0",
  "title": "",
  "artist": "",
  "author": "",
  "note": "",
  "copyright": "",
  "slides": [
    {
      "text": "Slide 1 line 1\nSlide 1 line 2",
      "styled_text": "Slide 1 line 1\nSlide 1 line 2",
      "slide_description": "Verse 1",
      "background_id": null,
      "transition_settings_id": null,
      "translations": null
    },
    {
      "text": "Slide 2 line 1\nSlide 2 line 2",
      "styled_text": "Slide 2 line 1\nSlide 2 line 2",
      "slide_description": "Chorus",
      "background_id": null,
      "transition_settings_id": null,
      "translations": null
    },
    {
      "text": "Slide 3 line 1\nSlide 3 line 2",
      "styled_text": "Slide 3 line 1\nSlide 3 line 2",
      "slide_description": "Verse 2",
      "background_id": null,
      "transition_settings_id": null,
      "translations": null
    }
  ],
  "formatting_type": "basic",
  "order": "1,2,3,2,2",
  "title_translations": null,
  "key": "",
  "bpm": 0.0,
  "time_sig": "",
  "linked_audio_file": "",
  "linked_backing_track_file": "",
  "streaming": {
    "audio": {
      "spotify": "",
      "youtube": "",
      "deezer": ""
    },
    "backing_track": {
      "spotify": "",
      "youtube": "",
      "deezer": ""
    }
  },
  "extras": {
    "extra": ""
  },
  "theme": null,
  "transition_settings_id": null,
  "archived": false
}

Text

Nome Tipo Descrição
id String ID do texto
title String Título do texto
folder String Caminho da pasta de localização
theme String ID do tema salvo para o texto
slides Array<Object>
slides.*.text String Texto do slide
slides.*.styled_text String Texto do slide com formatação styled (quanto disponível) v2.24.0+
slides.*.background_id String ID do tema ou plano de fundo salvo para o slide
slides.*.translations Object Traduções para o slide.
Conjunto chave/valor. v2.25.0+
formatting_type String basic styled advanced

Ao utilizar este objeto em métodos de criação ou edição, se formatting_type=basic for utilizado, o valor da variável slides.*.text será utilizado, caso contrário, o valor da variável slides.*.styled_text será utilizado Padrão: basic v2.25.0+
extras Object Mapa de objetos extras (adicionados pelo usuário) v2.24.0+
metadata.modified_time_millis Number Data de modificação do arquivo. (timestamp) v2.25.0+ read-only
Ver exemplo 
{
  "id": "",
  "title": "",
  "folder": "",
  "theme": null,
  "transition_settings_id": null,
  "slides": [
    {
      "text": "Slide 1 line 1\nSlide 1 line 2",
      "styled_text": "Slide 1 line 1\nSlide 1 line 2",
      "background_id": null,
      "transition_settings_id": null,
      "translations": null
    },
    {
      "text": "Slide 2 line 1\nSlide 2 line 2",
      "styled_text": "Slide 2 line 1\nSlide 2 line 2",
      "background_id": null,
      "transition_settings_id": null,
      "translations": null
    },
    {
      "text": "Slide 3 line 1\nSlide 3 line 2",
      "styled_text": "Slide 3 line 1\nSlide 3 line 2",
      "background_id": null,
      "transition_settings_id": null,
      "translations": null
    }
  ],
  "formatting_type": "basic"
}

Theme

Nome Tipo Descrição
copy_from_id String (opcional) ID de um Tema existente para utilizar como cópia inicial ao criar um novo item
id String ID do item
name String Nome do item

background
Plano de fundo
background.type String Tipo do plano de fundo. Pode ser: color my_video my_image video image pattern transparent image_file video_file
background.id String

Tipo

Valor

color

Cor no formato hexadecimal

my_video

ID do item

my_image

ID do item

video

ID do item

image

ID do item

pattern

ID do item

transparent

"transparent"

image_file

Nome do arquivo na biblioteca

video_file

Nome do arquivo na biblioteca
background.adjust_type String fill extend adjust side_by_side center
Disponível para: type=my_image, type=image
background.opacity Number Opacidade. 0 ~ 100
background.velocity Number Disponível para: type=my_video, type=video
0.25 ~ 4.0
base_color String Cor no formato hexadecimal. Cor base do plano de fundo ao diminuir a opacidade.

font
Fonte
font.name String Nome da fonte
font.bold Boolean Negrito
font.italic Boolean Itálico
font.size Number Tamanho 0.0 ~ 0.4
Valor em porcentagem, baseado na altura do slide.
font.color String Cor no formato hexadecimal
font.line_spacing Number Espaçamento entre linhas. -0.5 ~ 1.0
Valor em porcentagem baseado na altura da linha.
font.char_spacing Number Espaçamento entre caracteres. -40 ~ 120

align
Alinhamento
align.horizontal String left center right justify
align.vertical String top middle bottom
align.margin.top Number 0 ~ 90
align.margin.right Number 0 ~ 90
align.margin.bottom Number 0 ~ 90
align.margin.left Number 0 ~ 90

effect
Efeitos da fonte
effect.outline_color String Cor no formato hexadecimal
effect.outline_weight Number 0.0 ~ 100.0
effect.brightness_color String Cor no formato hexadecimal
effect.brightness_weight Number 0.0 ~ 100.0
effect.shadow_color String Cor no formato hexadecimal
effect.shadow_x_weight Number -100.0 ~ 100.0
effect.shadow_y_weight Number -100.0 ~ 100.0
effect.blur Boolean Aplicar efeito 'blur' no brilho e sombra

shape_fill
Cor de fundo
shape_fill.type String box line line_fill theme_margin
shape_fill.enabled Boolean
shape_fill.color String Cor no formato hexadecimal (RGBA)
shape_fill.margin.top Number 0 ~ 100
shape_fill.margin.right Number 0 ~ 100
shape_fill.margin.bottom Number 0 ~ 100
shape_fill.margin.left Number 0 ~ 100
shape_fill.corner Number 0 ~ 100

shape_outline
Contorno
shape_outline.type String box line line_fill theme_margin
shape_outline.enabled Boolean
shape_outline.color String Cor no formato hexadecimal (RGBA)
shape_outline.outline_thickness Number 0 ~ 25
shape_outline.margin.top Number 0 ~ 100
shape_outline.margin.right Number 0 ~ 100
shape_outline.margin.bottom Number 0 ~ 100
shape_outline.margin.left Number 0 ~ 100
shape_outline.corner Number 0 ~ 100

comment
Comentário
comment.font_name String Nome da fonte
comment.bold Boolean Negrito
comment.italic Boolean Itálico
comment.relative_size Number tamanho relativo da fonte. 40 ~ 100
comment.color String Cor no formato hexadecimal

settings
Configurações
settings.uppercase Boolean Exibir o texto em maiúsculo
settings.line_break String Aplicar quebra de linha. system true false
Padrão: system

metadata
metadata.modified_time_millis Number Data de modificação do arquivo. (timestamp) v2.25.0+ read-only
Ver exemplo 
{
  "id": "123",
  "name": "",
  "background": {
    "type": "color",
    "id": "212121",
    "opacity": 100
  },
  "base_color": "FFFFFF",
  "font": {
    "name": "CMG Sans",
    "bold": true,
    "italic": false,
    "size": 10.0,
    "color": "F5F5F5",
    "line_spacing": 0.3,
    "char_spacing": 0
  },
  "align": {
    "horizontal": "center",
    "vertical": "middle",
    "margin": {
      "top": 3.0,
      "right": 3.0,
      "bottom": 3.0,
      "left": 3.0
    }
  },
  "effect": {
    "outline_color": "404040",
    "outline_weight": 0.0,
    "brightness_color": "C0C0C0",
    "brightness_weight": 0.0,
    "shadow_color": "404040",
    "shadow_x_weight": 0.0,
    "shadow_y_weight": 0.0,
    "blur": true
  },
  "shape_fill": {
    "type": "box",
    "enabled": false,
    "color": "000000",
    "margin": {
      "top": 5.0,
      "right": 30.0,
      "bottom": 10.0,
      "left": 30.0
    },
    "corner": 0
  },
  "shape_outline": {
    "type": "box",
    "enabled": false,
    "color": "000000",
    "outline_thickness": 10,
    "margin": {
      "top": 5.0,
      "right": 30.0,
      "bottom": 10.0,
      "left": 30.0
    },
    "corner": 0
  },
  "comment": {
    "font_name": "Arial",
    "bold": false,
    "italic": true,
    "relative_size": 100,
    "color": "A0A0A0"
  },
  "settings": {
    "uppercase": false,
    "line_break": "system",
    "transition_settings_id": null
  }
}

Background

Nome Tipo Descrição
id String ID do item
type String Tipo do item. Pode ser: theme my_video my_image video image
name String Nome do item
width Number (opcional)
height Number (opcional)
duration Number (opcional) Duração em milissegundos
tags Array<String> Lista de tags do item
bpm Number Valor BPM do item
midi Midi (opcional) Atalho MIDI do item
Ver exemplo 
{
  "id": "10",
  "type": "video",
  "name": "Hexagons",
  "duration": "29050",
  "width": "1280",
  "height": "720",
  "bpm": 0.0
}

Slide Description

Nome Tipo Descrição
name String Nome do item
tag String Nome curto do item
aliases Array<String> Lista com os nomes alternativos
font_color String Cor da fonte no formato hexadecimal
bg_color String Cor de fundo no formato hexadecimal
background Number ID do plano de fundo personalizado
midi Midi (opcional) Atalho MIDI do item
Ver exemplo 
{
  "name": "Chorus",
  "tag": "C",
  "font_color": "FFFFFF",
  "bg_color": "000080",
  "background": null,
  "midi": null
}

Item

Nome Tipo Descrição
id String ID do item
type String Tipo do item. Pode ser: title song verse text audio video image file announcement automatic_presentation countdown countdown_cp cp_text plain_text uri global_action api script module_action
name String Nome do item

Group

Nome Tipo Descrição
id String ID do item. (O mesmo valor que name). v2.25.0+
name String Nome do item read-only
songs Array<String> Lista dos IDs das músicas
add_chorus_between_verses Boolean v2.25.0+
hide_in_interface Boolean v2.25.0+
metadata.modified_time_millis Number Data de modificação do arquivo. (timestamp) v2.25.0+ read-only

Song Arrangement

Nome Tipo Descrição
name String Nome do item
sequence String Ordem dos slides (índice a partir do 1), separado por vírgula
collections Array<String>
Ver exemplo 
{
  "name": "",
  "sequence": "1,2,3,2,2"
}

Announcement

Nome Tipo Descrição
id String ID do item
name String Nome do item
text String Texto do anúncio
shuffle Boolean Exibir a lista de anúncios de forma aleatória v2.26.0+
archived Boolean Se o item está arquivado

Module

Nome Tipo Descrição
id String ID do item
jscommunity_id String ID global do item no repositório JSCommunity
info_id String ID definido para o item em function info()
Se o módulo for de origem do JSCommunity, o valor é o mesmo de jscommunity_id
name String Nome do módulo
active Boolean Se o módulo está ativo. active é um resultado de enabled_by_user && conditional_execution
enabled_by_user Boolean Se o módulo está ativado pelo usuário (checkbox na interface)
conditional_execution Boolean Se o módulo está ativado baseado nas possíveis execuções condicionais definidos a ele pelo usuário
show_panel Boolean Exibir o módulo no painel Módulos
available_in_main_window Boolean Módulo disponível para uso no painel da janela principal
available_in_bible_window Boolean Módulo disponível para uso no painel da janela da Bíblia
actions Array<[Module Action](#module- -action)> Ações públicas disponíveis para o módulo

Module Action

Nome Tipo Descrição
id String ID do item
name String Nome do item
description String Descrição do item
available_for String Lista de origens que a ação está disponível.
Se o campo estiver vazio, significa que a ação está disponível para todas as origens.
Valores disponíveis: ui trigger jslib_call jslib_open add_to_playlist
unavailable_for String Lista de origens que a ação está indisponível.
Valores disponíveis: ui trigger jslib_call jslib_open add_to_playlist
input Array<Object> Lista de parâmetros requeridos para execução da ação

Midi

Nome Tipo Descrição
code Number Código midi
velocity Number Velocidade/intensidade midi
Ver exemplo 
{
  "code": 80,
  "velocity": 20
}

Favorite Item

Nome Tipo Descrição
id String ID do item
name String Nome do item
folders Array<String> v2.26.0+
item Object v2.26.0+

Service

Nome Tipo Descrição
id String ID do item v2.25.0+
name String Nome do item
disabled Boolean Retorna true se o item estiver definido como desativado v2.25.0+
week String Semana. Pode ser: all first second third fourth last
day String Dia da semana. Pode ser: sun mon tue wed thu fri sat
hour Number Hora [0-23]
minute Number Minuto [0-59]
type String Tipo do item. Pode ser: service event
hide_week Array<String> Lista com as semanas ocultadas. Disponível se week=all
metadata.modified_time_millis Number Data de modificação do arquivo. (timestamp) v2.25.0+ read-only

Event

Nome Tipo Descrição
id String ID do item v2.25.0+
name String Nome do item
description String Descrição do item v2.25.0+
datetime String Data e hora no formato: YYYY-MM-DD HH:MM
datetime_millis String timestamp v2.24.0+ read-only
wallpaper String Caminho relativo do arquivo utilizado como papel de parede do evento
metadata.modified_time_millis Number Data de modificação do arquivo. (timestamp) v2.25.0+ read-only
metadata.service Service Culto ou evento regular que dá origem a esse evento. Pode ser null se for um evento criado individualmente. v2.25.0+ read-only

Schedule

Nome Tipo Descrição
type String Tipo da lista de reprodução. Pode ser: temporary, service, event
name String
datetime String Data e hora no formato: YYYY-MM-DD HH:MM
lyrics_playlist Array<Lyrics> Lista de letras
media_playlist Array<Item> Lista de mídias
responsible Member Integrante definido como responsável pelo evento
members Array<Object> Lista de integrantes
members.*.id String ID do integrante
members.*.name String Nome do integrante escalado
members.*.scheduled Boolean Se o integrande está escalado ou definido para uma função
roles Array<Object> Lista das funções na escala
roles.*.id String ID da função
roles.*.name String Nome da função
roles.*.member Member Integrante escalado para a função
notes String Anotações v2.21.0+
metadata.modified_time_millis Number Data de modificação do arquivo. (timestamp) v2.25.0+ read-only
metadata.event Event Evento que dá origem a essa lista de reprodução. Pode ser null se type=temporary. v2.25.0+ read-only
Ver exemplo 
{
  "type": "temporary",
  "name": "",
  "datetime": "2024-01-16 20:00",
  "lyrics_playlist": [
    {
      "id": 1,
      "title": "Title 1",
      "artist": "",
      "author": "",
      "...": ".."
    },
    {
      "id": 2,
      "title": "Title 2",
      "artist": "",
      "author": "",
      "...": ".."
    },
    {
      "id": 3,
      "title": "Title 3",
      "artist": "",
      "author": "",
      "...": ".."
    }
  ],
  "media_playlist": [
    {
      "id": "a",
      "type": "video",
      "name": "file.mp4"
    },
    {
      "id": "b",
      "type": "audio",
      "name": "file.mp3"
    },
    {
      "id": "c",
      "type": "image",
      "name": "file.jpg"
    }
  ],
  "responsible": null,
  "notes": ""
}

Team

Nome Tipo Descrição
id String ID do item
name String Nome do item
description String Descrição do item
metadata.modified_time_millis Number Data de modificação do arquivo. (timestamp) v2.25.0+ read-only

Member

Nome Tipo Descrição
id String ID do item
name String Nome do item
disabled Boolean Retorna true se o item estiver definido como desativado v2.25.0+
skills String Habilidades
roles Array<Role> Funções
metadata.modified_time_millis Number Data de modificação do arquivo. (timestamp) v2.25.0+ read-only

Role

Nome Tipo Descrição
id String ID do item
name String Nome do item
disabled Boolean Retorna true se o item estiver definido como desativado v2.25.0+
team Team Time
metadata.modified_time_millis Number Data de modificação do arquivo. (timestamp) v2.25.0+ read-only

Automatic Presentation

Nome Tipo Descrição
name String Nome do item
duration Number Duração em milissegundos
starts_with String Valores aceitos: title blank
song Lyrics
timeline Array<Object> Informação sobre início e duração de cada slide da apresentação
timeline.*.number Number number >= 0
timeline.*.start Number Tempo inicial da apresentação em milissegundos
timeline.*.end Number Tempo final da apresentação em milissegundos
timeline.*.duration Number Duração em milissegundos

Automatic

Nome Tipo Descrição
seconds Number Tempo que cada item ficará sendo apresentado
repeat Boolean true para ficar repetindo a apresentação (voltar para o primeiro item após o último)

Presentation Slide Info

Nome Tipo Descrição
number Number Número do slide (começa em 1)
text String Texto do slide
theme_id String ID do tema do slide
slide_description String (opcional) Nome da descrição do slide. Disponível se for uma apresentação de música.
preview String (opcional) Imagem no formato base64

Trigger Item

Nome Tipo Descrição
id String (opcional) ID do item
when String displaying closing change event
item String Tipo do item. Pode ser:
when=displaying: any_song any_text any_verse any_announcement any_audio any_video any_image any_automatic_presentation any_song_slide any_text_slide any_ppt_slide any_theme any_background any_title_subitem any_webcam any_audio_folder any_video_folder any_image_folder any_ppt any_countdown any_automatic_presentation_slide f8 f9 f10

when=closing: any_song any_text any_verse any_announcement any_audio any_video any_image any_automatic_presentation any_webcam any_audio_folder any_video_folder any_image_folder any_ppt f8 f9 f10

when=change: countdown_seconds_public countdown_seconds_communication_panel timer_seconds_communication_panel wallpaper wallpaper_service stage playlist bpm hue player_volume player_mute player_pause player_repeat player_list_or_single player_shuffle bible_version_1 bible_version_2 bible_version_3 bible_any_version

when=event: new_message_chat verse_presentation_changed playlist_changed file_modified player_progress draw_lots_item_drawn
action Function Ação que será executada.
function(obj) { /* */ }
Conteúdo de obj de acordo com o tipo do item:
any_song  any_text  any_verse  any_announcement  any_audio  any_video  any_image  any_automatic_presentation  any_song_slide  any_text_slide  any_ppt_slide  any_theme  any_background  any_title_subitem  any_webcam  any_audio_folder  any_video_folder  any_image_folder  any_ppt  any_countdown  any_automatic_presentation_slide  f8  f9  f10  new_message_chat  verse_presentation_changed  playlist_changed  file_modified  player_progress  draw_lots_item_drawn

Todos os itens de when=change contém: obj.id obj.name obj.old_value obj.new_value
name String (opcional) Nome do item. Valor compatível para exibição no JavaScript Monitor v2.23.0+
filter Object (opcional) Executar ação somente se o objeto que gerou o gatilho corresponder ao objeto filter v2.24.0+
Ver exemplo 
{
  "id": "",
  "when": "displaying",
  "item": "any_song",
  "action": function(obj) { /* TODO */ },
  "name": "name"
}

Scheduled Task

Nome Tipo Descrição
id String ID do item
enabled Boolean
time String hora no formato: HH:MM:SS
days Array<String> Valores aceitos: sun mon tue wed thu fri sat
item Object
tags Array<String>

Rule

Nome Tipo Descrição
id String ID do item
enabled Boolean
description String
type Object
type.id String Valores aceitos: none rule_group_model rule_group javascript javascript_model jscommunity services events date time datetime day_of_week day_of_month hour_of_day day_of_week_in_month runtime_environment
type.name String
type.settings_type String native custom

type.settings_type=native
type.native_type String Valores disponíveis: unknown string number date time datetime
type.operator String Valores disponíveis: equals is_between contains greater greater_or_equals less less_or_equals matches_regex not_equals is_not_between not_contains not_matches_regex
data Object

type.settings_type=native
data.values Array<String> Valores utilizados para as comparações
O array pode conter 1 ou mais itens, depende de type.operator
metadata.modified_time_millis Number Data de modificação do arquivo. (timestamp) v2.25.0+ read-only

Rule Group

Nome Tipo Descrição
id String ID do item
name String Nome do item
match_mode String any all
rules Array<Rule> Regras
metadata.modified_time_millis Number Data de modificação do arquivo. (timestamp) v2.25.0+ read-only

Play Media Settings

Configurações para execução da mídia

Nome Tipo Descrição
volume Number Altera o volume do player
repeat Boolean Altera a opção repetir
shuffle Boolean Altera a opção aleatório
start_time String Tempo inicial para execução no formato SS, MM:SS ou HH:MM:SS
stop_time String Tempo final para execução no formato SS, MM:SS ou HH:MM:SS
Ver exemplo 
{
  "volume": "80",
  "repeat": true,
  "shuffle": false,
  "start_time": "00:30",
  "stop_time": "02:00"
}

Display Settings

Configurações de exibição

Nome Tipo Descrição
id String ID do item. public screen_2 screen_3 screen_? stream_image stream_html_1 stream_html_2 stream_html_3
name String Nome do item
screen String Coordenada x,y da tela definida como público. Disponível apenas para id=public
stage_view StageView Configurações da visão do palco. (Indisponível para tela público)
slide_info SlideAdditionalInfo Informações adicionais do slide
slide_translation String Nome da tradução
slide_translation_custom_settings TranslationCustomSettings Configurações customizadas da tradução
bible_version_tab Number Número da aba (1, 2 ou 3) da tradução da Bíblia exibida na tela, conforme traduções carregadas na janela da Bíblia
margin Object Margens definidas na opção Editar posição da tela. margin.top, margin.right, margin.bottom, margin.left
area Rectangle Área da tela com as margens aplicadas (se disponível)
total_area Rectangle Área total da tela no sistema
hide Boolean Ocultar a tela
show_items Object Define os tipos de apresentação que serão exibidos (disponível apenas para telas de transmissão - imagem e html)
show_items.lyrics Boolean Letra de música
show_items.text Boolean Texto
show_items.verse Boolean Versículo
show_items.image Boolean Imagem
show_items.alert Boolean Alerta
show_items.announcement Boolean Anúncio
media_player.show Boolean Exibir VLC Player v2.20.0+
media_player.margin Rectangle Margem para exibição dos vídeos pelo VLC Player v2.20.0+
html_settings StageViewHTMLSettings Configurações HTML. Disponível somente para as saídas HTML.
Ver exemplo 
{
  "id": "public",
  "name": "Público",
  "screen": "1920,0",
  "slide_info": {
    "info_1": {
      "show_page_count": false,
      "show_slide_description": false,
      "horizontal_align": "right",
      "vertical_align": "bottom"
    },
    "info_2": {
      "show": false,
      "layout_row_1": "<title>< (%author_or_artist%)>",
      "layout_text_row_1": "",
      "horizontal_align": "right",
      "vertical_align": "bottom"
    },
    "font": {
      "name": null,
      "bold": null,
      "italic": null,
      "color": null
    },
    "height": 7,
    "paint_theme_effect": true
  },
  "slide_translation": null,
  "slide_translation_custom_settings": {
    "translation_1": {
      "name": "default",
      "style": "",
      "prefix": "",
      "suffix": ""
    },
    "translation_2": null,
    "translation_3": null,
    "translation_4": null,
    "merge": true,
    "uppercase": false,
    "blank_line_height": 40
  },
  "margin": {
    "top": 0.0,
    "right": 0.0,
    "bottom": 0.0,
    "left": 0.0
  },
  "area": {
    "x": 1920,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "total_area": {
    "x": 1920,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "hide": false,
  "media_player": {
    "margin": {
      "top": 0.0,
      "right": 0.0,
      "bottom": 0.0,
      "left": 0.0
    },
    "area": {
      "x": 1920,
      "y": 0,
      "width": 1920,
      "height": 1080
    }
  }
}

Display Settings Preset

Configurações de exibição (Modelo predefinido)

Nome Tipo Descrição
id String ID do item
name String Nome do item
settings DisplaySettings Configurações

Transition Effect Settings

Nome Tipo Descrição
type String Tipo de efeito. Pode ser: random fade slide accordion linear_fade zoom curtain
enabled Boolean Se está ativado ou desativado
duration Number Duração total da transição (em milissegundos) 200 ~ 2400
only_area_within_margin Number Realiza o efeito de transição apenas dentro da margem definida no Tema. (Disponível somente para transição de texto)

type=fade
merge Object Valores aceitos: true, false
division_point Object Valores aceitos: min: 10, max: 100
increase_duration_blank_slides Object Valores aceitos: true, false

type=slide
direction Object Valores aceitos: random, left, up
slide_move_type Object Valores aceitos: random, move_new, move_old, move_both

type=accordion
direction Object Valores aceitos: random, horizontal, vertical

type=linear_fade
direction Object Valores aceitos: random, horizontal, vertical, up, down, left, right
distance Object Valores aceitos: min: 5, max: 90
fade Object Valores aceitos: min: 2, max: 90

type=zoom
zoom_type Object Valores aceitos: random, increase, decrease
directions Object Valores aceitos: {
  top_left: boolean,
  top_center: boolean,
  top_right: boolean,
  middle_left: boolean,
  middle_center: boolean,
  middle_right: boolean,
  bottom_left: boolean,
  bottom_center: boolean,
  bottom_right: boolean
}

type=curtain
direction Object Valores aceitos: random, horizontal, vertical
direction_lines Object Valores aceitos: random, down_right, up_left, alternate
slide_move_type Object Valores aceitos: random, new, old, both

type=random
random_enabled_types Object Valores aceitos: {
  fade: boolean,
  slide: boolean,
  accordion: boolean,
  linear_fade: boolean,
  zoom: boolean,
  curtain: boolean
}
Ver exemplo 
{
  "enabled": true,
  "type": "fade",
  "duration": 500,
  "only_area_within_margin": false,
  "merge": false,
  "division_point": 30,
  "increase_duration_blank_slides": false
}

Transition Effect Template Settings

É um objeto com os mesmos parâmetros disponíveis em Transition Effect Settings, porém com alguns parâmetros adicionais

Nome Tipo Descrição
id String ID do item
name String Nome do item
metadata.modified_time_millis Number Data de modificação do arquivo. (timestamp) read-only

Bible Settings

Nome Tipo Descrição
tab_version_1 String Versão da Bíblia definida na primeira aba
tab_version_2 String Versão da Bíblia definida na segunda aba
tab_version_3 String Versão da Bíblia definida na terceira aba
show_x_verses Number Quantidade de versículos exibidos na projeção
uppercase Boolean Exibir o texto do versículo em maiúsculo
show_only_reference Boolean Exibir somente a referência do versículo
show_two_versions Boolean deprecated Substituído por: show_second_version show_third_version
Exibir duas versões.
show_second_version Boolean Exibir segunda versão v2.22.0+
show_third_version Boolean Exibir terceira versão v2.22.0+
book_panel_type String Tipo de visualização dos livros da Bíblia grid list
book_panel_order String Tipo de ordenação dos livros da Bíblia
book_panel_order_available_items Array<String>
multiple_verses_separator_type String Tipo de separação na exibição de múltiplos versículos. Pode ser: no_line_break, single_line_break, double_line_break, solid_separator_line
multiple_versions_separator_type String Tipo de separação na exibição de múltiplas versões. Pode ser: no_line_break, single_line_break, double_line_break, solid_separator_line v2.22.0+
versification Boolean Aplicar mapeamento de versículos
theme Object ID do Tema de exibição para as diferentes telas do sistema
theme.public String
theme.screen_n String n >= 2
Ver exemplo 
{
  "tab_version_1": "pt_???",
  "tab_version_2": "es_???",
  "tab_version_3": "en_???",
  "show_x_verses": 1,
  "uppercase": false,
  "show_only_reference": false,
  "show_two_versions": false,
  "show_second_version": false,
  "show_third_version": false,
  "book_panel_type": "grid",
  "book_panel_order": "automatic",
  "book_panel_order_available_items": [
    "automatic",
    "standard",
    "ru",
    "tyv"
  ],
  "multiple_verses_separator_type": "double_line_break",
  "multiple_versions_separator_type": "double_line_break",
  "versification": true,
  "theme": {
    "public": 123,
    "screen_n": null
  }
}

Font Settings

Nome Tipo Descrição
font_name String (opcional) Nome da fonte Padrão: null
bold Boolean (opcional) Negrito Padrão: null
italic Boolean (opcional) Itálico Padrão: null
color String (opcional) Cor em hexadecimal Padrão: null

Stage View

Nome Tipo Descrição
enabled Boolean Visão do palco ativada
preview_mode String Modo de visualização das letras. Opções disponíveis:
CURRENT_SLIDE
FIRST_LINE_OF_THE_NEXT_SLIDE_WITH_SEPARATOR
FIRST_LINE_OF_THE_NEXT_SLIDE_WITHOUT_SEPARATOR
NEXT_SLIDE
CURRENT_AND_NEXT_SLIDE
ALL_SLIDES
uppercase Boolean Exibir em maiúsculo
remove_line_break Boolean Remover quebra de linha
show_comment Boolean Exibir comentários
show_advanced_editor Boolean Exibir edições avançadas
show_communication_panel Boolean Exibir conteúdo do painel de comunicação
show_next_image Boolean Exibir imagem seguinte v2.21.0+
custom_theme String ID do tema personalizado utilizado nas apresentações
apply_custom_theme_to_bible Boolean Utilizar o tema personalizado nos versículos
apply_custom_theme_to_text Boolean Utilizar o tema personalizado nos textos
apply_custom_theme_to_quick_presentation Boolean Utilizar o tema personalizado na opção Apresentação Rápida v2.21.0+
Ver exemplo 
{
  "enabled": false,
  "preview_mode": "FIRST_LINE_OF_THE_NEXT_SLIDE_WITH_SEPARATOR",
  "uppercase": false,
  "uppercase_mode": "text_and_comment",
  "remove_line_break": false,
  "show_comment": true,
  "show_advanced_editor": false,
  "show_communication_panel": true,
  "show_next_image": false,
  "custom_theme": null,
  "apply_custom_theme_to_bible": true,
  "apply_custom_theme_to_text": true,
  "apply_custom_theme_to_quick_presentation": false
}

Slide Additional Info

Nome Tipo Descrição
info_1 Object
info_1.show_page_count Boolean Exibir contador de slides
info_1.show_slide_description Boolean Exibir descrição do slide (coro, por exemplo)
info_1.horizontal_align String Alinhamento horizontal da informação no slide. left, center, right
info_1.vertical_align String Alinhamento vertical da informação no slide. top, bottom
info_2 Object
info_2.show Boolean
info_2.layout_row_1 String Layout da informação da primeira linha type=song Slide Additional Info Layout
info_2.layout_row_2 String (opcional) Layout da informação da segunda linha type=song Slide Additional Info Layout
info_2.layout_text_row_1 String Layout da informação da primeira linha type=text Slide Additional Info Layout v2.24.0+
info_2.layout_text_row_2 String (opcional) Layout da informação da primeira linha type=text Slide Additional Info Layout v2.24.0+
info_2.horizontal_align String Alinhamento horizontal da informação no slide. left, center, right
info_2.vertical_align String Alinhamento vertical da informação no slide. top, bottom
font Object
font.name String Nome da fonte. Se for null, utiliza a fonte padrão do tema.
font.bold Boolean Negrito. Se for null, utiliza a configuração padrão do tema
font.italic Boolean Itálido. Se for null, utiliza a configuração padrão do tema
font.color String Cor da fonte em hexadecimal. Se for null, utiliza a cor da fonte padrão do tema
height Number Altura em porcentagem em relação à altura do slide 4 ~ 15
paint_theme_effect String Renderizar o texto com os efeitos contorno, brilho e sombra do tema, se disponível
Ver exemplo 
{
  "info_1": {
    "show_page_count": false,
    "show_slide_description": false,
    "horizontal_align": "right",
    "vertical_align": "bottom"
  },
  "info_2": {
    "show": false,
    "layout_row_1": "<title>< (%author_or_artist%)>",
    "layout_text_row_1": "",
    "horizontal_align": "right",
    "vertical_align": "bottom"
  },
  "font": {
    "name": null,
    "bold": null,
    "italic": null,
    "color": null
  },
  "height": 7,
  "paint_theme_effect": true
}

Stage View HTML Settings

Nome Tipo Descrição
font Object
font.name String Nome da fonte
font.bold Boolean Negrito
font.size Number Tamanho relativo da fonte 2 ~ 50
font.color String Cor no formato hexadecimal
background_color String Cor no formato hexadecimal
horizontal_align String left center right
vertical_align String top middle bottom
block_line_break Boolean Bloquear quebra de linha
transparent_background Boolean Cor de fundo transparente
show_page_count Boolean Exibir contador de página
image_format String jpg png
image_resolution String 960x540 1280x720 1440x810 1600x900 1920x1080
show_bible_version Boolean Valores aceitos: none full full_single_line abbreviated abbreviated_end_of_text
add_hly_data Boolean Adicionar tags avançadas na página
alert Object
alert.font Object
alert.font.name String Nome da fonte
alert.font.bold Boolean Negrito
alert.font.italic Boolean Itálico
alert.font.size Number Tamanho relativo da fonte. 10 ~ 20
alert.font.color String Cor no formato hexadecimal
alert.background_color String Cor no formato hexadecimal
alert.velocity Number Velocidade do alerta 5 ~ 100
comment Object
comment.font Object
comment.font.name String Nome da fonte
comment.font.bold Boolean Negrito
comment.font.italic Boolean Itálico
comment.font.size Number Tamanho relativo da fonte 40 ~ 100
comment.font.color String Cor no formato hexadecimal
Ver exemplo 
{
  "font": {
    "name": "Arial",
    "bold": false,
    "size": 15.0,
    "color": "FAFAFA"
  },
  "background_color": "000000",
  "horizontal_align": "center",
  "vertical_align": "middle",
  "block_line_break": false,
  "transparent_background": true,
  "show_page_count": false,
  "image_format": "jpg",
  "image_resolution": "1440x810",
  "show_bible_version": "none",
  "add_hly_data": false,
  "alert": {
    "font": {
      "name": "Arial",
      "bold": false,
      "italic": false,
      "size": 15.0,
      "color": "FAFAFA"
    },
    "background_color": "000000",
    "velocity": 40
  },
  "comment": {
    "font": {
      "name": "Arial",
      "bold": false,
      "italic": true,
      "size": 100.0,
      "color": "FF7000"
    }
  }
}

Rectangle

Nome Tipo Descrição
x Number
y Number
width Number
height Number

Custom Message

Nome Tipo Descrição
id String ID do item
name String Nome do item
message_model String Mensagem sem preenchimento
message_example String Mensagem de exemplo com o nome dos parâmetros preenchidos
variables Array<CustomMessageParam> Parâmetros da mensagem
Ver exemplo 
{
  "id": "123",
  "name": "Chamar pessoa",
  "message_model": "   , favor comparecer  .",
  "message_example": "função nome, favor comparecer local.",
  "variables": [
    {
      "position": 0,
      "name": "função",
      "only_number": false,
      "uppercase": false,
      "suggestions": [
        "Diácono",
        "Presbítero",
        "Pastor",
        "Professor",
        "Ministro"
      ]
    },
    {
      "position": 2,
      "name": "nome",
      "only_number": false,
      "uppercase": false
    },
    {
      "position": 22,
      "name": "local",
      "only_number": false,
      "uppercase": false,
      "suggestions": [
        "ao estacionamento",
        "ao hall de entrada",
        "à mesa de som",
        "ao berçário"
      ]
    }
  ]
}

Custom Message Param

Nome Tipo Descrição
position Number Posição do parâmetro na mensagem (em número de caracteres)
name String Nome do item
only_number Boolean Parâmetro aceita somente números
uppercase Boolean Parâmetro exibido sempre em maiúsculo
suggestions Array<String> (opcional) Lista com valores padrões para o parâmetro
Ver exemplo 
{
  "position": 0,
  "name": "",
  "only_number": false,
  "uppercase": false
}

Quiz Group

Nome Tipo Descrição
name String Nome do item
questions Array<QuizQuestion>
settings QuizSettings
Ver exemplo 
{
  "name": "",
  "questions": {
    "name": "",
    "title": "...",
    "alternatives": [
      "Item 1",
      "Item 2",
      "Item 3"
    ],
    "correct_alternative_number": 2,
    "source": ""
  },
  "settings": {
    "correct_answer_color_font": "00796B",
    "correct_answer_color_background": "CCFFCC",
    "incorrect_answer_color_font": "721C24",
    "incorrect_answer_color_background": "F7D7DB",
    "question_and_alternatives_different_slides": false,
    "display_alternatives_one_by_one": true,
    "alternative_separator_char": ".",
    "alternative_char_type": "alpha"
  }
}

Quiz Question

Nome Tipo Descrição
name String Nome do item v2.24.0+
title String Pergunta
alternatives Array<String> Alternativas
correct_alternative_number Number (opcional) Número da alternativa correta. Começa em 1 Padrão: 1
source String (opcional) Fonte da resposta
Ver exemplo 
{
  "name": "",
  "title": "...",
  "alternatives": [
    "Item 1",
    "Item 2",
    "Item 3"
  ],
  "correct_alternative_number": 2,
  "source": ""
}

Quiz Settings

Nome Tipo Descrição
correct_answer_color_font String (opcional) Cor da fonte para a resposta correta
correct_answer_color_background String (opcional) Cor de fundo para a resposta correta
incorrect_answer_color_font String (opcional) Cor da fonte para a resposta incorreta
incorrect_answer_color_background String (opcional) Cor de fundo para a resposta incorreta
question_and_alternatives_different_slides Boolean (opcional) Exibir a pergunta e as alternativas em slides separados Padrão: false
display_alternatives_one_by_one Boolean (opcional) Exibir as alternativas uma a uma Padrão: true
alternative_char_type String (opcional) Tipo de caractere para listar as alternativas number (1, 2, 3...) alpha (A, B, C...) Padrão: 'alpha'
alternative_separator_char String (opcional) Caractere separador. Valores permitidos: . ) - : Padrão: '.'
Ver exemplo 
{
  "correct_answer_color_font": "00796B",
  "correct_answer_color_background": "CCFFCC",
  "incorrect_answer_color_font": "721C24",
  "incorrect_answer_color_background": "F7D7DB",
  "question_and_alternatives_different_slides": false,
  "display_alternatives_one_by_one": true,
  "alternative_separator_char": ".",
  "alternative_char_type": "alpha"
}

Quick Presentation Slide

Nome Tipo Descrição
text String Texto do slide
theme ThemeFilter (opcional) Filtrar tema selecionado para exibição
custom_theme Theme (opcional) Tema personalizado utilizado para exibir o texto
translations Translations (opcional)
duration Number (opcional) Duração do slide para uso em apresentações automáticas
Ver exemplo 
{
  "text": "text",
  "duration": 3,
  "translations": {
    "key1": "value1",
    "key2": "value2"
  },
  "theme": {
    "name": "...",
    "edit": {
      "font": {
        "name": "Arial",
        "size": 10,
        "bold": true,
        "color": "FFFFFF"
      },
      "background": {
        "type": "color",
        "id": "000000"
      }
    }
  }
}

Theme Filter

Nome Tipo Descrição
id String (opcional) ID do tema ou plano de fundo
name String (opcional) Nome do tema ou plano de fundo
edit Theme (opcional) Configurações para modificar o Tema selecionado para exibição
Ver exemplo 
{
  "name": "...",
  "edit": {
    "font": {
      "name": "Arial",
      "size": 10,
      "bold": true,
      "color": "FFFFFF"
    },
    "background": {
      "type": "color",
      "id": "000000"
    }
  }
}

Translations

Conjunto chave/valor

Nome Tipo Descrição
??? String Valor traduzido do item, onde o nome do parâmetro ??? é o nome da tradução
??? String
... String
Ver exemplo 
{
  "key1": "value1",
  "key2": "value2"
}

Wallpaper Settings

Nome Tipo Descrição
enabled Boolean Exibir papel de parede
fill_color String Cor em hexadecimal definida na opção preencher.
clock ClockSettings Configurações do relógio
Ver exemplo 
{
  "enabled": null,
  "fill_color": null,
  "clock": {
    "enabled": false,
    "font_name": "",
    "bold": false,
    "italic": false,
    "color": "FF0000",
    "background": "000000",
    "height": 12,
    "position": "top_right",
    "corner": 0
  }
}

Clock Settings

Nome Tipo Descrição
enabled Boolean
font_name String Nome da fonte
bold Boolean Negrito
italic Boolean Itálico
color String Cor no formato hexadecimal (RGBA)
background String Cor no formato hexadecimal (RGBA)
height Number Valor em porcentagem baseado na altura da linha.
Valores aceitos: 6 7 8 9 10 12 14 15 16 18 20 25 30 35 40
position Boolean Valores aceitos: top_left top_center top_right middle_left middle_center middle_right bottom_left bottom_center bottom_right
corner Number 0 ~ 100
Ver exemplo 
{
  "enabled": false,
  "font_name": "",
  "bold": false,
  "italic": false,
  "color": "FF0000",
  "background": "000000",
  "height": 12,
  "position": "top_right",
  "corner": 0
}

Bible Book List

Nome Tipo Descrição
id String ID do item
name String Nome em inglês
language String ISO 639 two-letter language code v2.24.0+
alt_name String Nome no próprio idioma definido em language. Pode ser null. v2.24.0+
Ver exemplo 
{
  "id": "en",
  "name": "English",
  "language": "en",
  "alt_name": "English"
}

Bible Book Info

Nome Tipo Descrição
id String ID do livro 01 ~ 66
name String Nome do livro
abbrev String Abreviação do livro
usfx_code String v2.24.0+
Ver exemplo 
{
  "id": "01",
  "name": "Genesis",
  "abbrev": "Gn"
}

Verse Reference Group

Nome Tipo Descrição
reference String Referências. Exemplo: João 3:16 ou Rm 12:2 ou Gn 1:1-3 Sl 23.1
ids Array<String> Exemplo: ['19023001', '43003016', '45012002']
verses Array<VerseReference> Lista detalhada das referências
Ver exemplo 
{
  "reference": "Ps 23.1-2",
  "ids": [
    "19023001",
    "19023002"
  ],
  "verses": [
    {
      "id": "19023001",
      "book": 19,
      "chapter": 23,
      "verse": 1,
      "reference": "Psalms 23.1"
    },
    {
      "id": "19023002",
      "book": 19,
      "chapter": 23,
      "verse": 2,
      "reference": "Psalms 23.2"
    }
  ]
}

Verse Reference

Nome Tipo Descrição
id String ID do item
book Number ID do livro 1 ~ 66
chapter Number Capítulo
verse Number Versículo
reference String
Ver exemplo 
{
  "id": "19023001",
  "book": 19,
  "chapter": 23,
  "verse": 1,
  "reference": "Psalms 23.1"
}

Translation Custom Settings

Configurações customizadas da tradução

Nome Tipo Descrição
translation_1 TranslationCustomSettingsItem
translation_2 TranslationCustomSettingsItem
translation_3 TranslationCustomSettingsItem
translation_4 TranslationCustomSettingsItem
merge Boolean
uppercase Boolean
blank_line_height Number 0 ~ 100
Ver exemplo 
{
  "translation_1": {
    "name": "default",
    "style": "",
    "prefix": "",
    "suffix": ""
  },
  "translation_2": null,
  "translation_3": null,
  "translation_4": null,
  "merge": false,
  "uppercase": false,
  "blank_line_height": 0
}

Translation Custom Settings Item

Configurações customizadas da tradução (item)

Nome Tipo Descrição
name String Nome da tradução. Utilize 'default' para usar o texto original.
style String Formatação customizada do texto. Styled Text
prefix String Texto adicionado no início de cada linha
suffix String Texto adicionado no final de cada linha
Ver exemplo 
{
  "name": "default",
  "style": "",
  "prefix": "",
  "suffix": ""
}

Styled Model

Nome Tipo Descrição
key String
properties Object Conjunto chave/valor
Ver exemplo 
{
  "key": "title",
  "properties": {
    "b": "true",
    "size": "120"
  }
}

Initial Slide Settings

Nome Tipo Descrição
display_mode String Valores aceitos: title_author title_author_or_artist title title_artist blank remove
uppercase Boolean
automatic_line_break Boolean
underlined_title Boolean
title_font_relative_size Number 40 ~ 160
author_or_artist_font_relative_size Number 40 ~ 160
keep_ratio Boolean
remove_final_slide Boolean
Ver exemplo 
{
  "display_mode": "title_author_or_artist",
  "uppercase": false,
  "automatic_line_break": true,
  "underlined_title": true,
  "title_font_relative_size": 130,
  "author_or_artist_font_relative_size": 110,
  "keep_ratio": true,
  "remove_final_slide": false
}

Copyright Settings

Nome Tipo Descrição
display_mode String Valores aceitos: disabled first_slide all_slides last_slide display_for_x_seconds
seconds String Disponível se display_mode=display_for_x_seconds
Valores aceitos: 5 10 15 20 30 60 120
layout String Valores aceitos: t,a t;a t,a;c t;a;c
font.name String Nome da fonte
font.bold String Negrito
font.italic String Itálico
font.color String Cor no formato hexadecimal
line_height Number 2.0 ~ 10.0
align String Valores aceitos: left center right
opaticy Number 30 ~ 100
position String Valores aceitos: top_left top_center top_right bottom_left bottom_center bottom_right
Ver exemplo 
{
  "display_mode": "all_slides",
  "layout": "t;a;c",
  "font": {
    "name": "Arial",
    "bold": true,
    "italic": true,
    "color": "FFFF00"
  },
  "line_height": 3.0,
  "align": "left",
  "opacity": 70,
  "position": "top_left"
}

Image Presentation Settings

Nome Tipo Descrição
adjust_type String adjust extend
blur Object Utilizado somente se: adjust_type=adjust
blur.enabled Boolean
blur.radius Number 1 ~ 20
blur.times Number 1 ~ 10
blur.opacity Number 10 ~ 100
Ver exemplo 
{
  "adjust_type": "adjust",
  "blur": {
    "enabled": true,
    "radius": 8,
    "times": 5,
    "opacity": 70
  }
}

Non-Latin Alphabet Support Settings

Nome Tipo Descrição
enabled Boolean
font_or_script String system lucida_sans arial_unicode_ms nirmala_ui arabic armenian bengali bopomofo cyrillic devanagari georgian greek gujarati gurmukhi han hangul hebrew hiragana kannada katakana lao malayalam meetei_mayek ol_chiki oriya sinhala tamil telugu thai tibetan
Ver exemplo 
{
  "enabled": false,
  "font_or_script": "system"
}

Global Settings

Nome Tipo Descrição
fade_in_out_enabled Boolean
fade_in_out_duration Number 200 ~ 1500
show_history_main_window Boolean
show_favorite_bar_main_window Boolean
show_favorite_bar_bible_window Boolean
show_module_bar_main_window Boolean
show_module_bar_bible_window Boolean
show_automatic_presentation_tab_main_window Boolean
text_editor_font_name String
show_comment_main_window Boolean
show_comment_presentation_footer Boolean
show_comment_app Boolean
initial_slide InitialSlideSettings
copyright Object Conjunto chave/valor
chave: public screen_2 screen_3 screen_? stream_image
valor: CopyrightSettings
image_presentation ImagePresentationSettings
black_screen_color String Cor no formato hexadecimal
swap_f5 Boolean
stage_view_modifier_enabled Boolean
disable_modifier_automatically Boolean
automatic_presentation_theme_chooser Boolean
automatic_presentation_execution_delay String Valores aceitos: 0 1000 1500 2000 2500 3000
skip_slide_transition_if_equals Boolean
non_latin_alphabet_support NonLatinAlphabetSupportSettings
public_screen_expand_width Number 0 ~ 3840
public_screen_rounded_border Boolean
public_screen_rounded_border_size Number 0 ~ 540
display_custom_formatting_enabled Boolean
display_custom_background_enabled Boolean
display_advanced_editor_enabled Boolean
display_saved_theme_for_lyrics_enabled Boolean v2.26.0+
display_saved_theme_for_text_enabled Boolean v2.26.0+
advanced_editor_block_line_break Boolean
slide_description_repeat_description_for_sequence Boolean
standardize_automatic_line_break Boolean
allow_main_window_and_bible_window_simultaneously Boolean
preferential_arrangement_collection String
Ver exemplo 
{
  "fade_in_out_enabled": true,
  "fade_in_out_duration": 500,
  "show_history_main_window": true,
  "show_favorite_bar_main_window": true,
  "show_favorite_bar_bible_window": false,
  "show_module_bar_main_window": false,
  "show_module_bar_bible_window": false,
  "show_automatic_presentation_tab_main_window": false,
  "text_editor_font_name": "Lucida Sans Unicode",
  "show_comment_main_window": false,
  "show_comment_presentation_footer": true,
  "show_comment_app": true,
  "initial_slide": {
    "display_mode": "title_author_or_artist",
    "uppercase": false,
    "automatic_line_break": true,
    "underlined_title": true,
    "title_font_relative_size": 130,
    "author_or_artist_font_relative_size": 110,
    "keep_ratio": true,
    "remove_final_slide": false
  },
  "copyright": {
    "display_mode": "all_slides",
    "layout": "t;a;c",
    "font": {
      "name": "Arial",
      "bold": true,
      "italic": true,
      "color": "FFFF00"
    },
    "line_height": 3.0,
    "align": "left",
    "opacity": 70,
    "position": "top_left"
  },
  "image_presentation": {
    "adjust_type": "adjust",
    "blur": {
      "enabled": true,
      "radius": 8,
      "times": 5,
      "opacity": 70
    }
  },
  "black_screen_color": "1E1E1E",
  "swap_f5": false,
  "stage_view_modifier_enabled": true,
  "disable_modifier_automatically": true,
  "automatic_presentation_theme_chooser": true,
  "automatic_presentation_execution_delay": 0,
  "skip_slide_transition_if_equals": false,
  "non_latin_alphabet_support": {
    "enabled": false,
    "font_or_script": "system"
  },
  "public_screen_expand_width": 0,
  "public_screen_rounded_border": false,
  "public_screen_rounded_border_size": 100,
  "display_custom_formatting_enabled": true,
  "display_custom_background_enabled": true,
  "display_advanced_editor_enabled": true,
  "display_saved_theme_for_lyrics_enabled": true,
  "display_saved_theme_for_text_enabled": true,
  "advanced_editor_block_line_break": true,
  "slide_description_repeat_description_for_sequence": true,
  "standardize_automatic_line_break": false,
  "allow_main_window_and_bible_window_simultaneously": false,
  "preferential_arrangement_collection": ""
}

AddItem

Nome Tipo Descrição
type String Tipo do item. Pode ser: title song verse text audio video image file announcement automatic_presentation countdown countdown_cp cp_text plain_text uri global_action api script module_action

AddItemTitle

Nome Tipo Descrição
type String title
name String Nome do item
background_color String (opcional) Cor de fundo em hexadecimal, exemplo: 000080
collapsed Boolean (opcional) Padrão: false
Ver exemplo 
{
  "type": "title",
  "name": "Exemplo",
  "background_color": "0000FF",
  "collapsed": false
}

AddItemSong

Nome Tipo Descrição
type String song
id String ID do item
Ver exemplo 
{
  "type": "song",
  "id": "123"
}

AddItemVerse

id, ids ou references

Nome Tipo Descrição
type String verse
id String (opcional) Para exibir um versículo. ID do item no formato LLCCCVVV.
Exemplo: '19023001' (livro 19, capítulo 023, versículo 001)
ids Array<String> (opcional) Para exibir uma lista de versículos. Lista com o ID de cada versículo.
Exemplo: ['19023001', '43003016', '45012002']
references String (opcional) Referências. Exemplo: João 3:16 ou Rm 12:2 ou Gn 1:1-3 Sl 23.1
version String (opcional) Nome ou abreviação da tradução utilizada v2.21.0+
Ver exemplo 
{
  "type": "verse",
  "references": "Ps 23.1-6 Rm 12.2",
  "version": "en_kjv"
}

AddItemText

Nome Tipo Descrição
type String text
id String ID do item
Ver exemplo 
{
  "type": "text",
  "id": "xyz"
}

AddItemAudio

Nome Tipo Descrição
type String audio
name String Nome do arquivo
settings PlayMediaSettings (opcional) Configurações para execução da mídia v2.21.0+
Ver exemplo 
{
  "id": "",
  "type": "audio",
  "name": "file.mp3",
  "isDir": false
}

AddItemVideo

Nome Tipo Descrição
type String video
name String Nome do arquivo
settings PlayMediaSettings (opcional) Configurações para execução da mídia v2.21.0+
Ver exemplo 
{
  "id": "",
  "type": "video",
  "name": "file.mp4",
  "isDir": false
}

AddItemImage

Nome Tipo Descrição
type String image
name String Nome do arquivo
Ver exemplo 
{
  "type": "image",
  "name": "file.ext"
}

AddItemFile

Nome Tipo Descrição
type String file
name String Nome do arquivo
Ver exemplo 
{
  "type": "file",
  "name": "file.ext"
}

AddItemAutomaticPresentation

Nome Tipo Descrição
type String automatic_presentation
name String Nome do arquivo
Ver exemplo 
{
  "type": "automatic_presentation",
  "name": "filename.ap"
}

AddItemAnnouncement

id, ids, name ou names

Nome Tipo Descrição
type String announcement
id String (opcional) ID do anúncio. Pode ser all para exibir todos
ids Array<String> (opcional) Lista com o ID de cada anúncio
name String (opcional) Nome do anúncio
names Array<String> (opcional) Lista com o nome de cada anúncio
automatic Automatic (opcional) Se informado, a apresentação dos itens será automática
shuffle Boolean Exibir a lista de anúncios de forma aleatória Padrão: false v2.26.0+
Ver exemplo 
{
  "type": "announcement",
  "names": [
    "Anúncio 1",
    "Anúncio 2",
    "Anúncio 3"
  ],
  "automatic": {
    "seconds": 10,
    "repeat": true
  },
  "shuffle": true
}

AddItemCountdown

Nome Tipo Descrição
type String countdown
time String HH:MM ou MM:SS
exact_time Boolean (opcional) Se true, time deve ser HH:MM (hora e minuto exato). Se false, time deve ser MM:SS (quantidade de minutos e segundos) Padrão: false
text_before String (opcional) Texto exibido na parte superior da contagem regressiva
text_after String (opcional) Texto exibido na parte inferior da contagem regressiva
zero_fill Boolean (opcional) Preencher o campo 'minuto' com zero à esquerda Padrão: false
hide_zero_minute Boolean (opcional) Ocultar a exibição dos minutos quando for zero Padrão: false v2.25.0+
countdown_relative_size Number (opcional) Tamanho relativo da contagem regressiva Padrão: 250
theme ThemeFilter (opcional) Filtrar tema selecionado para exibição v2.21.0+
countdown_style FontSettings (opcional) Fonte personalizada para a contagem regressiva v2.21.0+
Ver exemplo 
{
  "type": "countdown",
  "time": "05:00",
  "exact_time": false,
  "text_before": "",
  "text_after": "",
  "zero_fill": false,
  "countdown_relative_size": 250,
  "theme": null,
  "countdown_style": {
    "font_name": null,
    "bold": null,
    "italic": true,
    "color": null
  },
  "hide_zero_minute": false
}

AddItemCountdownCommunicationPanel

Nome Tipo Descrição
type String countdown_cp
minutes Number Quantidade de minutos
seconds Number Quantidade de segundos
stop_at_zero Boolean (opcional) Parar a contagem regressiva ao chegar em zero Padrão: false
description String Descrição do item
Ver exemplo 
{
  "type": "countdown_cp",
  "minutes": 5,
  "seconds": 0,
  "stop_at_zero": false,
  "description": ""
}

AddItemPlainText

Nome Tipo Descrição
type String plain_text
name String Nome do item
text String Texto
Ver exemplo 
{
  "type": "plain_text",
  "name": "",
  "text": "Exemplo"
}

AddItemTextCommunicationPanel

Nome Tipo Descrição
type String cp_text
name String Nome do item
text String Texto
display_ahead Boolean (opcional) Alterar a opção 'exibir à frente de tudo'
Ver exemplo 
{
  "type": "cp_text",
  "name": "",
  "text": "Exemplo",
  "display_ahead": false
}

AddItemScript

Nome Tipo Descrição
type String script
id String ID do item
description String Descrição do item
inputs Object (opcional) Valor padrão para Function Input
Ver exemplo 
{
  "type": "script",
  "id": "xyz",
  "description": "",
  "inputs": {
    "message": "Exemplo",
    "duration": 30
  }
}

AddItemAPI

Nome Tipo Descrição
type String api
id String ID do item
description String Descrição do item
inputs Object (opcional) Valor padrão para Function Input
Ver exemplo 
{
  "type": "api",
  "id": "xyz",
  "description": "",
  "inputs": {
    "message": "Exemplo",
    "duration": 30
  }
}

AddItemModuleAction

Nome Tipo Descrição
type String module_action
id String ID do módulo
module_action_id String ID da ação do módulo
inputs Object (opcional) Valor padrão para executar a ação
Ver exemplo 
{
  "type": "module_action",
  "id": "abc",
  "module_action_id": "xyz",
  "inputs": {
    "message": "Exemplo",
    "duration": 30
  }
}

AddItemURI

Nome Tipo Descrição
type String uri
title String Título do item
uri_type String Pode ser: spotify youtube deezer
value String URI
Ver exemplo 
{
  "type": "uri",
  "title": "Holyrics",
  "uri_type": "youtube",
  "value": "https://youtube.com/watch?v=umYQpAxL4dI"
}

AddItemGlobalAction

Nome Tipo Descrição
type String global_action
action String Pode ser: slide_exit vlc_stop vlc_stop_fade_out

SongInfo

Nome Tipo Descrição
id String ID da música
title String Título da música
artist String Artista da música
author String Autor da música
note String Anotação da música
copyright String Copyright da música
key String Tom da música.
Pode ser: C C# Db D D# Eb E F F# Gb G G# Ab A A# Bb B Cm C#m Dbm Dm D#m Ebm Em Fm F#m Gbm Gm G#m Abm Am A#m Bbm Bm
bpm Number BPM da música
time_sig String Tempo da música.
Pode ser: 2/2 2/4 3/4 4/4 5/4 6/4 3/8 6/8 7/8 9/8 12/8
Ver exemplo 
{
  "id": "0",
  "title": "",
  "artist": "",
  "author": "",
  "note": "",
  "copyright": "",
  "key": "",
  "bpm": 0.0,
  "time_sig": ""
}

TextInfo

Nome Tipo Descrição
id String ID do texto
title String Título do texto
Ver exemplo 
{
  "id": "",
  "title": ""
}

VerseInfo

Ver exemplo 
{}

AudioInfo

Nome Tipo Descrição
file_name String
file_fullname String
file_relative_path String
file_path String
is_dir Boolean
extension String
properties Object
Ver exemplo 
{
  "file_name": "file.mp3",
  "file_fullname": "folder\\file.mp3",
  "file_relative_path": "audio\\folder\\file.mp3",
  "file_path": "C:\\Holyrics\\Holyrics\\files\\media\\audio\\folder\\file.mp3",
  "is_dir": false,
  "extension": "mp3"
}

VideoInfo

Nome Tipo Descrição
file_name String
file_fullname String
file_relative_path String
file_path String
is_dir Boolean
extension String
properties Object
Ver exemplo 
{
  "file_name": "file.mp4",
  "file_fullname": "folder\\file.mp4",
  "file_relative_path": "video\\folder\\file.mp4",
  "file_path": "C:\\Holyrics\\Holyrics\\files\\media\\video\\folder\\file.mp4",
  "is_dir": false,
  "extension": "mp4"
}

ImageInfo

Nome Tipo Descrição
file_name String
file_fullname String
file_relative_path String
file_path String
is_dir Boolean
extension String
properties Object
Ver exemplo 
{
  "file_name": "file.jpg",
  "file_fullname": "folder\\file.jpg",
  "file_relative_path": "image\\folder\\file.jpg",
  "file_path": "C:\\Holyrics\\Holyrics\\files\\media\\image\\folder\\file.jpg",
  "is_dir": false,
  "extension": "jpg"
}

FileInfo

Nome Tipo Descrição
file_name String
file_fullname String
file_relative_path String
file_path String
is_dir Boolean
extension String
properties Object
Ver exemplo 
{
  "file_name": "file.txt",
  "file_fullname": "folder\\file.txt",
  "file_relative_path": "file\\folder\\file.txt",
  "file_path": "C:\\Holyrics\\Holyrics\\files\\media\\file\\folder\\file.txt",
  "is_dir": false,
  "extension": "txt"
}

AutomaticPresentationInfo

Nome Tipo Descrição
name String
Ver exemplo 
{
  "name": "name"
}

AnnouncementInfo

Nome Tipo Descrição
id Number
name String
Ver exemplo 
{
  "id": 0,
  "name": "name"
}

SongSlideInfo

Nome Tipo Descrição
id String ID da música
slide_index Number
slide_total Number
slide_description String
slide_show_index Number
slide_show_total Number
title String Título da música
artist String Artista da música
author String Autor da música
note String Anotação da música
copyright String Copyright da música
key String Tom da música.
Pode ser: C C# Db D D# Eb E F F# Gb G G# Ab A A# Bb B Cm C#m Dbm Dm D#m Ebm Em Fm F#m Gbm Gm G#m Abm Am A#m Bbm Bm
bpm Number BPM da música
time_sig String Tempo da música.
Pode ser: 2/2 2/4 3/4 4/4 5/4 6/4 3/8 6/8 7/8 9/8 12/8
text String
comment String
extra String
Ver exemplo 
{
  "id": "0",
  "slide_index": 2,
  "slide_total": 8,
  "slide_description": "",
  "slide_show_index": 2,
  "slide_show_total": 12,
  "title": "",
  "artist": "",
  "author": "",
  "note": "",
  "copyright": "",
  "key": "",
  "bpm": 0.0,
  "time_sig": "",
  "text": "",
  "comment": "",
  "extra": ""
}

TextSlideInfo

Nome Tipo Descrição
id String ID do texto
title String Título do texto
text String
comment String
folder String
slide_index String
slide_total String
Ver exemplo 
{
  "id": "",
  "title": "",
  "text": "",
  "comment": "",
  "folder": "",
  "slide_index": 2,
  "slide_total": 8
}

PPTInfo

Nome Tipo Descrição
file_name String
file_fullname String
file_relative_path String
file_path String
is_dir Boolean
extension String
properties Object
Ver exemplo 
{
  "file_name": "file.txt",
  "file_fullname": "folder\\file.txt",
  "file_relative_path": "file\\folder\\file.txt",
  "file_path": "C:\\Holyrics\\Holyrics\\files\\media\\file\\folder\\file.txt",
  "is_dir": false,
  "extension": "txt"
}

PPTSlideInfo

Nome Tipo Descrição
file_name String
slide_number Number
slide_total Number
Ver exemplo 
{
  "file_name": "name",
  "slide_number": 1,
  "slide_total": 10
}

ThemeInfo

Nome Tipo Descrição
id Number
name String
from_user_list Boolean
tags Array<String>
bpm String
Ver exemplo 
{
  "id": 0,
  "name": "name",
  "from_user_list": true,
  "bpm": "0"
}

BackgroundInfo

Nome Tipo Descrição
type String THEME MY_VIDEO MY_IMAGE VIDEO IMAGE
id Number
name String
from_user_list Boolean
tags Array<String>
bpm String
color_map Array<Object>
color_map.*.hex String Cor no formato hexadecimal
color_map.*.red Number Vermelho 0 ~ 255
color_map.*.green Number Verde 0 ~ 255
color_map.*.blue Number Azul 0 ~ 255
Ver exemplo 
{
  "type": "MY_VIDEO",
  "id": 0,
  "name": "name",
  "from_user_list": true,
  "bpm": "0",
  "color_map": [
    {
      "hex": "000000",
      "red": 0,
      "green": 0,
      "blue": 0
    },
    {
      "hex": "000000",
      "red": 0,
      "green": 0,
      "blue": 0
    },
    {
      "hex": "000000",
      "red": 0,
      "green": 0,
      "blue": 0
    },
    {
      "hex": "000000",
      "red": 0,
      "green": 0,
      "blue": 0
    },
    {
      "hex": "000000",
      "red": 0,
      "green": 0,
      "blue": 0
    },
    {
      "hex": "000000",
      "red": 0,
      "green": 0,
      "blue": 0
    },
    {
      "hex": "000000",
      "red": 0,
      "green": 0,
      "blue": 0
    },
    {
      "hex": "000000",
      "red": 0,
      "green": 0,
      "blue": 0
    }
  ]
}

TitleInfo

Nome Tipo Descrição
title String
subitem Object
subitem_index Number
playlist_index Number
Ver exemplo 
{
  "title": "",
  "subitem_index": -1,
  "playlist_index": -1
}

WebcamInfo

Nome Tipo Descrição
name String
fps Number
width Number
height Number
mute Boolean
aspect_ratio String
Ver exemplo 
{
  "name": "name",
  "fps": 30.0,
  "width": 1280,
  "height": 720,
  "mute": false,
  "aspect_ratio": "1:1"
}

CountdownInfo

Nome Tipo Descrição
time String
exact_time Boolean
text_before String
text_after String
zero_fill Boolean
countdown_relative_size Number
hide_zero_minute Boolean
Ver exemplo 
{
  "time": "",
  "exact_time": false,
  "text_before": "",
  "text_after": "",
  "zero_fill": false,
  "countdown_relative_size": 0,
  "hide_zero_minute": false
}

AutomaticPresentationSlideInfo

Nome Tipo Descrição
id String
slide_index Number
Ver exemplo 
{
  "id": "filename.ap",
  "slide_index": 2
}

PresentationModifierInfoInfo

Nome Tipo Descrição
type String WALLPAPER BLANK_SCREEN BLACK_SCREEN
name String Nome do item
shortcut String F8 F9 F10
presentation_type String SONG TEXT VERSE ANY_ITEM
state Boolean
Ver exemplo 
{
  "type": "BLANK_SCREEN",
  "name": "Blank Screen",
  "shortcut": "F9",
  "presentation_type": "SONG",
  "state": false
}

NewChatMessageInfo

Nome Tipo Descrição
id String
datetime Number
user_id String
name String
message String
Ver exemplo 
{
  "id": "1742142790725",
  "datetime": 1742142790725,
  "user_id": "-1qfe9t8wtrsb6p5",
  "name": "example",
  "message": "example"
}

VersePresentationChangedInfo

Nome Tipo Descrição
id String
book Number
chapter Number
verse Number
reference String
Ver exemplo 
{
  "id": "01001001",
  "book": 1,
  "chapter": 1,
  "verse": 1,
  "reference": "Gn 1:1"
}

PlaylistChangedInfo

Ver exemplo 
{}

FileModifiedInfo

Nome Tipo Descrição
media_type String
action String
name String
is_dir Boolean
Ver exemplo 
{
  "media_type": "image",
  "action": "created",
  "name": "image.jpg",
  "is_dir": false
}

PlayerProgressInfo

Nome Tipo Descrição
time Number
total Number
Ver exemplo 
{
  "time": 0,
  "total": 60000
}

DrawLotsItemDrawnInfo

Nome Tipo Descrição
collection_type String
drawn_items Array<String>
Ver exemplo 
{
  "collection_type": "text"
}

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

15 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published