• Manual do Utilizador
Explore o mimoLive gratuitamente
Descarregue o mais recente

Pontos finais

Tabela de Conteúdos

Geral

O API, quando ativado, está disponível em "http://localhost:8989/api/v1". Esta é a base URL que deve ser anexado a cada método URL enumerados abaixo.

Se um recurso foi introduzido após o lançamento inicial do HTTP API, o método é marcado com um Disponível desde informações.

/

Métodos suportados: "OBTER"
Redirecciona para a lista de documentos abertos em "/documents".

Documentos

Consulta de documentos

/documentos

Métodos suportados: "OBTER"
Resulta numa lista de documentos abertos. Ver o tipo de dados documentos para saber que informações contêm os objectos devolvidos.

/documentos/(DocumentID)

Métodos suportados: "OBTER"
Devolve um único documento especificado por "(DocumentID)". Na secção incluída da resposta, todos os objectos "layer" utilizados por este documento e todos os objectos "source" contidos neste documento serão igualmente devolvidos (carregamento lateral). Ver o tipo de dados documents para mais informações sobre os dados devolvidos.

/documentos/(DocumentID)/programOut

Métodos suportados: "OBTER"
A saída do programa que é atualmente produzida pelo documento especificado por "(DocumentID)".
Utiliza os mesmos parâmetros que as pré-visualizações de origem.

Acções do documento

/documentos/(DocumentID)/setLive

Métodos suportados: "OBTER" "POST"
Inicia um espetáculo/documento e desencadeia todos os eventos associados. Chamar isto a um documento já em execução não resultará num erro. O objeto do documento atualizado será devolvido.

/documentos/(DocumentID)/setOff

Métodos suportados: "OBTER" "POST"
Interrompe um espetáculo/documento. Chamar isto a um espetáculo já parado não resultará num erro. O objeto de documento atualizado será devolvido.

Como um documento pode decidir continuar a ser executado depois de chamar este método, o objeto de camada devolvido pode estar no estado "encerrado" em vez de "desligado".

/documentos/(DocumentID)/toggleLive

Métodos suportados: "OBTER" "POST"
Alterna um programa/documento entre vivo e desligado.

Camadas

Consulta de camadas

/documentos/(DocumentID)/camadas

Métodos suportados: "OBTER"
Devolve uma lista de camadas para o documento especificado por "(DocumentID)". Para obter informações sobre os objectos devolvidos, consulte o tipo de dados camadas.

/documentos/(DocumentID)/camadas/(LayerID)

Métodos suportados: "OBTER", "PUT"
Devolve uma única camada especificada por "(LayerID)" no documento especificado por "(DocumentID)". Na secção "incluído" da resposta, todos os objectos "variantes" relacionados com esta camada também serão devolvidos (carregamento lateral). Consulte o tipo de dados das camadas para obter mais informações sobre os dados devolvidos. Tenha em atenção que os "valores de entrada" do ponto final da camada reflectem os "valores de entrada" da variante "liveVariant" associada.

Modificar uma camada

Métodos suportados: "OBTER", "PUT"
Para definir o nome da camada, o volume de áudio ou os valores de entrada, execute um comando "PUT" com um pedido de JSON para o ponto final da camada. Em alternativa, pode utilizar um "OBTER", acrescentando o pedido JSON dados para o URL com a chave "?update=". Neste caso, o JSON os dados devem ser URL codificado.

Os valores que não pretende alterar devem ser simplesmente excluídos do JSON dados. Exemplo:

{
    "name": "New name of the Layer",
    "volume": 0.5,
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

Depois de atualizar os valores, o mimoLive responderá com um objeto de camada atualizado. Tenha em mente que nem todos os valores podem ser aplicados instantaneamente ou podem ter um efeito apenas após outro ciclo de renderização.

Nota: O atributo "volume" foi adicionado no mimoLive 5.6 e é ignorado em versões anteriores ou se a camada não tiver controlo de volume. O valor será recortado para (0, 1), onde 0 é silencioso e 1 é volume total.

Acções de camada

/documentos/(DocumentID)/camadas/(LayerID)/setLive

Métodos suportados: "OBTER" "POST"
Ativa uma camada. Quando esta opção é chamada diretamente na camada, será utilizada a última variante de camada selecionada. Chamar isto numa camada já ativa não resultará num erro. O objeto de camada atualizado será devolvido.

/documentos/(DocumentID)/camadas/(LayerID)/setOff

Métodos suportados: "OBTER" "POST"
Desactiva uma camada. Chamar isso em uma camada já desativada não resultará em um erro. O objeto de camada atualizado será devolvido.

Como uma camada pode decidir fazer algumas animações depois de chamar este método, o objeto de camada devolvido pode estar no estado "encerrado" em vez de "desligado".

/documentos/(DocumentID)/camadas/(LayerID)/toggleLive

Métodos suportados: "OBTER" "POST"
Alterna uma camada entre "ativa" e "desligada".

/documents/(DocumentID)/layers/(LayerID)/signals/(SignalID)

Métodos suportados: "OBTER" "POST"
Desencadeia o sinal especificado por "(SignalID)" na "variante em direto" atual ou se a camada não estiver em direto na "variante ativa". Pode obter o "(SignalID)" a partir do campo "input-values" da camada (identificado pelo sufixo de chave "_TypeSignal").

/documents/(DocumentID)/layers/(LayerID)/cycleThroughVariants

Métodos suportados: "OBTER" "POST"
Disponível desde: mimoLive 5.6
Selecciona a variante seguinte após a variante atualmente ativa da camada "(LayerID)" para ser a nova variante ativa da camada. Isto pode ser utilizado para selecionar a variante (por exemplo, de uma camada Lower Third) que deve ser activada seguinte.
Chamar este ponto final não perturba o seu espetáculo se a camada estiver atualmente em direto. O efeito só aparece quando a camada é colocada em direto posteriormente.

Variantes

Consulta de variantes

/documentos/(DocumentID)/camadas/(LayerID)/variantes

Métodos suportados: "OBTER"
Devolve uma lista de variantes para a camada especificada por "(LayerID)" e o documento especificado por "(DocumentID)". Para obter informações sobre os objectos devolvidos, consulte o tipo de dados "variantes".

/documentos/(DocumentID)/camadas/(LayerID)/variantes/(VariantID)

Métodos suportados: "OBTER", "PUT"
Devolve uma única variante especificada por "(VariantID)" e "(LayerID)" no documento especificado por "(DocumentID)". Consulte o tipo de dados "variants" para obter mais informações sobre os dados devolvidos.

Modificação de uma variante

Para definir o nome da variante ou dos valores de entrada, efetuar um "PUT" com um pedido de JSON objeto codificado para o ponto final da variante. Os valores que não pretende alterar devem ser simplesmente excluídos do JSON tu "PUT". Exemplo:

{
    "name": "New name of the Variant",
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

Depois de atualizar os valores, o mimoLive responderá com um objeto variante atualizado. Tenha em mente que nem todos os valores podem ser aplicados instantaneamente ou podem ter um efeito apenas após outro ciclo de renderização.

Acções variantes

/documents/(DocumentID)/layers/(LayerID)/variants/(VariantID)/setLive

Métodos suportados: "OBTER" "POST"
Ativa uma variante; se a camada proprietária não estiver ativa, também será activada. Chamar isto a uma variante já ativa não resultará num erro. O objeto variante atualizado será devolvido.

/documents/(DocumentID)/layers/(LayerID)/variants/(VariantID)/setOff

Métodos suportados: "OBTER" "POST"
Desactiva uma variante. Isto também fará com que a camada proprietária seja desactivada.

/documents/(DocumentID)/layers/(LayerID)/variants/(VariantID)/toggleLive

Métodos suportados: "OBTER" "POST"
Alterna uma variante entre ativa e inativa.

/documents/(DocumentID)/layers/(LayerID)/variants/(VariantID)/signals/(SignalID)

Métodos suportados: "OBTER" "POST"
Acciona o sinal especificado por "(SignalID)" na variante. Pode obter-se o "(SignalID)" no campo "input-values" da camada (identificado pelo sufixo de chave "_TypeSignal").

Fontes

Consulta de fontes

/documentos/(DocumentID)/sources

Métodos suportados: "OBTER"
Devolve uma lista de fontes para o documento especificado por "(DocumentID)". Para obter informações sobre os objectos devolvidos, consulte o tipo de dados "sources layer".

/documentos/(DocumentID)/sources/(SourceID)

Métodos suportados: "OBTER", "PUT"
Devolve uma única fonte especificada por "(SourceID)" no documento especificado por "(DocumentID)". Na secção incluída da resposta, todos os objectos "filter" relacionados com esta fonte também serão devolvidos (carregamento lateral). Ver o tipo de dados "sources" para mais informações sobre os dados devolvidos.

/documentos/(DocumentID)/sources/(SourceID)/preview

Métodos suportados: "OBTER"
Devolve uma pré-visualização gráfica da fonte especificada por "(SourceID)" no documento especificado por "(DocumentID)". O ponto final suporta os seguintes parâmetros:

ParâmetroPredefiniçãoDescrição
formatopngO formato em que a pré-visualização é devolvida. Valores permitidos: png, jpeg, mjpeg, mpng
fps10A taxa de quadros para visualizações de imagens em movimento. Aplicável apenas aos formatos mjpeg e mpng. Tenha em atenção que 1 fps é aproximadamente igual a 1% de CPU utilização.
largura(largura do documento)A largura máxima da pré-visualização. A imagem será reduzida para caber na largura indicada.
altura(largura do documento)A altura máxima da pré-visualização. A imagem será reduzida para caber na altura indicada.

Modificação de uma fonte

Para definir o nome da fonte ou os valores de entrada (apenas se a fonte tiver algum, por exemplo, se for uma Fonte de composição), execute um comando "PUT" com um pedido de JSON objeto codificado para o ponto final de origem. Os valores que não pretende alterar devem ser simplesmente excluídos do JSON tu "PUT". Exemplo:

{
    "name": "New name of the Source",
    "gain": 1.25,
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

O atributo "gain" foi adicionado no mimoLive 5.6 e é ignorado em versões anteriores ou se a fonte não tiver controlo de ganho. O valor será cortado para (0, 2), onde 0 é silencioso, 1 é a predefinição e 2 duplica aproximadamente o volume.

Acções de origem

/documentos/(DocumentID)/sources/(SourceID)/signals/(SignalID)

Métodos suportados: "OBTER" "POST"
Acciona o sinal especificado por "(SignalID)" na fonte (apenas se a fonte tiver "valores de entrada", por exemplo, se for uma Fonte de composição). Pode obter o "(SignalID)" a partir do campo "input-values" da fonte (identificado pelo sufixo de chave "_TypeSignal").

Filtros

Consulta de filtros

/documentos/(DocumentID)/sources/(SourceID)/filtros

Métodos suportados: "OBTER"
Devolve uma lista de filtros para a fonte especificada por "(SourceID)" e o documento especificado por "(DocumentID)". Para obter informações sobre os objectos devolvidos, consulte o tipo de dados "filters".

/documentos/(DocumentID)/fontes/(SourceID)/filtros/(FilterID)

Métodos suportados: "OBTER", "PUT"
Devolve um único filtro especificado por "(FilterID)" e "(SourceID)" no documento especificado por "(DocumentID)". Ver o tipo de dados "filters" para mais informações sobre os dados devolvidos.

Modificar um filtro

Para definir os valores de entrada, efetuar um "PUT" com um pedido de JSON objeto codificado para o ponto final do filtro. Os valores que não pretende alterar devem ser simplesmente excluídos do JSON tu "PUT". Exemplo:

{
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

/documentos/(DocumentID)/sources/(SourceID)/filters/(FilterID)/signals/(SignalID)

Métodos suportados: "OBTER" "POST"
Acciona o sinal especificado por "(SignalID)" no filtro. Pode obter o "(SignalID)" a partir do campo "input-values" do filtro (identificado pelo sufixo de chave "_TypeSignal").

Destinos de saída

Consulta de destinos de saída

/documents/(DocumentID)/output-destinations

textileRef:9996801466400ba8908856:linkStartMarker:“Métodos suportados: "OBTER"
Disponível desde: mimoLive 4.2
Lista todos os destinos de saída para o documento especificado.
Para obter informações sobre os objectos devolvidos, ver o tipo de dados ""output-destinations"":{TOPIC-LINK+data-typesh1(}. section-output-destinations).

/documents/(DocumentID)/output-destinations/(OutputDestinationID)

Métodos suportados: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Disponível desde: mimoLive 4.2
Devolve o destino de saída especificado por "(OutputDestinationID)".
Para obter informações sobre os objectos devolvidos, ver o tipo de dados ""output-destinations"":{TOPIC-LINK+data-typesh1(}. section-output-destinations).

Modificação de um destino de saída

/documents/(DocumentID)/output-destinations/(OutputDestinationID)

Métodos suportados: "PATCH"
Disponível desde: mimoLive 4.2
Actualiza as propriedades seleccionadas do destino de saída especificado por "(OutputDestinationID)".
Devolve o destino de saída atualizado.

As seguintes propriedades são modificáveis:

  • "título"
  • "começa com o espetáculo"
  • "pára-com-o-espetáculo"
  • Conteúdo do objeto "definições" (ver o descrição das definições. secção-individual-settings) para mais informações)

A descrição da atualização deve ser apresentada em JSON:Formato de atualização da API . atualização de dados). Exemplo:

{
  "data": {
    "type": "output-destinations",
    "id": "4FF003EA-D071-43FD-845F-DCD4A25DFA00",
    "attributes": {
      "title": "Our Recording",
      "starts-with-show": true,
      "settings": {
        "location": "~/Movies"
      }
    }
  }
}

Acções de destino de saída

/documents/(DocumentID)/output-destinations/(OutputDestinationID)/setLive

Métodos suportados: "OBTER" "POST"
Disponível desde: mimoLive 4.2
Faz com que o destino de saída especificado por "(OutputDestinationID)" entre em funcionamento, se estiver corretamente configurado e tiver permissão para entrar em funcionamento (por exemplo, com base no estado de licenciamento mimoLive).
Se o destino de saída puder ser ativado, é devolvido o destino de saída com o seu novo "live-state"; caso contrário, é devolvido um erro "409 Conflict".

Dado que um destino de saída pode ter de realizar algum trabalho antes de ser colocado em direto (por exemplo, contactar um serviço externo para criar um fluxo em direto), o objeto de destino de saída devolvido pode estar no estado "startup" (arranque) em vez de "live" (em direto).

/documents/(DocumentID)/output-destinations/(OutputDestinationID)/setOff

Métodos suportados: "OBTER" "POST"
Disponível desde: mimoLive 4.2
Faz com que o destino de saída especificado por "(OutputDestinationID)" pare.
Se o destino de saída estiver autorizado a parar, o destino de saída é devolvido; caso contrário, é devolvido um erro "409 Conflito".

Como um destino de saída pode ter de efetuar algum trabalho antes de parar as operações, o destino de saída devolvido pode estar no estado "shutdown" (encerramento) em vez de "preview" (pré-visualização) (que seria a predefinição para um destino de saída bem configurado).

Conjuntos de camadas

Os conjuntos de camadas foram introduzidos no mimoLive 5.0 e permitem definir o estado ativo de várias camadas de uma só vez, permitindo a criação de cenas para diferentes situações num espetáculo. Só podem ser criados e geridos no mimoLive. API o acesso é limitado à obtenção e recordação conjuntos de camadas (de ativação).

Consulta de conjuntos de camadas

/documentos/(DocumentID)/conjuntos de camadas

textileRef:9996801466400ba8908856:linkStartMarker:“Métodos suportados: "OBTER"
Disponível desde: mimoLive 5.0
Lista todos os conjuntos de camadas para o documento especificado.
Para obter informações sobre os objectos devolvidos, ver o tipo de dados ""layer-sets"":{TOPIC-LINK+data-typesh1(}. section-layer-sets).

/documents/(DocumentID)/layer-sets/(LayerSetID)

Métodos suportados: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Disponível desde: mimoLive 5.0
Devolve o conjunto de camadas especificado por "(LayerSetID)".
Para obter informações sobre os objectos devolvidos, ver o tipo de dados ""layer-sets"":{TOPIC-LINK+data-typesh1(}. section-layer-sets).

Acções do conjunto de camadas

/documents/(DocumentID)/layer-sets/(LayerSetID)/recall

Métodos suportados: "OBTER" "POST"
Disponível desde: mimoLive 5.0
Recupera (ativa) o conjunto de camadas especificado por "(LayerSetID)", fazendo com que todas as camadas assumam o estado em direto registado no conjunto de camadas.
Devolve o conjunto de camadas após a recuperação, ou seja, com "active == true".

Armazéns de dados

/documentos/(DocumentID)/datastores/(StoreID)

Métodos suportados: "OBTER", "PUT", "APAGAR"
O mimoLive oferece a possibilidade de armazenar dados fornecidos por si dentro do ficheiro do documento, por exemplo, para restaurar um estado mais tarde. Pode escolher livremente um "StoreID", mas tenha em atenção que não há forma de listar todos os armazenamentos de dados associados a um documento (no entanto, pode criar algum tipo de índice que controla as suas outras lojas nomeadas dinamicamente).

Criar/atualizar um armazenamento de dados

Para criar ou atualizar um armazenamento de dados, envie um "PUT" para uma "StoreID" à sua escolha com os dados associados no corpo do seu pedido. Se a operação for bem sucedida, o mimoLive responderá com o estado "200 OK".

Ler o conteúdo de um armazenamento de dados

Para ler um armazenamento de dados previamente armazenado, basta solicitá-lo através de "OBTER". Os dados serão devolvidos exatamente como foram fornecidos no campo "PUT" para o armazenar. Se não for encontrado nenhum armazenamento de dados com esse ID para este documento, o mimoLive devolverá um erro "404 Not Found" (404 não encontrado).

Eliminar um armazenamento de dados existente

Para eliminar um armazenamento de dados quando já não precisar dele, basta emitir uma mensagem "APAGAR" para o "StoreID" que pretende eliminar. No caso de o armazenamento de dados não existir, o mimoLive responderá com um erro "404 Not Found" (404 não encontrado).

Exemplo de utilização

Estes pontos de extremidade da API HTTP do mimoLive podem ser utilizados de várias formas. Por favor, consulte a secção Exemplos de Utilização da API para saber mais.

A sua opinião

Como avalia a sua experiência com esta funcionalidade do mimoLive?

Manual do utilizador: Actualizações recentes

Começar a utilizar o mimoLive

Comece a sua viagem com o mimoLive explorando a sua interface intuitiva e as suas poderosas funcionalidades. Este guia acompanha-o na configuração das suas fontes, na adição de gráficos e efeitos e na entrada em direto. Quer seja um principiante ou um utilizador experiente, este tutorial fornece instruções passo a passo para o ajudar a criar produções de vídeo em direto envolventes e profissionais.

Ler mais "
2023-03-10