General

En APIcuando está activada, está disponible en "http://localhost:8989/api/v1". Esta es la base URL que debe anteponerse a cada método URL que figuran a continuación.

Si un recurso se introdujo después del lanzamiento inicial del HTTP APIel método se marca con un Disponible desde información.

/

Métodos admitidos: "GET"
Redirige a la lista de documentos abiertos en "/documents".

Documentos

Consulta de documentos

/documentos

Métodos admitidos: "GET"
Devuelve una lista de documentos abiertos. Consulte el tipo de datos de los documentos para saber qué información contienen los objetos devueltos.

/documentos/(DocumentID)

Métodos admitidos: "GET"
Devuelve un único documento especificado por el "(DocumentID)". En la sección incluida de la respuesta se devolverán también todos los objetos "capa" utilizados por este documento y todos los objetos "origen" contenidos en este documento (sideloading). Consulte el tipo de datos de los documentos para obtener más información sobre los datos devueltos.

/documentos/(DocumentID)/programaSalida

Métodos admitidos: "GET"
La salida del programa producida actualmente por el documento especificado por "(DocumentID)".
Toma los mismos parámetros que las previsualizaciones de origen.

Acciones documentales

/documentos/(DocumentID)/setLive

Métodos admitidos: "GET" "POST"
Inicia un espectáculo/documento y activa todos los eventos asociados. No se producirá ningún error si se llama a un documento que ya se está ejecutando. Se devolverá el objeto documento actualizado.

/documentos/(DocumentID)/setOff

Métodos admitidos: "GET" "POST"
Detiene un programa/documento. Llamar a esto en un espectáculo ya detenido no dará lugar a un error. Se devolverá el objeto documento actualizado.

*Debido a que un documento puede decidir seguir ejecutándose después de llamar a este método, el objeto de capa devuelto podría estar en estado "apagado" en lugar de "desactivado".

/documentos/(DocumentID)/toggleLive

Métodos admitidos: "GET" "POST"
Alterna un programa/documento entre en directo y desactivado.

Capas

Consulta de capas

/documentos/(DocumentID)/capas

Métodos admitidos: "GET"
Devuelve una lista de capas para el documento especificado por "(DocumentID)". Para obtener información sobre los objetos devueltos, consulte el tipo de datos layers.

/documentos/(DocumentID)/capas/(LayerID)

Métodos admitidos: "GET", "PUT"
Devuelve una única capa especificada por "(LayerID)" en el documento especificado por "(DocumentID)". En la sección "included" de la respuesta se devolverán también todos los objetos "variant" relacionados con esta capa (sideloading). Consulte el tipo de datos de las capas para obtener más información sobre los datos devueltos. Tenga en cuenta que los "valores de entrada" del punto final de la capa reflejan los "valores de entrada" de la variante "liveVariant" asociada.

Modificar una capa

Métodos admitidos: "GET", "PUT"
Para ajustar el nombre de la capa, el volumen de audio o los valores de entrada realice una "PUT"con una JSON al punto final de la capa. También puede utilizar un "GET"añadiendo el campo JSON datos al URL con la clave "?update=". En este caso, el JSON los datos deben ser URL codificado.

Los valores que no desee modificar simplemente deben excluirse de la función JSON datos. Ejemplo:

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

Tras actualizar los valores, mimoLive responderá con un objeto de capa actualizado. Tenga en cuenta que no todos los valores pueden ser aplicados instantáneamente o sólo pueden tener efecto después de otro ciclo de renderizado.

Nota: El atributo "volumen" se ha añadido en mimoLive 5.6 y se ignora en versiones anteriores o si la capa no tiene control de volumen. El valor se recortará a (0, 1), donde 0 es silencio y 1 es volumen máximo.

Acciones de capa

/documentos/(DocumentID)/capas/(LayerID)/setLive

Métodos admitidos: "GET" "POST"
Activa una capa, cuando esto se llama directamente en la capa, se utilizará la última variante de capa seleccionada. Si se ejecuta sobre una capa ya activada, no se producirá ningún error. Se devolverá el objeto de capa actualizado.

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

Métodos admitidos: "GET" "POST"
Desactiva una capa. Si se llama a esto en una capa ya desactivada, no se producirá ningún error. Se devolverá el objeto de capa actualizado.

*Debido a que una capa puede decidir hacer algunas animaciones después de llamar a este método, el objeto de capa devuelto podría estar en estado "apagado" en lugar de "desactivado".

/documentos/(DocumentID)/capas/(LayerID)/toggleLive

Métodos admitidos: "GET" "POST"
Alterna una capa entre "vivo" y "apagado".

/documentos/(DocumentID)/capas/(LayerID)/señales/(SignalID)

Métodos admitidos: "GET" "POST"
Activa la señal especificada por "(SignalID)" en la "live-variant" actual o si la capa no está activa en la "active-variant". Puede obtener "(SignalID)" del campo "input-values" de la capa (identificado por el sufijo de clave "_TypeSignal").

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

Métodos admitidos: "GET" "POST"
Disponible desde: mimoLive 5.6
Selecciona la siguiente variante después de la variante actualmente activa de la capa "(LayerID)" para que sea la nueva variante activa de la capa. Esto puede utilizarse para seleccionar la variante (por ejemplo, de una capa Lower Third) que debe activarse. siguiente.
La llamada a este punto final no altera el espectáculo si la capa está activa en ese momento. El efecto solo se muestra cuando la capa se activa posteriormente.

Variantes

Consulta de variables

/documentos/(DocumentID)/capas/(LayerID)/variantes

Métodos admitidos: "GET"
Devuelve una lista de variantes para la capa especificada por "(LayerID)" y el documento especificado por "(DocumentID)". Para más información sobre los objetos devueltos, véase el tipo de datos "variants".

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

Métodos admitidos: "GET", "PUT"
Devuelve una única variante especificada por "(VariantID)" y "(LayerID)" en el documento especificado por "(DocumentID)". Consulte el tipo de datos "variants" para obtener más información sobre los datos devueltos.

Modificar una variante

Para establecer el nombre de la variante o los valores de entrada realice una operación "PUT"con una JSON al punto final de la variante. Los valores que no desee modificar simplemente deben excluirse de la variable JSON tú "PUT". Ejemplo:

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

Tras actualizar los valores, mimoLive responderá con un objeto variante actualizado. Tenga en cuenta que no todos los valores se pueden aplicar al instante o que sólo podrían tener efecto después de otro ciclo de renderizado.

Acciones variantes

/documentos/(DocumentID)/capas/(LayerID)/variantes/(VariantID)/setLive

Métodos admitidos: "GET" "POST"
Activa una variante; si la capa propietaria no está activa, también lo estará. Si se invoca esta opción en una variante ya activa, no se producirá ningún error. Se devolverá el objeto variante actualizado.

/documentos/(DocumentID)/capas/(LayerID)/variantes/(VariantID)/setOff

Métodos admitidos: "GET" "POST"
Desactiva una variante. Esto también hará que se desactive la capa propietaria.

/documentos/(DocumentID)/capas/(LayerID)/variantes/(VariantID)/toggleLive

Métodos admitidos: "GET" "POST"
Alterna una variante entre vivo y apagado.

/documentos/(DocumentID)/capas/(LayerID)/variantes/(VariantID)/señales/(SignalID)

Métodos admitidos: "GET" "POST"
Activa la señal especificada por "(SignalID)" en la variante. Puede obtener "(SignalID)" del campo "input-values" de la capa (identificado por el sufijo de clave "_TypeSignal").

Fuentes

Consulta de fuentes

/documentos/(DocumentID)/fuentes

Métodos admitidos: "GET"
Devuelve una lista de fuentes para el documento especificado por "(DocumentID)". Para obtener información sobre los objetos devueltos, consulte el tipo de datos "capa de fuentes".

/documentos/(DocumentID)/fuentes/(SourceID)

Métodos admitidos: "GET", "PUT"
Devuelve una única fuente especificada por "(SourceID)" en el documento especificado por "(DocumentID)". En la sección incluida de la respuesta se devolverán también todos los objetos "filtro" relacionados con esta fuente (sideloading). Consulte el tipo de datos "sources" para obtener más información sobre los datos devueltos.

/documentos/(DocumentID)/fuentes/(SourceID)/vista previa

Métodos admitidos: "GET"
Devuelve una vista previa gráfica de la fuente especificada por "(SourceID)" en el documento especificado por "(DocumentID)". El punto final admite los siguientes parámetros:

Parámetro	Por defecto	Descripción
formato	png	El formato en el que se devuelve la vista previa. Valores permitidos: png, jpeg, mjpeg, mpng.
fps	10	La velocidad de fotogramas para la previsualización de imágenes en movimiento. Sólo aplicable a los formatos mjpeg y mpng. Tenga en cuenta que 1 fps equivale aproximadamente a 1% de CPU utilización.
anchura	(anchura del documento)	La anchura máxima de la vista previa. La imagen se reducirá para ajustarse a la anchura dada.
altura	(anchura del documento)	La altura máxima de la vista previa. La imagen se reducirá para ajustarse a la altura dada.

Modificar una fuente

Para establecer el nombre de la fuente o los valores de entrada (sólo si la fuente tiene alguno, p. ej. es una Fuente de Composición) realice un "PUT"con una JSON al endpoint de origen. Los valores que no desee modificar simplemente deben excluirse de la directiva JSON tú "PUT". Ejemplo:

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

*El atributo "gain" se ha añadido en mimoLive 5.6 y se ignora en versiones anteriores o si la fuente no tiene control de ganancia. El valor se recortará a (0, 2), donde 0 es silencio, 1 es el valor predeterminado y 2 duplica aproximadamente el volumen.

Fuente Acciones

/documentos/(DocumentID)/fuentes/(SourceID)/señales/(SignalID)

Métodos admitidos: "GET" "POST"
Activa la señal especificada por "(SignalID)" en la fuente (sólo si la fuente tiene "input-values", por ejemplo, si es una fuente de composición). Puede obtener "(SignalID)" del campo "input-values" de la fuente (identificado por el sufijo clave "_TypeSignal").

Filtros

Consulta de filtros

/documentos/(DocumentID)/fuentes/(SourceID)/filtros

Métodos admitidos: "GET"
Devuelve una lista de filtros para la fuente especificada por "(SourceID)" y el documento especificado por "(DocumentID)". Para más información sobre los objetos devueltos, véase el tipo de datos "filters".

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

Métodos admitidos: "GET", "PUT"
Devuelve un único filtro especificado por "(FilterID)" y "(SourceID)" en el documento especificado por "(DocumentID)". Consulte el tipo de datos "filtros" para obtener más información sobre los datos devueltos.

Modificar un filtro

Para ajustar los valores de entrada realice una "PUT"con una JSON al punto final del filtro. Los valores que no desee modificar simplemente deben excluirse del filtro JSON tú "PUT". Ejemplo:

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

/documentos/(DocumentID)/fuentes/(SourceID)/filtros/(FilterID)/señales/(SignalID)

Métodos admitidos: "GET" "POST"
Activa la señal especificada por "(SignalID)" en el filtro. Puede obtener "(SignalID)" del campo "input-values" del filtro (identificado por el sufijo de clave "_TypeSignal").

Destinos de salida

Consulta de destinos de salida

/documentos/(DocumentID)/destinos de salida

textileRef:9996801466400ba8908856:linkStartMarker:“Métodos admitidos: "GET"
Disponible desde: mimoLive 4.2
Lista todos los destinos de salida del documento especificado.
Para obtener información sobre los objetos devueltos, consulte el tipo de datos ""destinos de salida"":{TOPIC-ENLACE+data-typesh1(}. sección-salida-destinos).

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

Métodos admitidos: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Disponible desde: mimoLive 4.2
Devuelve el destino de salida especificado por "(OutputDestinationID)".
Para obtener información sobre los objetos devueltos, consulte el tipo de datos ""destinos de salida"":{TOPIC-ENLACE+data-typesh1(}. sección-salida-destinos).

Modificar un destino de salida

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

Métodos admitidos: "PATCH"
Disponible desde: mimoLive 4.2
Actualiza las propiedades seleccionadas del destino de salida especificado por "(OutputDestinationID)".
Devuelve el destino de salida actualizado.

Las siguientes propiedades son modificables:

• "título
• "comienza-con-show"
• "para-con-el-espectáculo"
• Contenido del objeto "settings" (véase la sección descripción de la configuración. section-individual-settings) para más información)

La descripción de la actualización debe figurar en JSONFormato de actualización de la API . crud-updating). Ejemplo:

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

Salida Destino Acciones

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

Métodos admitidos: "GET" "POST"
Disponible desde: mimoLive 4.2
Hace que el destino de salida especificado por "(OutputDestinationID)" se active, si está configurado correctamente y tiene permiso para activarse (por ejemplo, en función del estado de licencia mimoLive).
Si el destino de salida puede activarse, se devuelve el destino de salida con su nuevo "estado activo"; de lo contrario, se devuelve un error "409 Conflicto".

*Debido a que un destino de salida puede necesitar realizar algún trabajo antes de estar en directo (por ejemplo, contactar con un servicio externo para crear un flujo en directo), el objeto de destino de salida devuelto puede estar en estado "startup" en lugar de "live".

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

Métodos admitidos: "GET" "POST"
Disponible desde: mimoLive 4.2
Hace que se detenga el destino de salida especificado por "(OutputDestinationID)".
Si se permite que el destino de salida se detenga, se devuelve el destino de salida; de lo contrario, se devuelve un error "409 Conflicto".

*Debido a que un destino de salida puede necesitar realizar algún trabajo antes de detener las operaciones, el destino de salida devuelto puede estar en estado "apagado" en lugar de "vista previa" (que sería el predeterminado para un destino de salida bien configurado).

Conjuntos de capas

Los conjuntos de capas se introdujeron en mimoLive 5.0 y permiten establecer el estado en directo de varias capas a la vez, lo que permite la creación de conjuntos de capas ligeros. escenas para diferentes situaciones en un espectáculo. Sólo se pueden crear y gestionar en mimoLive. API el acceso está restringido a la obtención y recordando conjuntos de capas (activadoras).

Consulta de conjuntos de capas

/documentos/(DocumentID)/conjuntos de capas

textileRef:9996801466400ba8908856:linkStartMarker:“Métodos admitidos: "GET"
Disponible desde: mimoLive 5.0
Lista todos los conjuntos de capas del documento especificado.
Para más información sobre los objetos devueltos, véase el tipo de datos ""conjuntos de capas"":{TOPIC-ENLACE+data-typesh1(}. section-layer-sets).

/documentos/(DocumentID)/conjuntos de capas/(LayerSetID)

Métodos admitidos: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Disponible desde: mimoLive 5.0
Devuelve el conjunto de capas especificado por "(LayerSetID)".
Para más información sobre los objetos devueltos, véase el tipo de datos ""conjuntos de capas"":{TOPIC-ENLACE+data-typesh1(}. section-layer-sets).

Acciones del conjunto de capas

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

Métodos admitidos: "GET" "POST"
Disponible desde: mimoLive 5.0
Recupera (activa) el conjunto de capas especificado por "(LayerSetID)", haciendo que todas las capas asuman el estado activo registrado en el conjunto de capas.
Devuelve el conjunto de capas después de la recuperación, es decir, con "active == true".

Almacenes de datos

/documentos/(DocumentID)/almacenes de datos/(StoreID)

Métodos admitidos: "GET", "PUT", "BORRAR"
mimoLive ofrece la posibilidad de almacenar los datos que proporciones dentro del archivo del documento, por ejemplo, para restaurar un estado en un momento posterior. Usted mismo puede elegir un "StoreID", pero tenga en cuenta que no hay forma de listar todos los almacenes de datos asociados a un documento (sin embargo, puede crear algún tipo de índice que realiza un seguimiento de sus otros almacenes con nombres dinámicos).

Crear/actualizar un almacén de datos

Para crear o actualizar un almacén de datos envíe un "PUT" a un "StoreID" de su elección con los datos asociados en el cuerpo de la petición. Si la operación se ha realizado correctamente, mimoLive responderá con el estado "200 OK".

Leer el contenido de un almacén de datos

Para leer un almacén de datos previamente almacenado basta con solicitarlo a través de "GET". Los datos se devolverán exactamente como los proporcionó en el campo "PUT"para almacenarlo. Si no se ha encontrado ningún almacén de datos con ese ID para este documento, mimoLive devolverá un error "404 Not Found".

Eliminar un almacén de datos existente

Para eliminar un almacén de datos cuando ya no lo necesite, sólo tiene que emitir un mensaje "BORRAR"para el "StoreID" que desea eliminar. En caso de que el almacén de datos no estuviera allí en primer lugar, mimoLive responderá con un error "404 Not Found".