Skip to content

Latest commit

 

History

History
116 lines (104 loc) · 4.01 KB

ApiPopupCreateSong.md

File metadata and controls

116 lines (104 loc) · 4.01 KB

API Popup Create Song

PT | EN

Opção via API para criar uma nova música abrindo a janela de edição de letra. (v2.21.0+)

Isso permite que qualquer outro processo no computador possa enviar um conteúdo ao programa para abrir a janela de edição de letra.

curl -X 'POST' \
  'http://localhost:8091/api/popup-createsong' \
  -H 'Content-Type: application/json' \
  -d '{ "title": "...", "author": "...", "artist": "...", "lyrics": "..." }'

Parâmetros:

Nome Tipo Descrição
title String Título da música
lyrics String Letra da música.
Opcional se paragraphs for declarado
paragraphs Array<Object> Parâmetro alternativo para valores mais complexos.
Opcional se lyrics for declarado v2.23.0+
paragraphs.*.text String Texto do parágrafo v2.23.0+
paragraphs.*.description String (opcional) Descrição do parágrafo. coro, verso, ... v2.23.0+
paragraphs.*.translations Object (opcional) Traduções para o slide.
Conjunto chave/valor. v2.23.0+
author String (opcional) Autor da música
artist String (opcional) Artista da música
copyright String (opcional) Copyright da música v2.23.0+
note String (opcional) Anotação da música
key String (opcional) 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 (opcional) BPM da música
time_sig String (opcional) 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
streaming Object URI ou ID dos streamings v2.23.0+
streaming.audio Object Áudio v2.23.0+
streaming.audio.spotify String v2.23.0+
streaming.audio.youtube String v2.23.0+
streaming.audio.deezer String v2.23.0+
streaming.backing_track Object Playback v2.23.0+
streaming.backing_track.spotify String v2.23.0+
streaming.backing_track.youtube String v2.23.0+
streaming.backing_track.deezer String v2.23.0+
extras Object (opcional) Mapa de objetos extras (adicionados pelo usuário)
Permitido apenas campos já existentes. v2.23.0+
title_translations Object Traduções para o slide título.
Conjunto chave/valor. v2.23.0+

Observações:

  • Disponível a partir da versão 2.21.0;
  • É necessário que a opção "API Server" esteja ativada nas configurações do programa;
  • Aceita somente requisições da máquina local utilizando endereço loopback;
  • Caso tenha sido modificada, altere a porta 8091 da requisição para a porta correspondente definida nas configurações API Server.

Modelo JSON simples

{
  "title": "title",
  "lyrics": "Slide 1\nSlide 1\n\nSlide 2\nSlide 2",
  "artist": "artist",
  "author": "author",
  "copyright": "copyright",
}

Modelo JSON complexo

{
  "title": "title",
  "title_translations": {
    "key1": "value",
    "key2": "value"
  },
  "artist": "artist",
  "author": "author",
  "note": "note",
  "copyright": "copyright",
  "key": "",
  "bpm": 0.0,
  "time_sig": "",
  "paragraphs": [
    {
      "text": "Slide 1\nSlide 1",
      "description": "",
      "translations": {
        "key1": "value",
        "key2": "value"
      }
    }, {
      "text": "Slide 2\nSlide 2",
      "description": "",
      "translations": {
        "key1": "value",
        "key2": "value"
      }
    }
  ],
  "streaming": {
    "audio": {
      "spotify": "spotify_id",
      "youtube": "youtube_id",
      "deezer": "deezer_id"
    },
    "backing_track": {
      "spotify": "spotify_id",
      "youtube": "youtube_id",
      "deezer": "deezer_id"
    }
  },
  "extras": {
    "extra": "",
    "key1": "value",
    "key2": "value"
  }
}