{"id":32488,"date":"2023-03-08T16:32:47","date_gmt":"2023-03-08T15:32:47","guid":{"rendered":"https:\/\/mimolive.com\/?post_type=user-manual&#038;p=32488"},"modified":"2026-03-17T14:28:58","modified_gmt":"2026-03-17T13:28:58","slug":"pontos-finais","status":"publish","type":"user-manual","link":"https:\/\/mimolive.com\/pt\/user-manual\/remote-control-automation\/http-api\/endpoints\/","title":{"rendered":"Pontos finais"},"content":{"rendered":"<section class=\"boinx_exclamation\">\n    <div class=\"main_div_exclamation\">\n        <div class=\"left_div_icon_exclamation\">\n                <i class=\"icon_exclamation\">\u2757<\/i>\n        <\/div>\n\n        <div class=\"right_div_text_exclamation\">\n                <div><p class=\"text_exclamation_headline\">Est\u00e1 a utilizar o Claude, o Codex, o Github Copilot ou outra IA de codifica\u00e7\u00e3o?<\/p><\/div>\n                <div><p class=\"text_exclamation\">Consulte o <a href=\"https:\/\/github.com\/boinx\/mimoLive-API-Reference\" target=\"_blank\" rel=\"noopener\">Refer\u00eancia da API do mimoLive<\/a>. Introduza-o no seu agente de codifica\u00e7\u00e3o de IA favorito e utilize instantaneamente a API mimoLive de forma correta.<\/p><\/div>\n        <\/div>    \n    <\/div>\n<\/section>\n\n\t\t<style>.boinx_exclamation {\n    margin:30px 0;\n    padding:10px;\n    background-color:rgb(242,222,222);\n    border-radius: 8px;\n}\n.icon_exclamation {\n    display:block;\n    padding:5px;\n    font-size:80px;\n    color:rgb(184,74,72);\n    line-height:60px;\n}\n.text_exclamation {\n    color:rgb(184,74,72);\n}\n\n.text_exclamation_headline{\n    font-weight:bold;\n    color:rgb(184,74,72);\n}\n\n\n.main_div_exclamation\n{\n    display:flex !IMPORTANT;\n    flex-wrap: wrap;\n    flex-direction: row;\n    justify-content : flex-start;\n    align-items : flex-start\n    align-content : flex-start;\n    \n}\n\n.left_div_icon_exclamation{\n    display:flex !IMPORTANT;\n    width:80px;\n    padding:10px;\n    margin:20px 20px 20px 0;\n    height:40px;\n}\n.right_div_text_exclamation{\n    display:flex !IMPORTANT;\n    flex-direction: column;\n    flex-grow: 1;\n    width:200px;\n    padding:10px;\n    margin:0;\n}<\/style>\n\t\t\n\n\n<h2 class=\"wp-block-heading\">Geral<\/h2>\n\n\n\n<p>O <span class=\"caps\">API<\/span>, quando ativado, est\u00e1 dispon\u00edvel em \"http:\/\/localhost:8989\/api\/v1\". Esta \u00e9 a base <span class=\"caps\">URL<\/span> que deve ser anexado a cada m\u00e9todo <span class=\"caps\">URL<\/span> enumerados abaixo.<\/p>\n\n\n\n<p>Se um recurso foi introduzido ap\u00f3s o lan\u00e7amento inicial do <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span>, o m\u00e9todo \u00e9 marcado com um <strong>Dispon\u00edvel desde<\/strong> informa\u00e7\u00f5es.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\"<\/strong><br>Redirecciona para a lista de documentos abertos em \"\/documents\".<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/dispositivos<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados:<\/strong> \u201cGET\u201d<br>Devolve uma lista de ficheiros atualmente dispon\u00edveis <strong>dispositivos de v\u00eddeo<\/strong> no sistema anfitri\u00e3o. Cada entrada cont\u00e9m um identificador e um nome leg\u00edvel por humanos. \u00datil para mapear dispositivos de captura para Fontes.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/dispositivos\/(ID do dispositivo)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados:<\/strong> \u201cGET\u201d<br>Devolve detalhes do dispositivo especificado por \u201c(DeviceID)\u201d, incluindo o seu nome e propriedades.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Documentos<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Consulta de documentos<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\"<\/strong><br>Resulta numa lista de documentos abertos. Ver o tipo de dados documentos para saber que informa\u00e7\u00f5es cont\u00eam os objectos devolvidos.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\u201d, <strong>\"<span class=\"caps\">PUT<\/span>\"<\/strong><\/strong><br>Devolve um \u00fanico documento especificado por \"(DocumentID)\". Na sec\u00e7\u00e3o inclu\u00edda da resposta, todos os objectos \"layer\" utilizados por este documento e todos os objectos \"source\" contidos neste documento ser\u00e3o igualmente devolvidos (carregamento lateral). Ver o tipo de dados documents para mais informa\u00e7\u00f5es sobre os dados devolvidos.<\/p>\n\n\n\n<p>O PUT actualiza as propriedades ao n\u00edvel do documento, como o volume principal de sa\u00edda do programa e os metadados de apresenta\u00e7\u00e3o (t\u00edtulo, autor, resolu\u00e7\u00e3o, taxa de fotogramas, taxa de amostragem, etc.). Envie apenas os campos que pretende alterar.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/programOut<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\"<\/strong><br>A sa\u00edda do programa que \u00e9 atualmente produzida pelo documento especificado por \"(DocumentID)\".<br>Utiliza os mesmos par\u00e2metros que as pr\u00e9-visualiza\u00e7\u00f5es de origem.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Ac\u00e7\u00f5es do documento<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/setLive<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>Inicia um espet\u00e1culo\/documento e desencadeia todos os eventos associados. Chamar isto a um documento j\u00e1 em execu\u00e7\u00e3o n\u00e3o resultar\u00e1 num erro. O objeto do documento atualizado ser\u00e1 devolvido.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/setOff<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>Interrompe um espet\u00e1culo\/documento. Chamar isto a um espet\u00e1culo j\u00e1 parado n\u00e3o resultar\u00e1 num erro. O objeto de documento atualizado ser\u00e1 devolvido.<\/p>\n\n\n\n<p><i>*<\/i>Como um documento pode decidir continuar a ser executado depois de chamar este m\u00e9todo, o objeto de camada devolvido pode estar no estado \"encerrado\" em vez de \"desligado\".<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/toggleLive<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>Alterna um programa\/documento entre vivo e desligado.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Camadas<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Criar camadas<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\"><strong>POST \/documents\/(DocumentID)\/layers<\/strong><\/h4>\n\n\n\n<p>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\u00e7\u00e3o na pilha, um nome e valores de entrada iniciais. Retorna o objeto de camada rec\u00e9m-criado.<br><br><\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl -X POST \"http:\/\/localhost:8989\/api\/v1\/documents\/(DocumentID)\/layers\" \\\n  -H \"Content-Type: application\/json\" \\\n  -d '{\n    \"layer-identifier\": \"com.boinx.mimoLive.layer.lowerthird\",\n    \"index\": 4,\n    \"name\": \"My Lower Third\"\n  }'\n<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Consulta de camadas<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">GET \/documents\/(DocumentID)\/layers<\/h4>\n\n\n\n<p>Devolve uma lista de camadas para o documento especificado por \"(DocumentID)\". Para obter informa\u00e7\u00f5es sobre os objectos devolvidos, consulte o tipo de dados camadas.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/camadas\/(LayerID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\", \"<span class=\"caps\">PUT<\/span>\"<\/strong><br>Devolve uma \u00fanica camada especificada por \"(LayerID)\" no documento especificado por \"(DocumentID)\". Na sec\u00e7\u00e3o \"inclu\u00eddo\" da resposta, todos os objectos \"variantes\" relacionados com esta camada tamb\u00e9m ser\u00e3o devolvidos (carregamento lateral). Consulte o tipo de dados das camadas para obter mais informa\u00e7\u00f5es sobre os dados devolvidos. Tenha em aten\u00e7\u00e3o que os \"valores de entrada\" do ponto final da camada reflectem os \"valores de entrada\" da variante \"liveVariant\" associada.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Modificar uma camada<\/h3>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\", \"<span class=\"caps\">PUT<\/span>\"<\/strong><br>Para definir o nome da camada, o volume de \u00e1udio ou os valores de entrada, execute um comando \"<span class=\"caps\">PUT<\/span>\" com um pedido de <span class=\"caps\">JSON<\/span> para o ponto final da camada. Em alternativa, pode utilizar um \"<span class=\"caps\">OBTER<\/span>\", acrescentando o pedido <span class=\"caps\">JSON<\/span> dados para o <span class=\"caps\">URL<\/span> com a chave \"?update=\". Neste caso, o <span class=\"caps\">JSON<\/span> os dados devem ser <span class=\"caps\">URL<\/span> codificado.<\/p>\n\n\n\n<p>Os valores que n\u00e3o pretende alterar devem ser simplesmente exclu\u00eddos do <span class=\"caps\">JSON<\/span> dados. Exemplo:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>{\n    \"name\": \"New name of the Layer\",\n    \"volume\": 0.5,\n    \"input-values\": { \n        \"tvGroup_Content__Subtitle\": \"This is a Test\"\n    }\n}<\/code><\/pre>\n\n\n\n<p>Depois de atualizar os valores, o mimoLive responder\u00e1 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\u00f3s outro ciclo de renderiza\u00e7\u00e3o.<\/p>\n\n\n\n<p>Nota: O atributo \"volume\" foi adicionado no mimoLive 5.6 e \u00e9 ignorado em vers\u00f5es anteriores ou se a camada n\u00e3o tiver controlo de volume. O valor ser\u00e1 recortado para (0, 1), onde 0 \u00e9 silencioso e 1 \u00e9 volume total.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Eliminar uma camada<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">DELETE \/documents\/(DocumentID)\/layers\/(LayerID)<\/h4>\n\n\n\n<p>Remove a camada especificada do documento. Retorna 204 No Content em caso de sucesso. A elimina\u00e7\u00e3o ser\u00e1 recusada se a camada for uma camada de demonstra\u00e7\u00e3o obrigat\u00f3ria.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Ac\u00e7\u00f5es de camada<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/camadas\/(LayerID)\/setLive<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>Ativa uma camada. Quando esta op\u00e7\u00e3o \u00e9 chamada diretamente na camada, ser\u00e1 utilizada a \u00faltima variante de camada selecionada. Chamar isto numa camada j\u00e1 ativa n\u00e3o resultar\u00e1 num erro. O objeto de camada atualizado ser\u00e1 devolvido.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/camadas\/(LayerID)\/setOff<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>Desactiva uma camada. Chamar isso em uma camada j\u00e1 desativada n\u00e3o resultar\u00e1 em um erro. O objeto de camada atualizado ser\u00e1 devolvido.<\/p>\n\n\n\n<p><i>*<\/i>Como uma camada pode decidir fazer algumas anima\u00e7\u00f5es depois de chamar este m\u00e9todo, o objeto de camada devolvido pode estar no estado \"encerrado\" em vez de \"desligado\".<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/camadas\/(LayerID)\/toggleLive<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>Alterna uma camada entre \"ativa\" e \"desligada\".<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/layers\/(LayerID)\/signals\/(SignalID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>Desencadeia o sinal especificado por \"(SignalID)\" na \"variante em direto\" atual ou se a camada n\u00e3o estiver em direto na \"variante ativa\". Pode obter o \"(SignalID)\" a partir do campo \"input-values\" da camada (identificado pelo sufixo de chave \"_TypeSignal\").<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/layers\/(LayerID)\/cycleThroughVariants<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br><strong>Dispon\u00edvel desde: mimoLive 5.6<\/strong><br>Selecciona a variante seguinte ap\u00f3s 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 <b>seguinte<\/b>.<br>Chamar este ponto final n\u00e3o perturba o seu espet\u00e1culo se a camada estiver atualmente em direto. O efeito s\u00f3 aparece quando a camada \u00e9 colocada em direto posteriormente.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/layers\/(LayerID)\/cycleThroughVariantsBackwards<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados:<\/strong> \u201cGET\u201d \u201cPOST\u201d<br>Seleciona o <strong>anterior<\/strong> (o inverso de <code>\/cycleThroughVariants<\/code>) sem afetar o estado atual em direto. O efeito torna-se vis\u00edvel quando a camada ou a variante selecionada \u00e9 definida como ativa.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/layers\/(LayerID)\/setLiveFirstVariant<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados:<\/strong> \u201cGET\u201d \u201cPOST\u201d<br>Ativa o <strong>primeiro<\/strong> variante da camada e define a camada em direto.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/layers\/(LayerID)\/setLiveLastVariant<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados:<\/strong> \u201cGET\u201d \u201cPOST\u201d<br>Ativa o <strong>\u00faltimo<\/strong> variante da camada e define a camada em direto.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/layers\/(LayerID)\/inputs\/(SourceInputKey)\/mediacontrol\/(MediaControlCommand)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados:<\/strong> \u201cGET\u201d \u201cPOST\u201d<br>Envia um comando de controlo do suporte de dados para o suporte de dados ligado \u00e0 entrada \u201c(SourceInputKey)\u201d da camada especificada. Tenha em aten\u00e7\u00e3o que a fonte da entrada informa quais os comandos que suporta; consulte \/documents\/(DocumentID)\/sources\/(SourceID).<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><td><strong>Comando de controlo dos meios de comunica\u00e7\u00e3o<\/strong><\/td><td><strong>Descri\u00e7\u00e3o<\/strong><\/td><\/tr><tr><td>jogar<\/td><td>Inicia a reprodu\u00e7\u00e3o de multim\u00e9dia.<\/td><\/tr><tr><td>pausa<\/td><td>Faz uma pausa na reprodu\u00e7\u00e3o atual sem repor a posi\u00e7\u00e3o.<\/td><\/tr><tr><td>parar<\/td><td>P\u00e1ra a reprodu\u00e7\u00e3o e rep\u00f5e a posi\u00e7\u00e3o do suporte para o in\u00edcio.<\/td><\/tr><tr><td>inverter<\/td><td>Reproduz os ficheiros multim\u00e9dia na dire\u00e7\u00e3o inversa.<\/td><\/tr><tr><td>rebobinar<\/td><td>Faz retroceder a reprodu\u00e7\u00e3o, normalmente a um ritmo mais r\u00e1pido do que o normal.<\/td><\/tr><tr><td>avan\u00e7ar rapidamente<\/td><td>Avan\u00e7a rapidamente a reprodu\u00e7\u00e3o.<\/td><\/tr><tr><td>ignorar o in\u00edcio<\/td><td>Salta para o in\u00edcio do meio de comunica\u00e7\u00e3o.<\/td><\/tr><tr><td>saltar para o fim<\/td><td>Salta para o fim dos meios de comunica\u00e7\u00e3o social.<\/td><\/tr><tr><td>saltar para tr\u00e1s<\/td><td>Salta para tr\u00e1s num intervalo de 10 segundos.<\/td><\/tr><tr><td>saltar \u00e0 frente<\/td><td>Salta para a frente num intervalo de 10 segundos.<\/td><\/tr><tr><td>registo<\/td><td>Inicia a grava\u00e7\u00e3o da entrada do suporte de dados.<\/td><\/tr><tr><td>baralhar<\/td><td>Alterna a ordem de reprodu\u00e7\u00e3o aleat\u00f3ria dos itens multim\u00e9dia.<\/td><\/tr><tr><td>repetir<\/td><td>Repita os meios de comunica\u00e7\u00e3o actuais.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">Variantes<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Consulta de variantes<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/camadas\/(LayerID)\/variantes<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\"<\/strong><br>Devolve uma lista de variantes para a camada especificada por \"(LayerID)\" e o documento especificado por \"(DocumentID)\". Para obter informa\u00e7\u00f5es sobre os objectos devolvidos, consulte o tipo de dados \"variantes\".<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/camadas\/(LayerID)\/variantes\/(VariantID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\", \"<span class=\"caps\">PUT<\/span>\"<\/strong><br>Devolve uma \u00fanica variante especificada por \"(VariantID)\" e \"(LayerID)\" no documento especificado por \"(DocumentID)\". Consulte o tipo de dados \"variants\" para obter mais informa\u00e7\u00f5es sobre os dados devolvidos.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Modifica\u00e7\u00e3o de uma variante<\/h3>\n\n\n\n<p>Para definir o nome da variante ou dos valores de entrada, efetuar um \"<span class=\"caps\">PUT<\/span>\" com um pedido de <span class=\"caps\">JSON<\/span> objeto codificado para o ponto final da variante. Os valores que n\u00e3o pretende alterar devem ser simplesmente exclu\u00eddos do <span class=\"caps\">JSON<\/span> tu \"<span class=\"caps\">PUT<\/span>\". Exemplo:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>{\n    \"name\": \"New name of the Variant\",\n    \"input-values\": { \n        \"tvGroup_Content__Subtitle\": \"This is a Test\"\n    }\n}<\/code><\/pre>\n\n\n\n<p>Depois de atualizar os valores, o mimoLive responder\u00e1 com um objeto variante atualizado. Tenha em mente que nem todos os valores podem ser aplicados instantaneamente ou podem ter um efeito apenas ap\u00f3s outro ciclo de renderiza\u00e7\u00e3o.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Ac\u00e7\u00f5es variantes<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/layers\/(LayerID)\/variants\/(VariantID)\/setLive<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>Ativa uma variante; se a camada propriet\u00e1ria n\u00e3o estiver ativa, tamb\u00e9m ser\u00e1 activada. Chamar isto a uma variante j\u00e1 ativa n\u00e3o resultar\u00e1 num erro. O objeto variante atualizado ser\u00e1 devolvido.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/layers\/(LayerID)\/variants\/(VariantID)\/setOff<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>Desactiva uma variante. Isto tamb\u00e9m far\u00e1 com que a camada propriet\u00e1ria seja desactivada.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/layers\/(LayerID)\/variants\/(VariantID)\/toggleLive<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>Alterna uma variante entre ativa e inativa.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/layers\/(LayerID)\/variants\/(VariantID)\/signals\/(SignalID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>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\").<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Fontes<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Cria\u00e7\u00e3o de fontes<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">POST \/documentos\/(DocumentID)\/sources<\/h4>\n\n\n\n<p>Cria uma nova fonte no documento a partir de um determinado tipo de fonte. Especifique o tipo atrav\u00e9s de source-type (por exemplo, com.boinx.mimoLive.sources.deviceVideoSource), forne\u00e7a opcionalmente um nome de apresenta\u00e7\u00e3o e todos os par\u00e2metros que podem ser actualizados atrav\u00e9s da API HTTP. Devolve o objeto de fonte recentemente criado.<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl -X POST \"http:\/\/localhost:8989\/api\/v1\/documents\/(DocumentID)\/sources\" \\\n  -H \"Content-Type: application\/json\" \\\n  -d '{\n    \"source-type\": \"com.boinx.mimoLive.sources.deviceVideoSource\",\n    \"name\": \"Main Camera\"\n  }'\n\nValid source type identifiers:<\/code><\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><td><strong>Identificadores de tipo de fonte<\/strong><\/td><td><strong>Fonte<\/strong><\/td><\/tr><tr><td>com.boinx.mimoLive.sources.webBrowserSource<\/td><td>Navegador Web<\/td><\/tr><tr><td>com.boinx.mimoLive.sources.screenCaptureSource<\/td><td>Captura de ecr\u00e3<\/td><\/tr><tr><td>com.boinx.mimoLive.sources.ffmpegSource<\/td><td>NDI \/ Captura de v\u00eddeo<\/td><\/tr><tr><td>com.boinx.mimoLive.sources.webRTCSource<\/td><td>mimoCall<\/td><\/tr><tr><td>com.boinx.mimoLive.sources.windowCaptureSource<\/td><td>Captura de janelas<\/td><\/tr><tr><td>com.boinx.mimoLive.sources.deviceAudioSource<\/td><td>Dispositivo \u00e1udio<\/td><\/tr><tr><td>com.boinx.mimoLive.sources.deviceVideoSource<\/td><td>Combina\u00e7\u00e3o de um dispositivo de v\u00eddeo e \u00e1udio (c\u00e2mara)<\/td><\/tr><tr><td>com.boinx.mimoLive.sources.lastRecordingSource<\/td><td>\u00daltima grava\u00e7\u00e3o<\/td><\/tr><tr><td>com.boinx.mimoLive.sources.zoomparticipant<\/td><td>Participante no Zoom<\/td><\/tr><tr><td>e muito mais...<\/td><td><\/td><\/tr><tr><td><\/td><td><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Consulta de fontes<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/sources<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\"<\/strong><br>Devolve uma lista de fontes para o documento especificado por \"(DocumentID)\". Para obter informa\u00e7\u00f5es sobre os objectos devolvidos, consulte o tipo de dados \"sources layer\".<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/sources\/(SourceID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\", \"<span class=\"caps\">PUT<\/span>\"<\/strong><br>Devolve uma \u00fanica fonte especificada por \"(SourceID)\" no documento especificado por \"(DocumentID)\". Na sec\u00e7\u00e3o inclu\u00edda da resposta, todos os objectos \"filter\" relacionados com esta fonte tamb\u00e9m ser\u00e3o devolvidos (carregamento lateral). Ver o tipo de dados \"sources\" para mais informa\u00e7\u00f5es sobre os dados devolvidos.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/sources\/(SourceID)\/preview<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\"<\/strong><br>Devolve uma pr\u00e9-visualiza\u00e7\u00e3o gr\u00e1fica da fonte especificada por \"(SourceID)\" no documento especificado por \"(DocumentID)\". O ponto final suporta os seguintes par\u00e2metros:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><th>Par\u00e2metro<\/th><th>Predefini\u00e7\u00e3o<\/th><th>Descri\u00e7\u00e3o<\/th><\/tr><tr><td>formato<\/td><td>png<\/td><td>O formato em que a pr\u00e9-visualiza\u00e7\u00e3o \u00e9 devolvida. Valores permitidos: png, jpeg, mjpeg, mpng<\/td><\/tr><tr><td>fps<\/td><td>10<\/td><td>A taxa de quadros para visualiza\u00e7\u00f5es de imagens em movimento. Aplic\u00e1vel apenas aos formatos mjpeg e mpng. Tenha em aten\u00e7\u00e3o que 1 fps \u00e9 aproximadamente igual a 1% de <span class=\"caps\">CPU<\/span> utiliza\u00e7\u00e3o.<\/td><\/tr><tr><td>largura<\/td><td>(largura do documento)<\/td><td>A largura m\u00e1xima da pr\u00e9-visualiza\u00e7\u00e3o. A imagem ser\u00e1 reduzida para caber na largura indicada.<\/td><\/tr><tr><td>altura<\/td><td>(largura do documento)<\/td><td>A altura m\u00e1xima da pr\u00e9-visualiza\u00e7\u00e3o. A imagem ser\u00e1 reduzida para caber na altura indicada.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/sources\/(SourceID)\/mediacontrol\/(MediaControlCommand)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados:<\/strong> \u201cGET\u201d \u201cPOST\u201d<br>Controla a reprodu\u00e7\u00e3o de fontes com capacidade multim\u00e9dia (por exemplo, ficheiro multim\u00e9dia\/lista de reprodu\u00e7\u00e3o). Os comandos suportados dependem do tipo de fonte. Consulte \/documents\/(DocumentID)\/layers\/(LayerID)\/inputs\/(SourceInputKey)\/mediacontrol\/(MediaControlCommand) .<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/sources\/(SourceID)\/openwebbrowser<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados:<\/strong> \u201cGET\u201d<br>No caso de a fonte ser uma fonte de Captura do navegador da Web, esta a\u00e7\u00e3o abrir\u00e1 a janela do navegador da Web correspondente. <\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Modifica\u00e7\u00e3o de uma fonte<\/h3>\n\n\n\n<p>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\u00e7\u00e3o), execute um comando \"<span class=\"caps\">PUT<\/span>\" com um pedido de <span class=\"caps\">JSON<\/span> objeto codificado para o ponto final de origem. Os valores que n\u00e3o pretende alterar devem ser simplesmente exclu\u00eddos do <span class=\"caps\">JSON<\/span> tu \"<span class=\"caps\">PUT<\/span>\". Exemplo:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>{\n    \"name\": \"New name of the Source\",\n    \"gain\": 1.25,\n    \"input-values\": { \n        \"tvGroup_Content__Subtitle\": \"This is a Test\"\n    }\n}<\/code><\/pre>\n\n\n\n<p><i>*<\/i>O atributo \"gain\" foi adicionado no mimoLive 5.6 e \u00e9 ignorado em vers\u00f5es anteriores ou se a fonte n\u00e3o tiver controlo de ganho. O valor ser\u00e1 cortado para (0, 2), onde 0 \u00e9 silencioso, 1 \u00e9 a predefini\u00e7\u00e3o e 2 duplica aproximadamente o volume.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Elimina\u00e7\u00e3o de uma fonte<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">DELETE \/documents\/(DocumentID)\/sources\/(SourceID)<\/h4>\n\n\n\n<p>Remove a fonte especificada do documento. Devolve 204 No Content em caso de sucesso.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Ac\u00e7\u00f5es de origem<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/sources\/(SourceID)\/signals\/(SignalID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>Acciona o sinal especificado por \"(SignalID)\" na fonte (apenas se a fonte tiver \"valores de entrada\", por exemplo, se for uma Fonte de composi\u00e7\u00e3o). Pode obter o \"(SignalID)\" a partir do campo \"input-values\" da fonte (identificado pelo sufixo de chave \"_TypeSignal\").<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Filtros<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Consulta de filtros<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/sources\/(SourceID)\/filtros<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\"<\/strong><br>Devolve uma lista de filtros para a fonte especificada por \"(SourceID)\" e o documento especificado por \"(DocumentID)\". Para obter informa\u00e7\u00f5es sobre os objectos devolvidos, consulte o tipo de dados \"filters\".<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/fontes\/(SourceID)\/filtros\/(FilterID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\", \"<span class=\"caps\">PUT<\/span>\"<\/strong><br>Devolve um \u00fanico filtro especificado por \"(FilterID)\" e \"(SourceID)\" no documento especificado por \"(DocumentID)\". Ver o tipo de dados \"filters\" para mais informa\u00e7\u00f5es sobre os dados devolvidos.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Modificar um filtro<\/h3>\n\n\n\n<p>Para definir os valores de entrada, efetuar um \"<span class=\"caps\">PUT<\/span>\" com um pedido de <span class=\"caps\">JSON<\/span> objeto codificado para o ponto final do filtro. Os valores que n\u00e3o pretende alterar devem ser simplesmente exclu\u00eddos do <span class=\"caps\">JSON<\/span> tu \"<span class=\"caps\">PUT<\/span>\". Exemplo:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>{\n    \"input-values\": { \n        \"tvGroup_Content__Subtitle\": \"This is a Test\"\n    }\n}<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/sources\/(SourceID)\/filters\/(FilterID)\/signals\/(SignalID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>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\").<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Destinos de sa\u00edda<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Cria\u00e7\u00e3o de destinos de sa\u00edda<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">POST \/documents\/(DocumentID)\/output-destinations<\/h4>\n\n\n\n<p>Cria um novo destino de sa\u00edda no documento. Especifique o tipo atrav\u00e9s de output-destination-type e, opcionalmente, defina a posi\u00e7\u00e3o com o \u00edndice e o par\u00e2metro que pode ser atualizado atrav\u00e9s da API HTTP. Devolve o objeto de destino de sa\u00edda recentemente criado.<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th class=\"has-text-align-left\" data-align=\"left\"><code>Identificador do destino de sa\u00edda<\/code><\/th><th class=\"has-text-align-left\" data-align=\"left\">Destino de sa\u00edda<\/th><\/tr><\/thead><tbody><tr><td><code>com.boinx.mimoLive.outputDestination.liveStreaming<\/code><\/td><td>Transmiss\u00e3o em direto (RTMP, etc.)<\/td><\/tr><tr><td><code>com.boinx.mimoLive.outputDestination.fileRecording<\/code><\/td><td>Grava\u00e7\u00e3o de ficheiros<\/td><\/tr><tr><td><code>com.boinx.mimoLive.outputDestination.blackmagicDesign<\/code><\/td><td>Reprodu\u00e7\u00e3o (Blackmagic SDI\/HDMI)<\/td><\/tr><tr><td><code>com.boinx.mimoLive.outputDestination.ndi<\/code><\/td><td>Sa\u00edda NDI<\/td><\/tr><tr><td><code>com.boinx.mimoLive.outputDestination.fullscreen<\/code><\/td><td>Sa\u00edda de ecr\u00e3 completo<\/td><\/tr><tr><td><code>com.boinx.mimoLive.outputDestination.virtualCamera<\/code><\/td><td>C\u00e2mara virtual<\/td><\/tr><tr><td><code>com.boinx.mimoLive.outputDestination.mimoCall<\/code><\/td><td>mimoCall<\/td><\/tr><tr><td><code>com.boinx.mimoLive.outputDestination.audioMonitor<\/code><\/td><td>Monitor de \u00e1udio<\/td><\/tr><tr><td><code>com.boinx.mimoLive.outputDestination.imageSequence<\/code><\/td><td>Escritor de imagens<\/td><\/tr><tr><td><code>com.boinx.mimoLive.outputDestination.fileUploader<\/code><\/td><td>Carregador de ficheiros<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl -X POST \"http:\/\/localhost:8989\/api\/v1\/documents\/(DocumentID)\/output-destinations\" \\\n  -H \"Content-Type: application\/json\" \\\n  -d '{\n    \"output-destination-type\": \"com.boinx.mimoLive.outputDestination.fileRecording\",\n    \"index\": 0\n  }'<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Consulta de destinos de sa\u00edda<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/output-destinations<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\"<\/strong><br>Lista todos os destinos de sa\u00edda para o documento especificado.<br>Para obter informa\u00e7\u00f5es sobre os objectos devolvidos, ver o tipo de dados \"\"output-destinations\"\":{TOPIC-<span class=\"caps\">LINK<\/span>+data-typesh1(}. section-output-destinations).<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/output-destinations\/(OutputDestinationID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"GET\"<\/strong><br>Devolve o destino de sa\u00edda especificado por \"(OutputDestinationID)\".<br>Para obter informa\u00e7\u00f5es sobre os objectos devolvidos, ver o tipo de dados \"\"output-destinations\"\":{TOPIC-<span class=\"caps\">LINK<\/span>+data-typesh1(}. section-output-destinations).<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Modifica\u00e7\u00e3o de um destino de sa\u00edda<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/output-destinations\/(OutputDestinationID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"PUT\", \"<span class=\"caps\">PATCH<\/span>\"<\/strong><br>Actualiza as propriedades seleccionadas do destino de sa\u00edda especificado por \"(OutputDestinationID)\".<br>Devolve o destino de sa\u00edda atualizado.<\/p>\n\n\n\n<p>As seguintes propriedades s\u00e3o modific\u00e1veis:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>\"t\u00edtulo\"<\/li>\n\n\n\n<li>\"come\u00e7a com o espet\u00e1culo\"<\/li>\n\n\n\n<li>\"p\u00e1ra-com-o-espet\u00e1culo\"<\/li>\n\n\n\n<li>Conte\u00fado do objeto \"defini\u00e7\u00f5es\" (ver o <a href=\"\/pt\/%7BTOPIC-LINK+data-typesh1%28%7D\/\" target=\"_blank\" rel=\"noreferrer noopener\">descri\u00e7\u00e3o das defini\u00e7\u00f5es<\/a>. sec\u00e7\u00e3o-individual-settings) para mais informa\u00e7\u00f5es)<\/li>\n<\/ul>\n\n\n\n<p>A descri\u00e7\u00e3o da atualiza\u00e7\u00e3o deve ser apresentada em <a href=\"http:\/\/jsonapi.org\/format\/h1%28\" target=\"_blank\" rel=\"noreferrer noopener\"><span class=\"caps\">JSON<\/span>:Formato de atualiza\u00e7\u00e3o da API<\/a> . atualiza\u00e7\u00e3o de dados). Exemplo:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>{\n  \"data\": {\n    \"type\": \"output-destinations\",\n    \"id\": \"4FF003EA-D071-43FD-845F-DCD4A25DFA00\",\n    \"attributes\": {\n      \"title\": \"Our Recording\",\n      \"starts-with-show\": true,\n      \"settings\": {\n        \"location\": \"~\/Movies\"\n      }\n    }\n  }\n}<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Ac\u00e7\u00f5es de destino de sa\u00edda<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/output-destinations\/(OutputDestinationID)\/setLive<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>Faz com que o destino de sa\u00edda especificado por \"(OutputDestinationID)\" entre em funcionamento, se estiver corretamente configurado e tiver permiss\u00e3o para entrar em funcionamento (por exemplo, com base no estado de licenciamento mimoLive).<br>Se o destino de sa\u00edda puder ser ativado, \u00e9 devolvido o destino de sa\u00edda com o seu novo \"live-state\"; caso contr\u00e1rio, \u00e9 devolvido um erro \"409 Conflict\".<\/p>\n\n\n\n<p><i>*<\/i>Dado que um destino de sa\u00edda pode ter de realizar algum trabalho antes de ser colocado em direto (por exemplo, contactar um servi\u00e7o externo para criar um fluxo em direto), o objeto de destino de sa\u00edda devolvido pode estar no estado \"startup\" (arranque) em vez de \"live\" (em direto).<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/output-destinations\/(OutputDestinationID)\/setOff<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>Faz com que o destino de sa\u00edda especificado por \"(OutputDestinationID)\" pare.<br>Se o destino de sa\u00edda estiver autorizado a parar, o destino de sa\u00edda \u00e9 devolvido; caso contr\u00e1rio, \u00e9 devolvido um erro \"409 Conflito\".<\/p>\n\n\n\n<p><i>*<\/i>Como um destino de sa\u00edda pode ter de efetuar algum trabalho antes de parar as opera\u00e7\u00f5es, o destino de sa\u00edda devolvido pode estar no estado \"shutdown\" (encerramento) em vez de \"preview\" (pr\u00e9-visualiza\u00e7\u00e3o) (que seria a predefini\u00e7\u00e3o para um destino de sa\u00edda bem configurado).<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Conjuntos de camadas<\/h2>\n\n\n\n<p>Os conjuntos de camadas foram introduzidos no mimoLive 5.0 e permitem definir o estado ativo de v\u00e1rias camadas de uma s\u00f3 vez, permitindo a cria\u00e7\u00e3o de <strong>cenas<\/strong> para diferentes situa\u00e7\u00f5es num espet\u00e1culo.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Criar conjuntos de camadas<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">POST \/documents\/(DocumentID)\/layer-sets<\/h4>\n\n\n\n<p>Cria um novo conjunto de camadas no documento. Um conjunto de camadas \u00e9 uma cole\u00e7\u00e3o salva de a\u00e7\u00f5es que s\u00e3o aplicadas a uma ou mais camadas quando o conjunto de camadas \u00e9 recuperado. Para cada camada, especifique uma a\u00e7\u00e3o: \u201cao vivo\u201d (ativar, opcionalmente com uma variante espec\u00edfica), \u201cdesativar\u201d (desativa\u00e7\u00e3o gradual) ou \u201cfor\u00e7ar desativa\u00e7\u00e3o\u201d (desativa\u00e7\u00e3o imediata). Tamb\u00e9m pode definir a chamada no in\u00edcio do espet\u00e1culo e a chamada no fim do espet\u00e1culo para chamar automaticamente o conjunto de camadas quando o espet\u00e1culo come\u00e7a ou termina. Devolve o objeto de conjunto de camadas recentemente criado.<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl -X POST \"http:\/\/localhost:8989\/api\/v1\/documents\/(DocumentID)\/layer-sets\" \\\n  -H \"Content-Type: application\/json\" \\\n  -d '{\n    \"data\": {\n      \"attributes\": {\n        \"name\": \"Interview Scene\",\n        \"recall-on-show-start\": false,\n        \"recall-on-show-end\": false,\n        \"layers\": &#91;\n          {\n            \"layer-id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n            \"action\": \"live\",\n            \"variant\": \"edit-variant\"\n          },\n          {\n            \"layer-id\": \"YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY\",\n            \"action\": \"off\"\n          },\n          {\n            \"layer-id\": \"ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ\",\n            \"action\": \"force-off\"\n          }\n        ]\n      }\n    }\n  }'\n\n<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Consulta de conjuntos de camadas<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/conjuntos de camadas<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\"<\/strong><br>Lista todos os conjuntos de camadas para o documento especificado.<br>Para obter informa\u00e7\u00f5es sobre os objectos devolvidos, consulte o tipo de dados \u201cconjuntos de camadas\u201d.<\/p>\n\n\n\n<p><\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/layer-sets\/(LayerSetID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"GET\"<\/strong><br>Devolve o conjunto de camadas especificado por \"(LayerSetID)\".<br>Para obter informa\u00e7\u00f5es sobre os objectos devolvidos, ver o tipo de dados \"\"layer-sets\"\":{TOPIC-<span class=\"caps\">LINK<\/span>+data-typesh1(}. section-layer-sets).<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Modifica\u00e7\u00e3o de conjuntos de camadas<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/layer-sets\/(LayerSetID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"PUT\", \"<span class=\"caps\">PATCH<\/span>\"<\/strong><\/p>\n\n\n\n<p>Atualiza um conjunto de camadas existente. Voc\u00ea pode renome\u00e1-lo, alterar seu comportamento de chamada autom\u00e1tica ou substituir suas entradas de a\u00e7\u00e3o de camada. Inclua apenas os atributos que deseja alterar. Retorna o objeto do conjunto de camadas atualizado.<br><br><\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl -X PUT \"http:\/\/localhost:8989\/api\/v1\/documents\/(DocumentID)\/layer-sets\/(LayerSetID)\" \\\n  -H \"Content-Type: application\/json\" \\\n  -d '{\n    \"data\": {\n      \"attributes\": {\n        \"name\": \"Wide Shot Scene\",\n        \"layers\": &#91;\n          {\n            \"layer-id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n            \"action\": \"live\",\n            \"variant\": \"VVVVVVVV-VVVV-VVVV-VVVV-VVVVVVVVVVVV\"\n          },\n          {\n            \"layer-id\": \"YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY\",\n            \"action\": \"force-off\"\n          }\n        ]\n      }\n    }\n  }'\n<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Eliminar um conjunto de camadas<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">DELETE \/documents\/(DocumentID)\/layer-sets\/(LayerSetID)<\/h4>\n\n\n\n<p>Remove permanentemente o conjunto de camadas especificado do documento. Retorna 204 Sem conte\u00fado em caso de sucesso.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Ac\u00e7\u00f5es do conjunto de camadas<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">\/documents\/(DocumentID)\/layer-sets\/(LayerSetID)\/recall<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\" \"<span class=\"caps\">POST<\/span>\"<\/strong><br>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.<br>Devolve o conjunto de camadas ap\u00f3s a recupera\u00e7\u00e3o, ou seja, com \"active == true\".<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Armaz\u00e9ns de dados<\/h2>\n\n\n\n<h4 class=\"wp-block-heading\">\/documentos\/(DocumentID)\/datastores\/(StoreID)<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados: \"<span class=\"caps\">OBTER<\/span>\", \"<span class=\"caps\">PUT<\/span>\", \"<span class=\"caps\">APAGAR<\/span>\"<\/strong><br>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\u00e7\u00e3o que n\u00e3o h\u00e1 forma de listar todos os armazenamentos de dados associados a um documento (no entanto, pode criar algum tipo de <strong>\u00edndice<\/strong> que controla as suas outras lojas nomeadas dinamicamente).<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">Criar\/atualizar um armazenamento de dados<\/h4>\n\n\n\n<p>Para criar ou atualizar um armazenamento de dados, envie um \"<span class=\"caps\">PUT<\/span>\" para uma \"StoreID\" \u00e0 sua escolha com os dados associados no corpo do seu pedido. Se a opera\u00e7\u00e3o for bem sucedida, o mimoLive responder\u00e1 com o estado \"200 OK\".<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">Ler o conte\u00fado de um armazenamento de dados<\/h4>\n\n\n\n<p>Para ler um armazenamento de dados previamente armazenado, basta solicit\u00e1-lo atrav\u00e9s de \"<span class=\"caps\">OBTER<\/span>\". Os dados ser\u00e3o devolvidos exatamente como foram fornecidos no campo \"<span class=\"caps\">PUT<\/span>\" para o armazenar. Se n\u00e3o for encontrado nenhum armazenamento de dados com esse ID para este documento, o mimoLive devolver\u00e1 um erro \"404 Not Found\" (404 n\u00e3o encontrado).<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">Eliminar um armazenamento de dados existente<\/h4>\n\n\n\n<p>Para eliminar um armazenamento de dados quando j\u00e1 n\u00e3o precisar dele, basta emitir uma mensagem \"<span class=\"caps\">APAGAR<\/span>\" para o \"StoreID\" que pretende eliminar. No caso de o armazenamento de dados n\u00e3o existir, o mimoLive responder\u00e1 com um erro \"404 Not Found\" (404 n\u00e3o encontrado).<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Reuni\u00f5es Zoom<\/h2>\n\n\n\n<p>Estes pontos finais controlam a integra\u00e7\u00e3o do cliente Zoom incorporado no mimoLive.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/zoom\/join<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados:<\/strong> \u201cGET\u201d \u201cPOST\u201d<br>Junte-se a uma reuni\u00e3o Zoom. Par\u00e2metros t\u00edpicos (envie como corpo JSON para POST ou <code>?param=valor<\/code> para GET):<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><td><strong>Par\u00e2metro<\/strong><\/td><td><strong>Tipo de valor<\/strong><\/td><td><strong>Descri\u00e7\u00e3o<\/strong><\/td><\/tr><tr><td><code>reuni\u00e3oid<\/code><\/td><td><em>Cordas<\/em><\/td><td>N\u00famero da reuni\u00e3o Zoom (utilize \u201cDemo-Meeting-ID\u201d se pretender juntar-se \u00e0 reuni\u00e3o de demonstra\u00e7\u00e3o mimoLive)<\/td><\/tr><tr><td><code>c\u00f3digo de acesso<\/code><\/td><td><em>Cadeia de caracteres, opcional<\/em><\/td><td>C\u00f3digo de acesso \u00e0 reuni\u00e3o<\/td><\/tr><tr><td><code>c\u00f3digo do webinar<\/code><\/td><td><em>Cadeia de caracteres, opcional<\/em><\/td><td>Se quiser participar num webinar, tem de fornecer o token do webinar<\/td><\/tr><tr><td><code>nome de exibi\u00e7\u00e3o<\/code><\/td><td><em><em>Cordas<\/em>, facultativo<\/em><\/td><td>Nome a figurar na reuni\u00e3o<\/td><\/tr><tr><td><code>nome da conta de zoom<\/code><\/td><td><em><em><em>Cordas<\/em><\/em><\/em><\/td><td>Nome da conta Zoom conforme exibido nas configura\u00e7\u00f5es da conta Zoom do mimoLive<\/td><\/tr><tr><td>c\u00e2mara virtual<\/td><td>Cadeia de caracteres, opcional<\/td><td>Quando definido como \u201ctrue\u201d (verdadeiro), o mimoLive enviar\u00e1 o programa como um feed de v\u00eddeo para o Zoom<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p>Devolve um objeto de estado que indica o progresso ou o sucesso da liga\u00e7\u00e3o.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/zoom\/leave<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados:<\/strong> \u201cGET\u201d \u201cPOST\u201d<br>Sai da reuni\u00e3o em que se encontra. Devolve um objeto de estado.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/zoom\/end<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados:<\/strong> \u201cGET\u201d \u201cPOST\u201d<br>Tenta encerrar\/terminar a reuni\u00e3o Zoom atual (a\u00e7\u00e3o somente do host). Retorna sucesso se a reuni\u00e3o foi encerrada ou um conflito se o cliente n\u00e3o tiver permiss\u00e3o.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\/zoom\/participantes<\/h4>\n\n\n\n<p><strong>M\u00e9todos suportados:<\/strong> \u201cGET\u201d \u201cPOST\u201d<br>Devolve a lista de participantes atual para a reuni\u00e3o a que se juntou (nomes, IDs e estados b\u00e1sicos).<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><td><strong>Chave de valor<\/strong><\/td><td><strong>Tipo de valor<\/strong><\/td><td><strong>Descri\u00e7\u00e3o<\/strong><\/td><\/tr><tr><td>nome<\/td><td><em>Cordas<\/em><\/td><td>Nome do participante no Zoom<\/td><\/tr><tr><td>id<\/td><td><em>Inteiro<\/em><\/td><td>ID de utilizador do participante no Zoom<\/td><\/tr><tr><td>fun\u00e7\u00e3o de utilizador<\/td><td><em>Cordas<\/em><\/td><td><\/td><\/tr><tr><td>isHost<\/td><td><em>Bool<\/em><\/td><td>verdadeiro se o utilizador for o anfitri\u00e3o da reuni\u00e3o<\/td><\/tr><tr><td>isCoHost<\/td><td><em>Bool<\/em><\/td><td>verdadeiro se o utilizador for coanfitri\u00e3o da reuni\u00e3o<\/td><\/tr><tr><td>isVideoOn<\/td><td><em>Bool<\/em><\/td><td>verdadeiro se o utilizador tiver o v\u00eddeo ativado<\/td><\/tr><tr><td>isAudioOn<\/td><td><em>Bool<\/em><\/td><td>verdadeiro se o utilizador tiver o \u00e1udio ativado<\/td><\/tr><tr><td>isTalking<\/td><td><em>Bool<\/em><\/td><td>verdadeiro se o utilizador estiver a falar<\/td><\/tr><tr><td>isRaisingHand<\/td><td><em>Bool<\/em><\/td><td>verdadeiro se o utilizador estiver a levantar a m\u00e3o<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\">\/zoom\/meetingaction<\/h4>\n\n\n\n<p>Executa uma a\u00e7\u00e3o com \u00e2mbito de reuni\u00e3o. Fornecer <code>a\u00e7\u00e3o<\/code> e argumentos opcionais atrav\u00e9s do corpo JSON ou da cadeia de consulta.<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><td><strong>Par\u00e2metro<\/strong><\/td><td><strong>Tipo de valor<\/strong><\/td><td><strong>Descri\u00e7\u00e3o<\/strong><\/td><\/tr><tr><td>comando<\/td><td><em>Cordas<\/em><\/td><td>Um comando da lista abaixo<\/td><\/tr><tr><td>nome de utilizador<\/td><td><em>Cadeia de caracteres, opcional<\/em><\/td><td>Alguns comandos requerem um ID de utilizador<\/td><\/tr><tr><td>tipo de ecr\u00e3<\/td><td><em>Cadeia de caracteres, opcional<\/em><\/td><td>Alguns comandos requerem um tipo de ecr\u00e3<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><td><strong>Comando<\/strong><\/td><td><strong>Descri\u00e7\u00e3o<\/strong><\/td><\/tr><tr><td>requestRecordingPermission<\/td><td>Envie um pedido de autoriza\u00e7\u00e3o de registo local.<\/td><\/tr><tr><td>silenciarV\u00eddeo<\/td><td>Silencie o v\u00eddeo de um utilizador. (requer o par\u00e2metro userid)<\/td><\/tr><tr><td>desativar o som do v\u00eddeo<\/td><td>Abra o som do v\u00eddeo de um utilizador. (requer o par\u00e2metro userid)<\/td><\/tr><tr><td>silenciar\u00c1udio<\/td><td>Silencie o \u00e1udio de um utilizador. (requer o par\u00e2metro userid)<\/td><\/tr><tr><td>tirar o som do \u00e1udio<\/td><td>Desactive o \u00e1udio de um utilizador. (requer o par\u00e2metro userid)<\/td><\/tr><tr><td>enableUnmuteBySelf<\/td><td>Active a funcionalidade que permite que os utilizadores possam ativar o seu pr\u00f3prio som quando est\u00e3o silenciados, dispon\u00edvel apenas para o anfitri\u00e3o\/co-anfitri\u00e3o.<\/td><\/tr><tr><td>desactivarUnmuteBySelf<\/td><td>Desactive a funcionalidade que impede os utilizadores de se activarem quando est\u00e3o silenciados, dispon\u00edvel apenas para o anfitri\u00e3o\/co-anfitri\u00e3o.<\/td><\/tr><tr><td>silenciarTodos<\/td><td>Silencie todos os participantes na reuni\u00e3o, dispon\u00edvel apenas para o anfitri\u00e3o\/co-anfitri\u00e3o.<\/td><\/tr><tr><td>desativar o som de tudo<\/td><td>Abra o som de todos os participantes na reuni\u00e3o, dispon\u00edvel apenas para o anfitri\u00e3o\/co-anfitri\u00e3o.<\/td><\/tr><tr><td>lockMeeting<\/td><td>Bloqueie a reuni\u00e3o, dispon\u00edvel apenas para o anfitri\u00e3o\/co-anfitri\u00e3o. Uma vez bloqueada, os novos participantes j\u00e1 n\u00e3o podem aderir.<\/td><\/tr><tr><td>desbloquearReuni\u00e3o<\/td><td>Desbloqueie a reuni\u00e3o, dispon\u00edvel apenas para o anfitri\u00e3o\/co-anfitri\u00e3o.<\/td><\/tr><tr><td>baixarTodasAsM\u00e3os<\/td><td>Ponha as m\u00e3os de todos os participantes para baixo, dispon\u00edveis apenas para o anfitri\u00e3o\/co-anfitri\u00e3o.<\/td><\/tr><tr><td>shareFitWindowMode<\/td><td>Ajuste o tamanho do ecr\u00e3 para se adaptar \u00e0 janela.<\/td><\/tr><tr><td>pausaPartilha<\/td><td>Fa\u00e7a uma pausa na partilha.<\/td><\/tr><tr><td>curr\u00edculoPartilhe<\/td><td>Partilha de curr\u00edculos.<\/td><\/tr><tr><td>juntarVoip<\/td><td>Participe numa reuni\u00e3o por VoIP.<\/td><\/tr><tr><td>deixarVoip<\/td><td>Desligue o VoIP da reuni\u00e3o.<\/td><\/tr><tr><td>allowParticipantsToChat<\/td><td>Active a funcionalidade para que os utilizadores possam conversar entre si.<\/td><\/tr><tr><td>proibirParticipantesDoChat<\/td><td>Desactive a funcionalidade que permite aos utilizadores conversarem entre si.<\/td><\/tr><tr><td>allowParticipantsToShare<\/td><td>Active a funcionalidade para que os utilizadores possam partilhar o seu ecr\u00e3.<\/td><\/tr><tr><td>n\u00e3o permitir que os participantes partilhem<\/td><td>Desactive a funcionalidade que permite aos utilizadores partilharem o seu ecr\u00e3.<\/td><\/tr><tr><td>allowParticipantsToStartVideo<\/td><td>Active a funcionalidade para que os utilizadores possam iniciar o seu v\u00eddeo.<\/td><\/tr><tr><td>n\u00e3o permitir que os participantes iniciem o v\u00eddeo<\/td><td>Desactive a funcionalidade que permite aos utilizadores iniciar o seu v\u00eddeo.<\/td><\/tr><tr><td>permitir que os participantes partilhem o quadro branco<\/td><td>Active a funcionalidade para que os utilizadores possam partilhar um quadro branco.<\/td><\/tr><tr><td>n\u00e3o permitir que os participantes partilhem o quadro branco<\/td><td>Desactive a funcionalidade que permite aos utilizadores partilhar um quadro branco.<\/td><\/tr><tr><td>enableAutoAllowLocalRecordingRequest<\/td><td>Active a funcionalidade para que os pedidos de grava\u00e7\u00e3o dos utilizadores sejam automaticamente aceites.<\/td><\/tr><tr><td>disableAutoAllowLocalRecordingRequest<\/td><td>Desactive a funcionalidade que permite que os pedidos de grava\u00e7\u00e3o dos utilizadores sejam automaticamente aceites.<\/td><\/tr><tr><td>allowParticipantsToRename<\/td><td>Active a funcionalidade que permite aos utilizadores mudarem os seus nomes.<\/td><\/tr><tr><td>n\u00e3o permitir que os participantes sejam nomeados<\/td><td>Desactive a funcionalidade que permite aos utilizadores mudarem os seus nomes.<\/td><\/tr><tr><td>showParticipantProfilePictures<\/td><td>Active a op\u00e7\u00e3o para mostrar as imagens de perfil dos participantes.<\/td><\/tr><tr><td>hideParticipantProfilePictures (ocultar imagens do perfil do participante)<\/td><td>Desactive a op\u00e7\u00e3o de mostrar imagens de perfil dos participantes.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">Exemplo de utiliza\u00e7\u00e3o<\/h2>\n\n\n\n<p>Estes pontos de extremidade da API HTTP do mimoLive podem ser utilizados de v\u00e1rias formas. Consulte a sec\u00e7\u00e3o <a href=\"https:\/\/mimolive.com\/pt\/manual-do-utilizador\/personalizacao\/api-http\/exemplos-de-utilizacao-da-api\/\" data-type=\"user-manual\" data-id=\"32490\">Exemplos de utiliza\u00e7\u00e3o da API<\/a> sec\u00e7\u00e3o para saber mais.<\/p>\n\n\n\n<p><\/p>","protected":false},"excerpt":{"rendered":"<p>General The API, when enabled, is available at \u201chttp:\/\/localhost:8989\/api\/v1\u201d. This is the base URL that must be prepended to every method URL listed below. If a resource was introduced after the initial launch of the HTTP API, the method is marked with an Available since information. \/ Supported methods: \u201cGET\u201dRedirects to the list of open [&hellip;]<\/p>","protected":false},"author":3,"featured_media":0,"parent":32486,"menu_order":0,"template":"","meta":{"_acf_changed":false,"_angie_page":false,"_lmt_disableupdate":"","_lmt_disable":"","footnotes":""},"categories":[258],"tags":[],"class_list":["post-32488","user-manual","type-user-manual","status-publish","hentry","category-manual"],"acf":[],"_links":{"self":[{"href":"https:\/\/mimolive.com\/pt\/wp-json\/wp\/v2\/user-manual\/32488","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/mimolive.com\/pt\/wp-json\/wp\/v2\/user-manual"}],"about":[{"href":"https:\/\/mimolive.com\/pt\/wp-json\/wp\/v2\/types\/user-manual"}],"author":[{"embeddable":true,"href":"https:\/\/mimolive.com\/pt\/wp-json\/wp\/v2\/users\/3"}],"version-history":[{"count":9,"href":"https:\/\/mimolive.com\/pt\/wp-json\/wp\/v2\/user-manual\/32488\/revisions"}],"predecessor-version":[{"id":43700,"href":"https:\/\/mimolive.com\/pt\/wp-json\/wp\/v2\/user-manual\/32488\/revisions\/43700"}],"up":[{"embeddable":true,"href":"https:\/\/mimolive.com\/pt\/wp-json\/wp\/v2\/user-manual\/32486"}],"wp:attachment":[{"href":"https:\/\/mimolive.com\/pt\/wp-json\/wp\/v2\/media?parent=32488"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mimolive.com\/pt\/wp-json\/wp\/v2\/categories?post=32488"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mimolive.com\/pt\/wp-json\/wp\/v2\/tags?post=32488"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}