Généralités

JSON (JavaScript Object Notation) est un format léger utilisé pour l’échange de données. Il est basé sur un sous-ensemble de langage JavaScript : la façon dont les objets sont construits en JavaScript.

Introduction à JSON

JSON repose sur deux structures :

• Une collection de paires nom/valeur : dans différents langages, cela se traduit par un objet, un enregistrement, une structure, un dictionnaire, une table de hachage, une liste à clés ou un tableau associatif.
• Une liste ordonnée de valeurs : dans la plupart des langages, cela se traduit par un tableau, un vecteur, une liste ou une séquence.

Voici un exemple de données JSON :

{
     "firstName": "John",
     "lastName": "Smith",
     "address": {
         "streetAddress": "21 2nd Street",
         "city": "New York",
         "state": "NY",
         "postalCode": 10021
     },
     "phoneNumbers": [
         "212 555-1234",
         "646 555-4567"
     ]
 }

Comment JSON interagit avec les processeurs Event Master

JSON utilise JSON-RPC (basé sur REST) pour interagir avec les processeurs Event Master tels que l’E2, le S3-4K et l’EX. JSON-RPC est un protocole d’appel de procédure à distance codé en JSON.

JSON-RPC fonctionne en envoyant une requête à un serveur implémentant ce protocole. Dans ce cas, le client est généralement un logiciel qui a l’intention d’appeler une méthode unique d’un système distant. Plusieurs paramètres d’entrée peuvent être transmis à la méthode distante sous la forme d’un tableau ou d’un objet, tandis que la méthode proprement dite peut renvoyer plusieurs données de sortie.

Il existe des JSON-RPC définis pour effectuer des tâches sur le processeur Event Master. L’utilisateur doit envoyer une requête JSON par l’intermédiaire de son application ou d’applications open source.

Ces applications doivent envoyer des requêtes sur l’adresse IP sur laquelle s’exécute le processeur Event Master et sur le port fixe 9999 (le serveur Web du processeur Event Master s’exécute sur le port 9999).

Utiliser JSON à partir de l’application Web

Pour utiliser les API JSON à partir de l’application Web, sélectionnez l’icône des réglages dans la barre de navigation du menu, puis API JSON-RPC dans le tableau de bord de l’application Web.

API JSON

Voici quelques-unes des API JSON définies pour contrôler le processeur Event Master. Si vous avez une configuration Event Master maître/esclave, JSON doit être envoyé à l’appareil maître. Pour toutes les requêtes, cette section explique le paramètre transmis ou utilisé dans les appels RPC. Si l’objet params est vide, cela signifie que l’API n’a pas besoin de paramètre.

Remarque : Les requêtes sont sensibles à la casse.

allTrans

• Définition :

  • Exécute la commande « allTrans (Trans. tout) ».

• Requête :

  • params : {} - ne nécessite aucun paramètre.

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params":{}, "method":"allTrans", "id":"1234", "jsonrpc":"2.0"}

cut

• Définition :

  • Exécute la commande « Cut (Couper) ».

• Requête :

  • params : {} - ne nécessite aucun paramètre.

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params":{}, "method":"cut", "id":"1234", "jsonrpc":"2.0"}

resetFrameSettings

• Définition :

  • Expose TOUS les types de réinitialisation sur le processeur Event Master avec différentes options.

• Requête :

  • params : {"reset":x},

    « x » peut être compris entre 0 et 5

    • 0 : réinitialisation progressive.
    • 1 : retour aux paramètres d’usine.
    • 2 : retour aux paramètres d’usine (sauvegarder IP).
    • 3 : retour aux paramètres d’usine (sauvegarder IP/EDID).
    • 4 : retour aux paramètres d’usine (sauvegarder VPID).
    • 5 : mise hors tension.

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params":{"reset": 0}, "method":"resetFrameSettings", "id":"1234", "jsonrpc":"2.0"}

powerStatus

• Définition :

  • Interroge l’état de la fiche d’alimentation du processeur Event Master. (Il peut y avoir 1 ou 2 emplacements d’alimentation dans le processeur Event Master).

• Requête :

  • params : {} - ne nécessite aucun paramètre.

• Réponse :

  • réponse : {FrameId1 :{ PwrStatus1, PwrStatus2},{FrameId2 :{ PwrStatus1, PwrStatus2}

    PwrStatus1 indique l’état d’alimentation du premier emplacement du processeur Event Master avec l’id de châssis FrameId1, FrameId2.

    PwrStatus2 indique l’état d’alimentation du second emplacement du processeur Event Master avec l’id de châssis FrameId1, FrameId2.

    • 0 : le module d’alimentation n’est pas présent.
    • 1 : le module d’alimentation est présent, mais il n’y a pas de câble d’alimentation.
    • 2 : le module d’alimentation est présent et le câble est branché, mais il n’y a pas de courant continu (CC).
    • 3 : le module d’alimentation est présent et tout va bien.
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params":{}, "method":"powerStatus", "id":"1234", "jsonrpc":"2.0"}

listPresets

• Définition :

  • Cette fonction permet d’interroger la liste des pré-réglages d’une destination particulière ou du système.

• Requête :

  • params : {"ScreenDest":x , "AuxDest":x},

    « x » peut être :

    • –2 : ne pas inclure de destinations de ce type. (A priorité sur l’ID particulier, s’il est transmis en tant que paramètre).
    • –1 : ne pas en tenir compte (tous les pré-réglages). (A priorité sur l’ID particulier, s’il est transmis en tant que paramètre).
    • 0-999 : pour voir les pré-réglages avec la destination de cet ID particulier dedans ou un tableau d’ID. Ex. : « ScreenDestination (destination Écran) » :[{"id": 2}, {"id": 3}]

• Réponse :

  • réponse : tableau de : [{"id": 0, "Name": "Preset3.00", "LockMode": 0, "presetSno":

    3.00}, {"id": 1, "Name": "Preset4.00", "LockMode": 0, "presetSno": 4.00}]

    • La réponse contient le tableau des pré-réglages. La réponse ci-dessus contient l’id, le nom, le mode de verrouillage et le numéro de série de tous les pré-réglages.
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params":{"ScreenDest": 0}, "method":"listPresets", "id":"1234", "jsonrpc":"2.0"}

listDestinationsForPreset

• Définition :

  • Répertorie le contenu d’un pré-réglage.

• Requête :

  • params : {"id":x },

    « x » peut être :

    • –1 : répertorie tous les pré-réglages.
    • 0-999 : répertorie uniquement ce pré-réglage spécifique.

• Réponse :

  • réponse : tableau de : [{"id": 0, "Name": "Preset3.00", "LockMode": 0, "presetSno":

    3.00, "ScreenDest":[{"id": 0}, {"id": 3}],"AuxDest":[{"id": 0},

    {"id": 1}]}]

    • La réponse contient le tableau des pré-réglages.
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • { "params":{"id": 0}, "method":"listDestinationsForPreset", "id":"1234",

    "jsonrpc":"2.0"}

savePreset

• Définition :

  • Crée un pré-réglage sur le processeur Event Master.

• Requête :

  • params : {"presetName": "NewPreset", "ScreenDestination":[{"id": 2}, {"id": 3}],

    "AuxDestination":[{"id": 1}, {"id": 2}]}

    • « presetName » : nom du pré-réglage à enregistrer.
    • ScreenDestinations : id de la destination Écran pour le pré-réglage à créer.
    • AuxDestinations : id de la destination Auxiliaire pour le pré-réglage à créer.
    • ScreenDestination, AuxDestinations sont des paramètres facultatifs. Si l’utilisateur ne l’a pas indiqué, le pré-réglage sera enregistré pour les destinations sélectionnées.

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"presetName": "NewPreset"}, "method":"savePreset", "id":"1234",

    "jsonrpc":"2.0"}

  • {"params": {"presetName": "NewPreset", "ScreenDestination":

    {"id": 0},"AuxDestination":{"id": 0}}, "method":"savePreset", "id":"1234",

    "jsonrpc":"2.0"}

  Points clés concernant le pré-réglage, qui sont les mêmes pour renommer, activer et supprimer :

  • « id » : id du pré-réglage.

  • « presetSno » : numéro de série prédéfini. L’utilisateur peut fournir un nombre à virgule flottante si nécessaire. Ex. : « presetSno » : 1,01, « presetSno » : 1,00, « presetSno » : 1, « presetSno » : 1,1, « presetSno » : 1,10.

    Veuillez noter que 1,1 et 1,10 ou 1,00 et 1 sont identiques.

  • « presetName » : nom du pré-réglage.

renamePreset

• Définition :

  • Renomme un pré-réglage sur le processeur Event Master. L’utilisateur peut renommer le pré-réglage avec l’id, le numéro de série du pré-réglage ou le nom du pré-réglage.
  • Envoyez l’un des paramètres pour renommer le pré-réglage.

• Paramètres de requête :

  • params : {"id": x, "newPresetName": "NewPresetName"}
  • params : {"presetSno": x.y, "newPresetName": "NewPresetName"}

  • params : {"presetName": "OldPresetName", "newPresetName": "NewPresetName"}

    • « newPresetName » : nouveau nom de pré-réglage à définir.

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"id": 0, "newPresetName": " newPresetName "},

    "method":"renamePreset", "id":"1234", "jsonrpc":"2.0"}

  • {"params": {"presetName": "NewPreset", "newPresetName": "NewPresetName"},

    "method":"renamePreset", "id":"1234", "jsonrpc":"2.0"}

  • {"params": {"presetSno": 1.00, "newPresetName": " newPresetName "},

    "method":"renamePreset", "id":"1234", "jsonrpc":"2.0"}

activatePreset

• Définition :

  • Rappelle un pré-réglage sur le processeur Event Master. L’utilisateur peut rappeler le pré-réglage avec l’id, le numéro de série du pré-réglage ou le nom du pré-réglage.
  • Envoyez l’un des paramètres pour rappeler le pré-réglage.

• Paramètres de requête :

  • params : {"id": x, "type": x}
  • params : {"presetSno": x.y, "type": x}

  • params : {"presetName": "PresetName"}

    • « type » : 0 pour rappeler dans l’Aperçu (par défaut), 1 pour rappeler dans le Programme.

      Ce paramètre n’est pas obligatoire, mais il doit être indiqué lorsque l’utilisateur souhaite rappeler un pré-réglage dans le Programme.

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"id": 0, "type": 0}, "method":"activatePreset",

    "id":"1234", "jsonrpc":"2.0"} //Recall in preview with id 0.

  • {"params": {"presetName": "abc" }, "method":"activatePreset",

    "id":"1234", "jsonrpc":"2.0"} //Recall in preview with preset name "abc".

  • {"params": {"presetSno": 1.00, "type": 1}, "method":"activatePreset",

    "id":"1234", "jsonrpc":"2.0"} //Recall in program with presetSno 1.

recallNextPreset

• Définition :

  • Rappelle le pré-réglage suivant sur le processeur Event Master.

    Aucun paramètre n’est requis.

  • Assurez-vous que l’utilisateur a rappelé au moins un pré-réglage. L’application Web rappelle le pré-réglage suivant à partir du dernier pré-réglage rappelé.

• Requête :

  • params : {}

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)
  • Une erreur s’affiche si le dernier pré-réglage rappelé n’existe pas ou s’il n’y a pas de pré-réglage suivant dans la liste.

• Exemple :

  • {"params": {}, "method":"recallNextPreset", "id":"1234", "jsonrpc":"2.0"}

deletePreset

• Définition :

  • Supprime un pré-réglage sur le processeur Event Master.

    L’utilisateur peut supprimer le pré-réglage avec l’id, le numéro de série du pré-réglage ou le nom du pré-réglage.

  • Envoyez l’un des paramètres pour supprimer le pré-réglage.

• Requête :

  • params : {"id": x}
  • params : {"presetSno": x.y}
  • params : {"presetName": "PresetName"}

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"id": 1}, "method":"deletePreset", "id":"1234", "jsonrpc":"2.0"}
  • {"params": {"presetSno": 1.00}, "method":"deletePreset", "id":"1234", "jsonrpc":"2.0"}

  • {"params": {"presetName": "Preset 5.00"}, "method":"deletePreset",

    "id":"1234", "jsonrpc":"2.0"}

listDestinations

• Définition :

  • Cette API répertorie toutes les destinations avec des propriétés telles que les calques, les sorties, l’id, la taille et le nom.

• Requête :

  • params : {"type": x}

    • 0 : afficher toutes les destinations.

      0 est la valeur par défaut du paramètre de type.

    • 1 : destinations Écrans uniquement.
    • 2 : destinations Auxiliaires uniquement.

• Réponse :

  • réponse : tableau de : {"ScreenDestination":[{"id": 0, "Name": "Dest1", "HSize": 3840,

    "VSize": 1080, "Layers": 1,"DestOutMapColl":[{"id": 0"DestOutMap":[{"id":

    0, "Name": "Out1", "HPos": 0, "VPos": 0, "HSize": 1920, "VSize":1080,

    "Freeze": 0},{"id": 1, "Name": "Out2", "HPos": 1920, "VPos": 0,

    "HSize": 1920, "VSize":1080, "Freeze": 1}]}]}],"AuxDestination":

    [{"id": 0, "AuxStreamMode": 4}, {"id": 1, "AuxStreamMode": 4}]}"

  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"type": 0}, "method":"listDestinations", "id":"1234", "jsonrpc":"2.0"}

listSources

• Définition :

  • Cette API répertorie toutes les sources d’entrée avec leurs propriétés.

• Requête :

  • params : {"type": x}

    • 0 : affiche toutes les sources d’entrée.

      0 est la valeur par défaut du paramètre de type.

    • 1 : sources d’arrière-plan uniquement.

• Réponse :

  • réponse : tableau de : {"id": 0, "Name": "InSource1", "HSize": 3840, "VSize": 1080,

    "SrcType": 0, "InputCfgIndex": -1, "StillIndex": 0, "DestIndex": -1,

    "UserKeyIndex": -1, "Mode3D": 0, "Freeze": 1, "Capacity": 2,

    "InputCfgVideoStatus": 4}

    SrcType : 0 = entrée, 1 = magasin d’images fixes

    InputCfgVideoStatus : état de la vidéo d’entrée

    • 0 = non valide ; il y a synchronisation, mais il n’est pas possible d’acquérir/verrouiller
    • 1 = valide ; la vidéo est OK
    • 2 = MismatchFormat : mauvaise correspondance de format entre la configuration d’entrée et le ou les connecteurs
    • 3 = OutOfRange : la capacité du connecteur est trop faible pour acquérir le format
    • 4 = NoSync ; pas de vidéo
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"type": 0}, "method":"listSources", "id":"1234", "jsonrpc":"2.0"}

listContent

• Définition :

  • Cette API montre le contenu d’une destination Écran.

• Requête :

  • params : {"id": x}

    • « id » : index de destination d’écran.

• Réponse :

  • réponse : { "id": 0, "Name": "ScreenDest1""BGLyr":[{"id": 0, "LastBGSourceIndex":

    0, "BGShowMatte":0, "BGColor":[{"id":0, "Red":0, "Green":0, "Blue":0}]},

    {"id": 1, "LastBGSourceIndex": 0, "BGShowMatte":0, "BGColor":[{"id":0,

    "Red":0, "Green":0, "Blue":0}]}],(0 = PGM Background, 1 = PVW Background)

    "Layers":[{"id": 0, "LastSrcIdx": 0, "HPos": 0, "VPos": 0, "HSize": 400,

    "VSize": 300, "PvwMode": 0, "PgmMode": 0, "Freeze": 0, "FlexZOrder":

    0,"LayerTrans":[{"id": 0, "TransTime": 30, "TransPos": 0}, {"id": 1,

    "TransTime": 30, "TransPos": 0}] , "3D": "Yes", "Freeze": 0, "Capacity":

    2}]}]}

    • id : index de destination d’écran.
    • Name : nom de la destination Écran.

    • BGLyr : index du calque d’arrière-plan, dernier index de source d’arrière-plan.

      « id » : 0 affecte l’arrière-plan dans le Programme. « id » : 1 affecte l’arrière-plan dans l’Aperçu.

    • LastBGSoureIndex : il s’agit de –1 si aucun arrière-plan n’est déposé, sinon l’index du dernier arrière-plan déposé sur la destination Écran.
    • BGShowMatte : indique si le BG doit être un matte ou non.
    • BGColor : il s’agit de la couleur d’arrière-plan.
    • Layers : répertorie les calques des destinations Écrans avec leurs propriétés.
    • Transition : cette propriété de la destination Écran contient la durée de transition (durée du passage de l’Aperçu au Programme).
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"id": 0}, "method":"listContent", "id":"1234", "jsonrpc":"2.0"}

activateCue

• Définition :

  • Cette API offre la possibilité de lire/mettre en pause/arrêter un repère.
  • L’utilisateur peut rappeler le repère à l’aide d’un id, d’un numéro de série ou d’un nom.

• Requête :

  • params : {"id": 1, "type": x}, "method":"activateCue", "id":"1234", "jsonrpc":"2.0"}

    • id : index du repère
    • type - (la valeur par défaut est Play (Lecture)). « x » peut être : 0 - Play (Lecture). 0 est la valeur par défaut du paramètre de type. 1 - Pause, 2 - Stop (Arrêt)
  • params : {"cueName": "Cue1", "type": x}, "method":"activateCue", "id":"1234", "jsonrpc":"2.0"}
  • params : {"cueSerialNo": 1.00, "type": x}, "method":"activateCue", "id":"1234", "jsonrpc":"2.0"}

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"id": 1}, "method":"activateCue", "id":"1234", "jsonrpc":"2.0"} //Play – no parame or type 0
  • {"params": {"type": 1}, "method":"activateCue", "id":"1234", "jsonrpc":"2.0"} //Pause – type 1
  • {"params": {"type": 2}, "method":"activateCue", "id":"1234", "jsonrpc":"2.0"} //Stop – type 2

activateDestGroup

• Définition :

  • Rappelle un groupe de destinations sur le processeur Event Master. L’utilisateur peut rappeler un groupe de destinations à l’aide de l’id, du numéro de série du groupe de destinations ou du nom du groupe de destinations.
  • Envoyez l’un des paramètres pour rappeler le groupe de destinations.

• Requête :

  • params : {"id": x}
  • params : {"destGrpSno": x.y}
  • params : {"destGrName": "GroupName"}

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"id": 0}, "method":"activateDestGroup", "id":"1234", "jsonrpc":"2.0"}
  • {"params": {"destGrpName": "abc" }, "method":"activateDestGroup", "id":"1234", "jsonrpc":"2.0"}
  • {"params": {"destGrpSno": 1.00}, "method":"activateDestGroup", "id":"1234", "jsonrpc":"2.0"}

listCues

• Définition :

  • Cette API répertorie tous les repères.

• Requête :

  • params : {}, "method":"listCues", "id":"1234", "jsonrpc":"2.0"}

• Réponse :

  • réponse : tableau d’objets repères.
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {}, "method":"listCues", "id":"1234", "jsonrpc":"2.0"}

3dControl

• Définition :

  • Cette API permet de modifier les contrôles 3D.

• Requête :

  • params : {"id" : id, "type": x, "syncSource": y, "syncInvert": z}

    • id : index de la configuration d’entrée.
    • Type : « x » peut être : 0 : type désactivé. 0 est la valeur par défaut du paramètre de type. 1 – Type Sequentia.
    • syncSource : « y » peut être : 1 - mini-Din 1, 2 - mini-Din 2, 3 - mini-Din 3, 4 - mini-Din 4. La valeur par défaut est 1.
    • syncInvert : « z » peut être : 0 : type désactivé. 0 est la valeur par défaut de syncInvert. 1 – Type Invert.
    • Pour réinitialiser, ne fournir aucun paramètre à l’exception d’« id ».

• Réponse :

  • réponse : {"id": 0, "Name": "InSource1", "HSize": 3840, "VSize": 1080,

    "Src-Type": 0, "InputCfgIndex": -1, "StillIndex": 0, "DestIndex": -1,

    "UserKeyIndex": -1, "Mode3D": 0, "Freeze": 1, "Capacity": 2,

    "InputCfgVideoStatus": 4}

  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"id": 1, "type": 0, "syncSource": 1, "syncInvert": 0},

    "method":"3dControl", "id":"1234", "jsonrpc":"2.0"}

changeContent

• Définition :

  • Cette API modifie le contenu d’une destination Écran en y ajoutant un arrière-plan et des calques.

• Requête :

  • params : {"id":0,"BGLyr":[{"id":0,"LastBGSourceIndex":0,"BGShowMatte":0,

    "BGColor":[{"id":0,"Red":0,"Green":0,"Blue":0}]},{"id":1,

    "LastBGSourceIndex":0,"BGShowMatte":0,"BGColor":

    [{"id":0,"Red":0,"Green":0,"Blue":0}]}],"Layers":

    [{"id":0,"LastSrcIdx":0,"Window":{"HPos":0,"VPos":0,"HSize":400,"VSize":300},

    "Source":{"HPos":0,"VPos":0,"HSize":1920,"VSize":1080}, "Mask":

    { "Left":0.01, "Right":10.1, "Top":0.0,"Bottom":0.0},"PvwMode":1,"PgmMode":0,

    "Freeze":0,"PgmZOrder":0,"PvwZOrder":0}]}

    • id : index de destination Écran.

    • BGLyr : index du calque d’arrière-plan, dernier index de source d’arrière-plan.

      « id » : 0 affecte l’arrière-plan dans le Programme. « id » : 1 affecte l’arrière-plan dans l’Aperçu.

    • Layers : informations sur les calques.
    • Window : taille de la fenêtre du calque.
    • Source : informations sur la source et taille.
    • Mask : découpe la partie visible du calque.
    • PvwMode : définissez 1 si vous souhaitez que le contenu soit dans l’Aperçu. (Valeur par défaut)
    • PgmMode : définissez 1 si vous souhaitez que le contenu soit dans le Programme.

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params":{"id":0,"BGLyr":[{"id":0,"LastBGSourceIndex":0,"BGShowMatte":0,

    "BGColor":[{"id":0,"Red":0,"Green":0,"Blue":0}]},{"id":1,

    "LastBGSourceIndex":0,"BGShowMatte":0,"BGColor":[{"id":0,"Red":0,

    "Green":0,"Blue":0}]}],"Layers":[{"id":0,"LastSrcIdx":0,

    "Window":{"HPos":0,"VPos":0,"HSize":400,"VSize":300},

    "Source":{"HPos":0,"VPos":0,"HSize":1920,"VSize":1080},

    "Mask":{ "Left":0.01, "Right":10.1, "Top":0.0,"Bottom":0.0},

    "PvwMode":1,"PgmMode":0,"Freeze":0,"PgmZOrder":0,"PvwZOrder":0}]},

    "method":"changeContent", "id":"1234", "jsonrpc":"2.0"}.

  • {"params":{"id":0, "TestPattern" :5 }, "method":"changeContent", "id":"1234", "jsonrpc":"2.0"}

freezeDestSource

• Définition :

  • Cette API permet de geler/dégeler les sources.

• Requête :

  • params : {"type": x, "id": y, "screengroup": z ,"mode": 0/1}

    Type : type de la source.

    • 0 : source d’entrée.
    • 1 : source d’arrière-plan.
    • 2 : destination Écran.
    • 3 : destination Auxiliaire.
  • id : index de la source.
  • Screengroup : pour une utilisation future. Toujours fixé à 0.
  • Mode - 0 : dégeler, 1 : geler.

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"type": 0, "id": 0, "screengroup": 0 ,"mode": 1},

    "method":"freezeDestSource", "id":"1234", "jsonrpc":"2.0"}

listStill

• Définition :

  • Cette API répertorie toutes les images fixes avec les propriétés suivantes : id, Name (Nom), H/V size (Taille H/V), LockMode (Mode de verrouillage), StillState (État de l’image fixe), PngState (État PNG), File size (Taille de fichier).

• Requête :

  • params : {}

• Réponse :

  • réponse : tableau de : [{"id":0,"Name":"StillStore1",

    "LockMode":0,"HSize":{"Min":0,"Max":99999,"$t":1920},"VSize":{"Min":0,

    "Max":99999,"$t":1080},"StillState":{"Min":0,"Max":4,"$t":3},"PngState":

    {"Min":0,"Max":2,"$t":0},"FileSize":{"Min":0,"Max":100000,"$t":9331.2}}]

    • id : index du magasin d’images fixes.
    • Nom : nom du magasin d’images fixes.
    • LockMode : pour une utilisation ultérieure. Toujours fixé à 0.
    • Taille H/V : tailles horizontale et verticale, valeur min., max. et actuelle. Il indique la valeur actuelle.
    • StillState (État de l’image fixe) : indique à l’utilisateur si l’image fixe est en cours de capture ou non, ou si elle est en cours de suppression.
    • PngState : les « PNG » des images fixes sont pour les vignettes que nous capturons pour les images fixes.
    • FileSize : taille du fichier créé en Ko.
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {}, "method":"listStill", "id":"1234", "jsonrpc":"2.0"}

deleteStill

• Définition :

  • Cette API permet de supprimer une image fixe.

• Requête :

  • params : {"id": x}

    • id : index de l’image fixe.

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params":{"id": 0}, "method":"deleteStill", "id":"1234", "jsonrpc":"2.0"}

takeStill

• Définition :

  • Cette API crée/écrase une image fixe.

• Requête :

  • params : { "type": x, "id": y, "file": z}

    • Type : 0 pour la source d’entrée, 1 pour la source BG.
    • id : index de la source. Si l’id de la source de la destination est fourni, aucune image fixe n’est créée et une erreur est affichée.
    • File (Fichier) : id du fichier d’image fixe. Si vous transmettez « file » : 5, cela crée « StillStore6 ».

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params":{"type":0 , "id": 1, "file": 5}, "method":"takeStill", "id":"1234",

    "jsonrpc":"2.0"}

    • Ceci crée une image fixe à partir de l’id de source d’entrée 1 en tant que StillStore6.

getFrameSettings

• Définition :

  • Cette API affiche les informations sur le système, dont toutes les informations sur les châssis.

• Requête :

  • params : {}

• Réponse :

  • {"System":{"id":0,"Name":"System1","FrameCollection":{"id":0,"Frame":

    {"id":"00:0c:29:0e:86:d4","Name":"E2","Contact":"","Version":"4.2.30738",

    "OSVersion":"NA","FrameType":0,"FrameTypeName":"E2","Enet":{"DhcpMode":0,

    "DhcpModeName":"Static","IP":"10.98.0.165","StaticIP":"192.168.000.175",

    "MacAddress":"00:0c:29:0e:86:d4","StaticMask":"255.255.255.000",

    "StaticGateway":"192.168.000.001"},"SysCard":{"SlotState":2,

    "CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":80,

    "CardTypeLabel":"System","CardID":0},"Slot":[{"Card":{"CardStatusID":2,

    "CardStatusLabel":"Ready","CardTypeID":70,"CardTypeLabel":"Expansion",

    "CardID":"thisissometextforid0"}},{"Card":{"CardStatusID":2,"CardStatusLabel":

    "Ready","CardTypeID":70,"CardTypeLabel":"Expansion","CardID":

    "thisissometextforid1"}},{"Card":{"CardStatusID":0,"CardStatusLabel":

    "Not Installed","CardTypeID":255,"CardTypeLabel":"Unknown","CardID":

    "Undefined"}},{"Card":{"CardStatusID":2,"CardStatusLabel":"Ready",

    "CardTypeID":1,"CardTypeLabel":"SDI Input","CardID":"thisissometextforid211"}},

    {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":3,"CardID":

    "thisissometextforid2"}},{"Card":{"CardStatusID":2,"CardStatusLabel":"Ready",

    "CardTypeID":0,"CardTypeLabel":"DVI Input","CardID":"thisissometextforid4"}},

    {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":2,

    "CardTypeLabel":"HDMI/DP Input","CardID":"thisissometextforid5"}},

    {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":2,

    "CardTypeLabel":"HDMI/DP Input","CardID":"thisissometextforid7"}},

    {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":2,

    "CardTypeLabel":"HDMI/DP Input","CardID":"thisissometextforid8"}},

    {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":2,

    "CardTypeLabel":"HDMI/DP Input","CardID":"thisissometextforid9"}},

    {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":22,

    "CardTypeLabel":"HDMI Output","CardID":"CardID3"}},{"Card":{"CardStatusID":2,

    "CardStatusLabel":"Ready","CardTypeID":22,"CardTypeLabel":"HDMI Output",

    "CardID":"CardID4"}},{"Card":{"CardStatusID":2,"CardStatusLabel":"Ready",

    "CardTypeID":21,"CardTypeLabel":"SDI Output","CardID":"CardID415"}},

    {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":40,

    "CardTypeLabel":"MVR","CardID":"CardID15"}},{"Card":{"CardStatusID":2,

    "CardStatusLabel":"Ready","CardTypeID":50,"CardTypeLabel":"VPU Scaler",

    "CardID":"thisissometextforid501"}},{"Card":{"CardStatusID":2,

    "CardStatusLabel":"Ready","CardTypeID":50,"CardTypeLabel":"VPU Scaler",

    "CardID":"thisissometextforid502"}},{"Card":{"CardStatusID":2,

    "CardStatusLabel":"Ready","CardTypeID":50,"CardTypeLabel":"VPU Scaler",

    "CardID":"thisissometextforid503"}},{"Card":{"CardStatusID":2,

    "CardStatusLabel":"Ready","CardTypeID":50,"CardTypeLabel":"VPU Scaler",

    "CardID":"thisissometextforid504"}},{"Card":{"CardStatusID":0,

    "CardStatusLabel":"Not Installed","CardTypeID":255,"CardTypeLabel":

    "Unknown","CardID":"Undefined"}},{"Card":{"CardStatusID":2,"CardStatusLabel":

    "Ready","CardTypeID":50,"CardTypeLabel":"VPU Scaler","CardID":

    "thisissometextforid505"}},{"Card":{"CardStatusID":2,"CardStatusLabel":"Ready",

    "CardTypeID":50,"CardTypeLabel":"VPU Scaler","CardID":

    "thisissometextforid506"}},{"Card":{"CardStatusID":2,"CardStatusLabel":"Ready",

    "CardTypeID":50,"CardTypeLabel":"VPU Scaler","CardID":

    "thisissometextforid507"}},{"Card":{"CardStatusID":2,"CardStatusLabel":"Ready",

    "CardTypeID":50,"CardTypeLabel":"VPU Scaler","CardID":

    "thisissometextforid508"}}]}}}}}

    • System (Système) : nom et index du système.
    • FrameCollection (Collection de châssis) : collection de châssis dans un système contenant des informations sur le châssis.
    • Frame (Châssis) : contient des informations sur le châssis.
    • Id : id Mac du châssis.
    • Name (Nom) : nom du châssis.
    • Contact : coordonnées.
    • Version : version actuelle du logiciel installé sur le châssis.
    • OSVersion (Version du système d’exploitation) : version actuelle du système d’exploitation installé sur le châssis.
    • FrameType (Type de châssis) : 0 : E2, 1 : S3, 2 : EX.
    • FrameTypeName (Nom du type de châssis) : type du châssis : E2/S3/EX.
    • Enet : paramètres Ethernet.
    • SysCard : informations sur la carte du système.
    • Slot (Emplacement) : liste d’informations sur les cartes d’entrée/sortie/extension.
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params":{}, "method":"getFrameSettings", "id":"1234", "jsonrpc":"2.0"}

listAuxContent

• Définition :

  • Cette API affiche les informations relatives à la destination Auxiliaire.

• Requête :

  • params : {"id" : x}

    • id : index de la destination Auxiliaire.

• Réponse :

  • réponse : {"id":0,"Name":"AuxDest1","PvwLastSrcIndex":0,"PgmLastSrcIndex":0}

    • id : index de la destination Auxiliaire.
    • Name : nom de la destination Auxiliaire.
    • PvwLastSrcIndex : index de la source d’entrée/d’arrière-plan dans la zone d’Aperçu.
    • PgmLastSrcIndex : index de la source d’entrée/d’arrière-plan dans la zone de Programme.
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"id": 0}, "method":"listAuxContent", "id":"1234", "jsonrpc":"2.0"}

changeAuxContent

• Définition :

  • Cette API modifie la source dans les destinations Auxiliaires.

• Requête :

  • params : {"id":x , "Name": "AuxDest1" , "PvwLastSrcIndex": y , "PgmLastSrcIndex": z}

    • id : index de la destination Auxiliaire.
    • Name : nom de la destination Auxiliaire. (Paramètre facultatif)
    • PvwLastSrcIndex : index de la source d’entrée/d’arrière-plan à définir dans la destination Auxiliaire de la zone d’Aperçu.
    • PgmLastSrcIndex : index de la source d’entrée/d’arrière-plan à définir dans la destination Auxiliaire de la zone de Programme.

• Réponse :

  • réponse : nul
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"id":0 , "Name": "AuxDest1" , "PvwLastSrcIndex": 6 ,

    "PgmLastSrcIndex": 1}, "method":"changeAuxContent", "id":"1234", "jsonrpc":"2.0"}

  • {"params":{"id":0, "TestPattern" :3 }, "method":"changeAuxContent", "id":"1234", "jsonrpc":"2.0"}

Abonnement et désabonnement

Lorsqu’un abonnement est effectué à partir d’une application basée sur JSON, une notification est envoyée au port IP où l’application est exécutée lorsqu’il y a un changement pour lequel l’utilisateur s’est abonné.

La notification proprement dite est envoyée de manière asynchrone sous la forme HTTP Post, avec la structure suivante : {result: {method:

"notification",notificationType: "ScreenDestChanged",change: { add: [2],

remove: [], update: [0, 1, 2] }}}.

Le champ « change » contient le(s) XmlId des écrans qui ont été ajoutés/supprimés ou mis à jour.

Remarque : Le redémarrage du processeur Event Master entraîne la perte de tous les abonnements et l’obligation de les refaire si nécessaire.

s’abonner

• Définition :

  • L’utilisateur peut utiliser cette API pour s’abonner à des événements de changement dans le processeur Event Master.
  • Une fois l’abonnement souscrit, l’API envoie une notification sous la forme d’un HTTP Post à l’adresse URL : http://hostname:port/.

• Requête :

  • params : {"hostname": hostname, "port": port, "notification" : notificationType[]}

    « hostname » : nom d’hôte ou adresse IP à laquelle les notifications sont envoyées.

    « port » : port TCP auquel les notifications sont envoyées.

    « notificationTypes » : groupe de notifications auxquelles l’utilisateur souhaite s’abonner.

    • ScreenDestChanged
    • AUXDestChanged
    • FrameChanged
    • NativeRateChanged
    • InputCfgChanged
    • SourceChanged
    • BGSourceChanged
    • PresetChanged
    • StillChanged
    • OutputCfgChanged
    • CueChanged

• Réponse :

  • réponse : {"method": "subscribe"}
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"hostname" : "192.168.247.131", "port": "3000", "notification" :

    ["ScreenDestChanged", "AUXDestChanged"]}, "method":"subscribe", "id":"1234",

    "jsonrpc":"2.0"}

unsubscribe

• Définition :

  • L’utilisateur peut utiliser cette API pour supprimer l’abonnement pour le nom d’hôte, le port et le type de notification donnés.

• Requête :

  • params : {"hostname": hostname, "port": port, "notification" : notificationType[]}

    « hostname » : nom d’hôte ou adresse IP à partir desquels l’abonnement doit être supprimé.

    « port » : port TCP.

    « notificationTypes » : groupe de notifications auxquelles l’utilisateur souhaite s’abonner.

    • ScreenDestChanged
    • AUXDestChanged
    • FrameChanged
    • NativeRateChanged
    • InputCfgChanged
    • SourceChanged
    • BGSourceChanged
    • PresetChanged
    • StillChanged
    • OutputCfgChanged
    • CueChanged

• Réponse :

  • réponse : {"method": "unsubscribe"}
  • succès : (0=succès, tout autre résultat est une erreur)

• Exemple :

  • {"params": {"hostname" : "192.168.247.131", "port": "3000", "notification" :

    ["ScreenDestChanged", "AUXDestChanged"]}, "method":"unsubscribe",

    "id":"1234", "jsonrpc":"2.0"}