mimoLive® - Manuel de l'utilisateur

Sélecteurs génériques
Correspondance exacte uniquement
Recherche dans le titre
Recherche dans le contenu
Sélecteurs de type de message

Manuel - Table des matières

Points finaux

Table des matières

Général

Le site APILorsqu'il est activé, il est disponible à l'adresse "http://localhost:8989/api/v1". Il s'agit de la base URL qui doit être ajouté à chaque méthode URL énumérés ci-dessous.

Si une ressource a été introduite après le lancement initial de la HTTP APIla méthode est marquée d'un Disponible depuis des informations.

/

Méthodes prises en charge : "GET"
Redirige vers la liste des documents ouverts à "/documents".

Documents

Interroger les documents

/documents

Méthodes prises en charge : "GET"
Donne une liste de documents ouverts. Voir le type de données "documents" pour connaître les informations contenues dans les objets renvoyés.

/documents/(DocumentID)

Méthodes prises en charge : "GET"
Renvoie un document unique spécifié par "(DocumentID)". Dans la section incluse de la réponse, tous les objets "layer" utilisés par ce document et tous les objets "source" contenus dans ce document seront également renvoyés (sideloading). Voir le type de données des documents pour plus d'informations sur les données renvoyées.

/documents/(DocumentID)/programOut

Méthodes prises en charge : "GET"
La sortie du programme qui est actuellement produite par le document spécifié par "(DocumentID)".
Prend les mêmes paramètres que les aperçus de la source.

Actions sur les documents

/documents/(DocumentID)/setLive

Méthodes prises en charge : "GET" "POST"
Démarre un spectacle/document et déclenche tous les événements associés. L'appel à cette fonction sur un document déjà en cours d'exécution n'entraînera pas d'erreur. L'objet document mis à jour sera renvoyé.

/documents/(DocumentID)/setOff

Méthodes prises en charge : "GET" "POST"
Arrête un spectacle/document. L'appel à cette fonction sur un spectacle déjà arrêté n'entraînera pas d'erreur. L'objet document mis à jour sera renvoyé.

*Comme un document peut décider de continuer à fonctionner après l'appel de cette méthode, l'objet de couche renvoyé peut être dans l'état "shutdown" au lieu de "off".

/documents/(DocumentID)/toggleLive

Méthodes prises en charge : "GET" "POST"
Permet de faire basculer une émission ou un document entre le direct et l'arrêt.

Couches

Interroger les couches

/documents/(DocumentID)/couches

Méthodes prises en charge : "GET"
Renvoie une liste de couches pour le document spécifié par "(DocumentID)". Pour plus d'informations sur les objets renvoyés, voir le type de données "layers".

/documents/(DocumentID)/couches/(LayerID)

Méthodes prises en charge : "GET", "PUT"
Renvoie une seule couche spécifiée par "(LayerID)" dans le document spécifié par "(DocumentID)". Dans la section "included" de la réponse, tous les objets "variant" liés à cette couche seront également renvoyés (sideloading). Voir le type de données des couches pour plus d'informations sur les données renvoyées. N'oubliez pas que les "valeurs d'entrée" du point de terminaison de la couche reflètent les "valeurs d'entrée" de la variante "liveVariant" associée.

Modifier un calque

Méthodes prises en charge : "GET", "PUT"
Pour définir le nom de la couche, le volume audio ou les valeurs d'entrée, effectuez une opération "PUT"avec une demande de JSON au point de terminaison de la couche. Vous pouvez également utiliser un "GET"en ajoutant l'élément JSON vers le site de l URL avec la clé "?update=". Dans ce cas, l'élément JSON les données doivent être URL codé.

Les valeurs que vous ne souhaitez pas modifier doivent être simplement exclues de la liste des valeurs. JSON données. Exemple :

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

Après la mise à jour des valeurs, mimoLive répondra avec un objet de couche mis à jour. Gardez à l'esprit que toutes les valeurs ne peuvent pas être appliquées instantanément ou qu'elles peuvent n'avoir un effet qu'après un autre cycle de rendu.

Remarque : l'attribut " volume " a été ajouté dans mimoLive 5.6 et est ignoré dans les versions antérieures ou si le calque n'a pas de contrôle du volume. La valeur sera ramenée à (0, 1), où 0 correspond au silence et 1 au volume maximum.

Actions sur les calques

/documents/(DocumentID)/couches/(LayerID)/setLive

Méthodes prises en charge : "GET" "POST"
Active un calque, lorsque cette fonction est appelée directement sur le calque, la dernière variante de calque sélectionnée sera utilisée. L'appel à cette fonction sur une couche déjà active n'entraînera pas d'erreur. L'objet de la couche mis à jour sera renvoyé.

/documents/(DocumentID)/couches/(LayerID)/setOff

Méthodes prises en charge : "GET" "POST"
Désactive une couche. L'appel à cette fonction sur une couche déjà désactivée n'entraînera pas d'erreur. L'objet couche mis à jour sera renvoyé.

*Parce qu'un calque peut décider d'effectuer des animations après l'appel de cette méthode, l'objet de calque retourné peut être dans l'état "shutdown" au lieu de "off".

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

Méthodes prises en charge : "GET" "POST"
Fait basculer un calque entre "live" et "off".

/documents/(DocumentID)/couches/(LayerID)/signaux/(SignalID)

Méthodes prises en charge : "GET" "POST"
Déclenche le signal spécifié par "(SignalID)" dans la "live-variant" courante ou si la couche n'est pas live dans la "active-variant". Vous pouvez obtenir le "(SignalID)" à partir du champ "input-values" de la couche (identifié par le suffixe de clé "_TypeSignal").

/documents/(DocumentID)/couches/(LayerID)/cycleThroughVariants

Méthodes prises en charge : "GET" "POST"
Disponible depuis : mimoLive 5.6
Sélectionne la variante suivante après la variante actuellement active de la couche "(LayerID)" pour être la nouvelle variante active de la couche. Cela peut être utilisé pour sélectionner la variante (par exemple, d'une couche Lower Third) qui doit être mise en service. suivant.
L'appel à ce point de terminaison ne perturbe pas votre spectacle si le calque est actuellement en direct. L'effet n'apparaît que lorsque le calque est mis en ligne par la suite.

Variantes

Interroger les variables

/documents/(DocumentID)/couches/(LayerID)/variantes

Méthodes prises en charge : "GET"
Renvoie une liste de variantes pour la couche spécifiée par "(LayerID)" et le document spécifié par "(DocumentID)". Pour plus d'informations sur les objets renvoyés, voir le type de données "variants".

/documents/(DocumentID)/couches/(LayerID)/variantes/(VariantID)

Méthodes prises en charge : "GET", "PUT"
Renvoie une seule variante spécifiée par "(VariantID)" et "(LayerID)" dans le document spécifié par "(DocumentID)". Voir le type de données "variants" pour plus d'informations sur les données renvoyées.

Modification d'une variante

Pour définir le nom de la variante ou des valeurs d'entrée, effectuez une opération "PUT"avec une demande de JSON au point de terminaison de la variante. Les valeurs que vous ne souhaitez pas modifier doivent être simplement exclues de l'objet encodé. JSON vous "PUT". Exemple :

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

Après la mise à jour des valeurs, mimoLive répondra avec un objet variante mis à jour. Gardez à l'esprit que toutes les valeurs ne peuvent pas être appliquées instantanément ou qu'elles peuvent n'avoir un effet qu'après un autre cycle de rendu.

Actions variantes

/documents/(DocumentID)/couches/(LayerID)/variantes/(VariantID)/setLive

Méthodes prises en charge : "GET" "POST"
Active une variante, si la couche propriétaire n'est pas en direct, elle sera également mise en direct. L'appel à cette fonction sur une variante déjà active n'entraînera pas d'erreur. L'objet variante mis à jour sera renvoyé.

/documents/(DocumentID)/couches/(LayerID)/variantes/(VariantID)/setOff

Méthodes prises en charge : "GET" "POST"
Désactive une variante. Cette opération entraîne également la désactivation de la couche propriétaire.

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

Méthodes prises en charge : "GET" "POST"
Fait basculer une variante entre la vie et la mort.

/documents/(DocumentID)/couches/(LayerID)/variantes/(VariantID)/signaux/(SignalID)

Méthodes prises en charge : "GET" "POST"
Déclenche le signal spécifié par "(SignalID)" sur la variante. Vous pouvez obtenir le "(SignalID)" à partir du champ "input-values" de la couche (identifié par le suffixe de clé "_TypeSignal").

Sources d'information

Interroger les sources

/documents/(DocumentID)/sources

Méthodes prises en charge : "GET"
Renvoie une liste de sources pour le document spécifié par "(DocumentID)". Pour plus d'informations sur les objets renvoyés, voir le type de données "sources layer".

/documents/(DocumentID)/sources/(SourceID)

Méthodes prises en charge : "GET", "PUT"
Renvoie une source unique spécifiée par "(SourceID)" dans le document spécifié par "(DocumentID)". Dans la section incluse de la réponse, tous les objets "filter" liés à cette source seront également renvoyés (sideloading). Voir le type de données "sources" pour plus d'informations sur les données renvoyées.

/documents/(DocumentID)/sources/(SourceID)/preview

Méthodes prises en charge : "GET"
Renvoie un aperçu graphique de la source spécifiée par "(SourceID)" dans le document spécifié par "(DocumentID)". Le point d'accès prend en charge les paramètres suivants :

ParamètresDéfautDescription
formatpngFormat dans lequel l'aperçu est renvoyé. Valeurs autorisées : png, jpeg, mjpeg, mpng
fps10Le taux de rafraîchissement pour les prévisualisations d'images animées. Ne s'applique qu'aux formats mjpeg et mpng. Veuillez noter que 1 ips équivaut approximativement à 1% de UNITÉ CENTRALE l'utilisation.
largeur(largeur du document)La largeur maximale de l'aperçu. L'image sera réduite pour tenir dans la largeur donnée.
hauteur(largeur du document)Hauteur maximale de l'aperçu. L'image sera réduite pour tenir dans la hauteur donnée.

Modification d'une source

Pour définir le nom de la source ou les valeurs d'entrée (uniquement si la source en possède, par exemple s'il s'agit d'une source de composition), effectuez une opération "PUT"avec une demande de JSON vers le point d'accès source. Les valeurs que vous ne souhaitez pas modifier doivent être simplement exclues de l'objet encodé. JSON vous "PUT". Exemple :

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

*L'attribut "gain" a été ajouté dans mimoLive 5.6 et est ignoré dans les versions antérieures ou si la source n'a pas de contrôle de gain. La valeur est ramenée à (0, 2), où 0 est silencieux, 1 est la valeur par défaut et 2 double approximativement le volume.

Actions de la source

/documents/(DocumentID)/sources/(SourceID)/signaux/(SignalID)

Méthodes prises en charge : "GET" "POST"
Déclenche le signal spécifié par "(SignalID)" sur la source (uniquement si la source a des "valeurs d'entrée", par exemple s'il s'agit d'une source de composition). Vous pouvez obtenir le "(SignalID)" à partir du champ "input-values" de la source (identifié par le suffixe de clé "_TypeSignal").

Filtres

Interroger les filtres

/documents/(DocumentID)/sources/(SourceID)/filtres

Méthodes prises en charge : "GET"
Renvoie une liste de filtres pour la source spécifiée par "(SourceID)" et le document spécifié par "(DocumentID)". Pour plus d'informations sur les objets renvoyés, voir le type de données "filters".

/documents/(DocumentID)/sources/(SourceID)/filtres/(FilterID)

Méthodes prises en charge : "GET", "PUT"
Renvoie un filtre unique spécifié par "(FilterID)" et "(SourceID)" dans le document spécifié par "(DocumentID)". Voir le type de données "filters" pour plus d'informations sur les données renvoyées.

Modifier un filtre

Pour définir les valeurs d'entrée, effectuez un "PUT"avec une demande de JSON au point de terminaison du filtre. Les valeurs que vous ne souhaitez pas modifier doivent être simplement exclues de l'objet encodé. JSON vous "PUT". Exemple :

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

/documents/(DocumentID)/sources/(SourceID)/filtres/(FilterID)/signaux/(SignalID)

Méthodes prises en charge : "GET" "POST"
Déclenche le signal spécifié par "(SignalID)" sur le filtre. Vous pouvez obtenir le "(SignalID)" à partir du champ "input-values" du filtre (identifié par le suffixe de clé "_TypeSignal").

Destinations de sortie

Interrogation des destinations de sortie

/documents/(DocumentID)/destinations de sortie

textileRef:9996801466400ba8908856:linkStartMarker:“Méthodes prises en charge : "GET"
Disponible depuis : mimoLive 4.2
Liste toutes les destinations de sortie pour le document spécifié.
Pour plus d'informations sur les objets renvoyés, voir le type de données ""output-destinations"":{TOPIC-LIEN+data-typesh1(}. section-output-destinations).

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

Méthodes prises en charge : “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Disponible depuis : mimoLive 4.2
Renvoie la destination de sortie spécifiée par "(OutputDestinationID)".
Pour plus d'informations sur les objets renvoyés, voir le type de données ""output-destinations"":{TOPIC-LIEN+data-typesh1(}. section-output-destinations).

Modification d'une destination de sortie

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

Méthodes prises en charge : "PATCH"
Disponible depuis : mimoLive 4.2
Mise à jour des propriétés sélectionnées de la destination de sortie spécifiée par "(OutputDestinationID)".
Renvoie la destination de sortie mise à jour.

Les propriétés suivantes sont modifiables :

  • "titre"
  • "commence-avec-spectacle"
  • "s'arrête avec le spectacle"
  • Contenu de l'objet "settings" (voir la rubrique description des paramètres. section-individual-settings) pour plus d'informations)

La description de la mise à jour doit être donnée en JSONFormat de mise à jour de l'API . crud-updating). Exemple :

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

Actions de sortie de la destination

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

Méthodes prises en charge : "GET" "POST"
Disponible depuis : mimoLive 4.2
Provoque la mise en service de la destination de sortie spécifiée par "(OutputDestinationID)", si elle est correctement configurée et autorisée à être mise en service (par exemple, sur la base de l'état de la licence mimoLive).
Si la destination de sortie peut être mise en service, la destination de sortie avec son nouvel "état en service" est renvoyée, sinon une erreur "409 Conflict" est renvoyée.

*Étant donné qu'une destination de sortie peut avoir besoin d'effectuer un certain travail avant d'être en direct (par exemple, contacter un service externe pour créer un flux en direct), l'objet de destination de sortie renvoyé peut être dans l'état "startup" au lieu de "live".

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

Méthodes prises en charge : "GET" "POST"
Disponible depuis : mimoLive 4.2
Provoque l'arrêt de la destination de sortie spécifiée par "(OutputDestinationID)".
Si la destination de sortie est autorisée à s'arrêter, la destination de sortie est renvoyée, sinon une erreur "409 Conflict" est renvoyée.

*Étant donné qu'une destination de sortie peut avoir besoin d'effectuer certains travaux avant d'arrêter les opérations, la destination de sortie renvoyée peut être dans l'état "shutdown" au lieu de "preview" (qui serait l'état par défaut d'une destination de sortie bien configurée).

Jeux de couches

Les ensembles de couches ont été introduits dans mimoLive 5.0 et permettent de définir l'état en direct de plusieurs couches à la fois, ce qui permet de créer des ensembles de couches légers. scènes pour les différentes situations d'un spectacle. Ils ne peuvent être créés et gérés que dans mimoLive. API l'accès est limité à l'obtention et à la rappelant (activant).

Interrogation des ensembles de couches

/documents/(DocumentID)/layer-sets

textileRef:9996801466400ba8908856:linkStartMarker:“Méthodes prises en charge : "GET"
Disponible depuis : mimoLive 5.0
Liste tous les jeux de calques pour le document spécifié.
Pour plus d'informations sur les objets renvoyés, voir le type de données "layer-sets":{TOPIC-LIEN+data-typesh1(}. section-layer-sets).

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

Méthodes prises en charge : “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Disponible depuis : mimoLive 5.0
Renvoie le jeu de couches spécifié par "(LayerSetID)".
Pour plus d'informations sur les objets renvoyés, voir le type de données "layer-sets":{TOPIC-LIEN+data-typesh1(}. section-layer-sets).

Actions sur les jeux de calques

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

Méthodes prises en charge : "GET" "POST"
Disponible depuis : mimoLive 5.0
Rappelle (active) le jeu de calques spécifié par "(LayerSetID)", ce qui fait que tous les calques prennent l'état en direct enregistré dans le jeu de calques.
Renvoie le jeu de calques après rappel, c'est-à-dire avec "active == true".

Magasins de données

/documents/(DocumentID)/datastores/(StoreID)

Méthodes prises en charge : "GET", "PUT", "DELETE"
mimoLive offre la possibilité de stocker les données que vous fournissez à l'intérieur du fichier du document, par exemple pour restaurer un état à un moment ultérieur. Vous êtes libre de choisir vous-même un "StoreID", mais sachez qu'il n'existe aucun moyen de répertorier tous les magasins de données associés à un document (toutefois, vous pouvez créer une sorte de "StoreID"). index qui assure le suivi de vos autres magasins, nommés dynamiquement).

Créer/mettre à jour un magasin de données

Pour créer ou mettre à jour un magasin de données, envoyez un message "PUT"vers un "StoreID" de votre choix avec les données associées dans le corps de votre demande. Si l'opération a réussi, mimoLive répondra par un statut "200 OK".

Lire le contenu d'un magasin de données

Pour lire un magasin de données précédemment stocké, il suffit de le demander via "GET". Les données seront renvoyées exactement comme vous les avez fournies dans le champ "PUT"pour le stocker. Si aucun magasin de données avec cet identifiant n'a été trouvé pour ce document, mimoLive renvoie une erreur "404 Not Found".

Supprimer un magasin de données existant

Pour supprimer un magasin de données lorsque vous n'en avez plus besoin, il vous suffit d'envoyer un message "DELETE"pour le "StoreID" que vous souhaitez supprimer. Si le magasin de données n'existe pas, mimoLive répondra par une erreur "404 Not Found".

Votre avis

Comment évaluez-vous votre expérience avec cette fonction de mimoLive ?

Dernière mise à jour Pages du manuel

Solution

Technologie

Magasin

Académie

Mentions légales

Soutien

Bulletin d'information par courriel

Copyright © 2024 par Boinx Software International GmbH. Tous droits réservés

Facebook Twitter Instagram Youtube
Français
English 简体中文 Nederlands Deutsch Bahasa Indonesia Italiano 日本語 한국어 Português Русский Español Svenska Українська Français

Participez à la démonstration Live Zoom® 24/7

*obligatoire

Vous devez charger le contenu de {{nom}} pour soumettre le formulaire. Veuillez noter que ce faisant, des données seront partagées avec des providers tiers.

Plus d'informations
Débloquer le contenu Accepter le service requis et débloquer le contenu