Está a utilizar o Claude, o Codex, o Github Copilot ou outra IA de codificação?
Consulte o Referência da API do mimoLive. Introduza-o no seu agente de codificação de IA favorito e utilize instantaneamente a API mimoLive de forma correta.
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".
/dispositivos
Métodos suportados: "GET"
Retorna uma lista dos dispositivos de vídeo atualmente disponíveis no sistema host. Cada entrada contém um identificador e um nome legível por humanos. Útil para mapear dispositivos de captura para Fontes.
/dispositivos/(ID do dispositivo)
Métodos suportados: "GET"
Retorna detalhes do dispositivo especificado por "(DeviceID)", incluindo seu nome e propriedades.
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”, "PUT"
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.
O PUT actualiza as propriedades ao nível do documento, como o volume principal de saída do programa e os metadados de apresentação (título, autor, resolução, taxa de fotogramas, taxa de amostragem, etc.). Envie apenas os campos que pretende alterar.
/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
Criar camadas
POST /documents/(DocumentID)/layers
Cria uma nova camada a partir de um modelo de camada e insere-a na pilha de camadas do documento. Especifique o modelo por meio de seu identificador de camada e, opcionalmente, defina a posição na pilha, um nome e valores de entrada iniciais. Retorna o objeto de camada recém-criado.
curl -X POST "http://localhost:8989/api/v1/documents/(DocumentID)/layers" \
-H "Content-Type: application/json" \
-d '{
"layer-identifier": "com.boinx.mimoLive.layer.lowerthird",
"index": 4,
"name": "My Lower Third"
}'
Consulta de camadas
GET /documents/(DocumentID)/layers
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.
Eliminar uma camada
DELETE /documents/(DocumentID)/layers/(LayerID)
Remove a camada especificada do documento. Retorna 204 No Content em caso de sucesso. A eliminação será recusada se a camada for uma camada de demonstração obrigatória.
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.
/documents/(DocumentID)/layers/(LayerID)/cycleThroughVariantsBackwards
Métodos suportados: "GET" "POST"
Seleciona a variante anterior (o inverso de /cycleThroughVariants) sem afetar o estado ativo atual. O efeito torna-se visível quando a camada ou a variante selecionada é definida como ativa.
/documents/(DocumentID)/layers/(LayerID)/setLiveFirstVariant
Métodos suportados: "GET" "POST"
Ativa a primeira variante da camada e define a camada ao vivo.
/documents/(DocumentID)/layers/(LayerID)/setLiveLastVariant
Métodos suportados: "GET" "POST"
Ativa a última variante da camada e define a camada como ativa.
/documents/(DocumentID)/layers/(LayerID)/inputs/(SourceInputKey)/mediacontrol/(MediaControlCommand)
Métodos suportados: "GET" "POST"
Envia um comando de controlo de media para o media ligado à entrada "(SourceInputKey)" da camada especificada. Observe que a fonte da entrada está informando quais comandos ela suporta; consulte /documents/(DocumentID)/sources/(SourceID).
| Comando de controlo dos meios de comunicação | Descrição |
| jogar | Inicia a reprodução de multimédia. |
| pausa | Faz uma pausa na reprodução atual sem repor a posição. |
| parar | Pára a reprodução e repõe a posição do suporte para o início. |
| inverter | Reproduz os ficheiros multimédia na direção inversa. |
| rebobinar | Faz retroceder a reprodução, normalmente a um ritmo mais rápido do que o normal. |
| avançar rapidamente | Avança rapidamente a reprodução. |
| ignorar o início | Salta para o início do meio de comunicação. |
| saltar para o fim | Salta para o fim dos meios de comunicação social. |
| saltar para trás | Salta para trás num intervalo de 10 segundos. |
| saltar à frente | Salta para a frente num intervalo de 10 segundos. |
| registo | Inicia a gravação da entrada do suporte de dados. |
| baralhar | Alterna a ordem de reprodução aleatória dos itens multimédia. |
| repetir | Repita os meios de comunicação actuais. |
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
Criação de fontes
POST /documentos/(DocumentID)/sources
Cria uma nova fonte no documento a partir de um determinado tipo de fonte. Especifique o tipo através de source-type (por exemplo, com.boinx.mimoLive.sources.deviceVideoSource), forneça opcionalmente um nome de apresentação e todos os parâmetros que podem ser actualizados através da API HTTP. Devolve o objeto de fonte recentemente criado.
curl -X POST "http://localhost:8989/api/v1/documents/(DocumentID)/sources" \
-H "Content-Type: application/json" \
-d '{
"source-type": "com.boinx.mimoLive.sources.deviceVideoSource",
"name": "Main Camera"
}'
Valid source type identifiers:| Identificadores de tipo de fonte | Fonte |
| com.boinx.mimoLive.sources.webBrowserSource | Navegador Web |
| com.boinx.mimoLive.sources.screenCaptureSource | Captura de ecrã |
| com.boinx.mimoLive.sources.ffmpegSource | NDI / Captura de vídeo |
| com.boinx.mimoLive.sources.webRTCSource | mimoCall |
| com.boinx.mimoLive.sources.windowCaptureSource | Captura de janelas |
| com.boinx.mimoLive.sources.deviceAudioSource | Dispositivo áudio |
| com.boinx.mimoLive.sources.deviceVideoSource | Combinação de um dispositivo de vídeo e áudio (câmara) |
| com.boinx.mimoLive.sources.lastRecordingSource | Última gravação |
| com.boinx.mimoLive.sources.zoomparticipant | Participante no Zoom |
| e muito mais... | |
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âmetro | Predefinição | Descrição |
|---|---|---|
| formato | png | O formato em que a pré-visualização é devolvida. Valores permitidos: png, jpeg, mjpeg, mpng |
| fps | 10 | A 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. |
/documents/(DocumentID)/sources/(SourceID)/mediacontrol/(MediaControlCommand)
Métodos suportados: "GET" "POST"
Controla a reprodução de fontes com capacidade multimédia (por exemplo, ficheiro multimédia/lista de reprodução). Os comandos suportados dependem do tipo de fonte. Consulte /documents/(DocumentID)/layers/(LayerID)/inputs/(SourceInputKey)/mediacontrol/(MediaControlCommand) .
/documentos/(DocumentID)/sources/(SourceID)/openwebbrowser
Métodos suportados: "GET"
No caso de a fonte ser uma fonte de Captura do navegador da Web, esta ação abrirá a janela do navegador da Web correspondente.
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.
Eliminação de uma fonte
DELETE /documents/(DocumentID)/sources/(SourceID)
Remove a fonte especificada do documento. Devolve 204 No Content em caso de sucesso.
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
Criação de destinos de saída
POST /documents/(DocumentID)/output-destinations
Cria um novo destino de saída no documento. Especifique o tipo através de output-destination-type e, opcionalmente, defina a posição com o índice e o parâmetro que pode ser atualizado através da API HTTP. Devolve o objeto de destino de saída recentemente criado.
Identificador do destino de saída | Destino de saída |
|---|---|
com.boinx.mimoLive.outputDestination.liveStreaming | Transmissão em direto (RTMP, etc.) |
com.boinx.mimoLive.outputDestination.fileRecording | Gravação de ficheiros |
com.boinx.mimoLive.outputDestination.blackmagicDesign | Reprodução (Blackmagic SDI/HDMI) |
com.boinx.mimoLive.outputDestination.ndi | Saída NDI |
com.boinx.mimoLive.outputDestination.fullscreen | Saída de ecrã completo |
com.boinx.mimoLive.outputDestination.virtualCamera | Câmara virtual |
com.boinx.mimoLive.outputDestination.mimoCall | mimoCall |
com.boinx.mimoLive.outputDestination.audioMonitor | Monitor de áudio |
com.boinx.mimoLive.outputDestination.imageSequence | Escritor de imagens |
com.boinx.mimoLive.outputDestination.fileUploader | Carregador de ficheiros |
curl -X POST "http://localhost:8989/api/v1/documents/(DocumentID)/output-destinations" \
-H "Content-Type: application/json" \
-d '{
"output-destination-type": "com.boinx.mimoLive.outputDestination.fileRecording",
"index": 0
}'Consulta de destinos de saída
/documents/(DocumentID)/output-destinations
Métodos suportados: "OBTER"
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: "GET"
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: "PUT", "PATCH"
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"
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"
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 em direto de várias camadas ao mesmo tempo, permitindo a criação de cenas leves para diferentes situações num espetáculo.
Criar conjuntos de camadas
POST /documents/(DocumentID)/layer-sets
Cria um novo conjunto de camadas no documento. Um conjunto de camadas é uma coleção salva de ações que são aplicadas a uma ou mais camadas quando o conjunto de camadas é recuperado. Para cada camada, especifique uma ação: “ao vivo” (ativar, opcionalmente com uma variante específica), “desativar” (desativação gradual) ou “forçar desativação” (desativação imediata). Também pode definir a chamada no início do espetáculo e a chamada no fim do espetáculo para chamar automaticamente o conjunto de camadas quando o espetáculo começa ou termina. Devolve o objeto de conjunto de camadas recentemente criado.
curl -X POST "http://localhost:8989/api/v1/documents/(DocumentID)/layer-sets" \
-H "Content-Type: application/json" \
-d '{
"data": {
"attributes": {
"name": "Interview Scene",
"recall-on-show-start": false,
"recall-on-show-end": false,
"layers": [
{
"layer-id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"action": "live",
"variant": "edit-variant"
},
{
"layer-id": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
"action": "off"
},
{
"layer-id": "ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
"action": "force-off"
}
]
}
}
}'
Consulta de conjuntos de camadas
/documentos/(DocumentID)/conjuntos de camadas
Métodos suportados: "OBTER"
Lista todos os conjuntos de camadas para o documento especificado.
Para obter informações sobre os objectos devolvidos, consulte o tipo de dados “conjuntos de camadas”.
/documents/(DocumentID)/layer-sets/(LayerSetID)
Métodos suportados: "GET"
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).
Modificação de conjuntos de camadas
/documents/(DocumentID)/layer-sets/(LayerSetID)
Métodos suportados: "PUT", "PATCH"
Atualiza um conjunto de camadas existente. Você pode renomeá-lo, alterar seu comportamento de chamada automática ou substituir suas entradas de ação de camada. Inclua apenas os atributos que deseja alterar. Retorna o objeto do conjunto de camadas atualizado.
curl -X PUT "http://localhost:8989/api/v1/documents/(DocumentID)/layer-sets/(LayerSetID)" \
-H "Content-Type: application/json" \
-d '{
"data": {
"attributes": {
"name": "Wide Shot Scene",
"layers": [
{
"layer-id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"action": "live",
"variant": "VVVVVVVV-VVVV-VVVV-VVVV-VVVVVVVVVVVV"
},
{
"layer-id": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
"action": "force-off"
}
]
}
}
}'
Eliminar um conjunto de camadas
DELETE /documents/(DocumentID)/layer-sets/(LayerSetID)
Remove permanentemente o conjunto de camadas especificado do documento. Retorna 204 Sem conteúdo em caso de sucesso.
Acções do conjunto de camadas
/documents/(DocumentID)/layer-sets/(LayerSetID)/recall
Métodos suportados: "OBTER" "POST"
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).
Reuniões Zoom
Estes pontos finais controlam a integração do cliente Zoom incorporado no mimoLive.
/zoom/join
Métodos suportados: "GET" "POST"
Entra em uma reunião do Zoom. Parâmetros típicos (envie como corpo JSON para POST ou ?param=value para GET):
| Parâmetro | Tipo de valor | Descrição |
reuniãoid | Cordas | Número da reunião Zoom (utilize “Demo-Meeting-ID” se pretender juntar-se à reunião de demonstração mimoLive) |
código de acesso | Cadeia de caracteres, opcional | Código de acesso à reunião |
código do webinar | Cadeia de caracteres, opcional | Se quiser participar num webinar, tem de fornecer o token do webinar |
nome de exibição | Cordas, facultativo | Nome a figurar na reunião |
nome da conta de zoom | Cordas | Nome da conta Zoom conforme exibido nas configurações da conta Zoom do mimoLive |
| câmara virtual | Cadeia de caracteres, opcional | Quando definido como “true” (verdadeiro), o mimoLive enviará o programa como um feed de vídeo para o Zoom |
Devolve um objeto de estado que indica o progresso ou o sucesso da ligação.
/zoom/leave
Métodos suportados: "GET" "POST"
Sai da reunião em que se encontra atualmente. Devolve um objeto de estado.
/zoom/end
Métodos suportados: "GET" "POST"
Tenta encerrar/terminar a reunião Zoom atual (ação somente do host). Retorna sucesso se a reunião foi encerrada ou um conflito se o cliente não tiver permissão.
/zoom/participantes
Métodos suportados: "GET" "POST"
Retorna a lista atual de participantes para a reunião ingressada (nomes, IDs e estados básicos).
| Chave de valor | Tipo de valor | Descrição |
| nome | Cordas | Nome do participante no Zoom |
| id | Inteiro | ID de utilizador do participante no Zoom |
| função de utilizador | Cordas | |
| isHost | Bool | verdadeiro se o utilizador for o anfitrião da reunião |
| isCoHost | Bool | verdadeiro se o utilizador for coanfitrião da reunião |
| isVideoOn | Bool | verdadeiro se o utilizador tiver o vídeo ativado |
| isAudioOn | Bool | verdadeiro se o utilizador tiver o áudio ativado |
| isTalking | Bool | verdadeiro se o utilizador estiver a falar |
| isRaisingHand | Bool | verdadeiro se o utilizador estiver a levantar a mão |
/zoom/meetingaction
Executa uma ação com âmbito de reunião. Forneça action e argumentos opcionais por meio do corpo JSON ou da cadeia de caracteres de consulta.
| Parâmetro | Tipo de valor | Descrição |
| comando | Cordas | Um comando da lista abaixo |
| nome de utilizador | Cadeia de caracteres, opcional | Alguns comandos requerem um ID de utilizador |
| tipo de ecrã | Cadeia de caracteres, opcional | Alguns comandos requerem um tipo de ecrã |
| Comando | Descrição |
| requestRecordingPermission | Envie um pedido de autorização de registo local. |
| silenciarVídeo | Silencie o vídeo de um utilizador. (requer o parâmetro userid) |
| desativar o som do vídeo | Abra o som do vídeo de um utilizador. (requer o parâmetro userid) |
| silenciarÁudio | Silencie o áudio de um utilizador. (requer o parâmetro userid) |
| tirar o som do áudio | Desactive o áudio de um utilizador. (requer o parâmetro userid) |
| enableUnmuteBySelf | Active a funcionalidade que permite que os utilizadores possam ativar o seu próprio som quando estão silenciados, disponível apenas para o anfitrião/co-anfitrião. |
| desactivarUnmuteBySelf | Desactive a funcionalidade que impede os utilizadores de se activarem quando estão silenciados, disponível apenas para o anfitrião/co-anfitrião. |
| silenciarTodos | Silencie todos os participantes na reunião, disponível apenas para o anfitrião/co-anfitrião. |
| desativar o som de tudo | Abra o som de todos os participantes na reunião, disponível apenas para o anfitrião/co-anfitrião. |
| lockMeeting | Bloqueie a reunião, disponível apenas para o anfitrião/co-anfitrião. Uma vez bloqueada, os novos participantes já não podem aderir. |
| desbloquearReunião | Desbloqueie a reunião, disponível apenas para o anfitrião/co-anfitrião. |
| baixarTodasAsMãos | Ponha as mãos de todos os participantes para baixo, disponíveis apenas para o anfitrião/co-anfitrião. |
| shareFitWindowMode | Ajuste o tamanho do ecrã para se adaptar à janela. |
| pausaPartilha | Faça uma pausa na partilha. |
| currículoPartilhe | Partilha de currículos. |
| juntarVoip | Participe numa reunião por VoIP. |
| deixarVoip | Desligue o VoIP da reunião. |
| allowParticipantsToChat | Active a funcionalidade para que os utilizadores possam conversar entre si. |
| proibirParticipantesDoChat | Desactive a funcionalidade que permite aos utilizadores conversarem entre si. |
| allowParticipantsToShare | Active a funcionalidade para que os utilizadores possam partilhar o seu ecrã. |
| não permitir que os participantes partilhem | Desactive a funcionalidade que permite aos utilizadores partilharem o seu ecrã. |
| allowParticipantsToStartVideo | Active a funcionalidade para que os utilizadores possam iniciar o seu vídeo. |
| não permitir que os participantes iniciem o vídeo | Desactive a funcionalidade que permite aos utilizadores iniciar o seu vídeo. |
| permitir que os participantes partilhem o quadro branco | Active a funcionalidade para que os utilizadores possam partilhar um quadro branco. |
| não permitir que os participantes partilhem o quadro branco | Desactive a funcionalidade que permite aos utilizadores partilhar um quadro branco. |
| enableAutoAllowLocalRecordingRequest | Active a funcionalidade para que os pedidos de gravação dos utilizadores sejam automaticamente aceites. |
| disableAutoAllowLocalRecordingRequest | Desactive a funcionalidade que permite que os pedidos de gravação dos utilizadores sejam automaticamente aceites. |
| allowParticipantsToRename | Active a funcionalidade que permite aos utilizadores mudarem os seus nomes. |
| não permitir que os participantes sejam nomeados | Desactive a funcionalidade que permite aos utilizadores mudarem os seus nomes. |
| showParticipantProfilePictures | Active a opção para mostrar as imagens de perfil dos participantes. |
| hideParticipantProfilePictures (ocultar imagens do perfil do participante) | Desactive a opção de mostrar imagens de perfil dos participantes. |
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.