General

JSON (JavaScript Object Notation) is a lightweight format that is used for interchanging data. It is based on a subset of JavaScript language: the way objects are built in JavaScript.

Introduction to JSON

JSON is built on two structures:

• A collection of name/value pairs: In various languages, this is realized as an object, record, struct, dictionary, hash table, keyed list, or associative array.
• An ordered list of values: In most languages, this is realized as an array, vector, list, or sequence.

Here is an example of JSON data:

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

How JSON interacts with Event Master processors

JSON uses JSON RPC (REST based) to interact with Event Master processors. JSON-RPC is a remote procedure call protocol encoded in JSON.

JSON-RPC works by sending a request to a server implementing this protocol. The client in that case is typically software intending to call a single method of a remote system. Multiple input parameters can be passed to the remote method as an array or object, whereas the method itself can return multiple output data as well.

There are JSON RPCs defined to perform tasks on the Event Master processor. User needs to send JSON request through their application or open source application like Postman.

These applications should send request on IP where the Event Master processor is running and fixed port 9999 (Webserver of Event Master processor is running on port 9999).

Use JSON from the web application

To use the JSON APIs from the web application, select the Settings icon on the Menu navigation bar, and select JSONRPC API from the web app dashboard.

JSON APIs

Here are some of the JSON APIs defined for controlling the Event Master processor. If you have a master / slave Event Master setup, JSON must be sent to the master unit. For all the requests, this section explains the parameter passed or used in the RPC calls. If the params object is blank that means that API doesn’t require a parameter.

Note: Requests are case sensitive.

allTrans

• Definition:

  • It executes the “allTrans” command.

• Request:

  • params: {} - It doesn’t require any parameter.

• Response:

  • response: null
  • success: (0=success, anything else is an error)

• Example:

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

cut

• Definition:

  • It executes the “Cut” command.

• Request:

  • params: {} - It doesn’t require any parameter.

• Response:

  • response: null
  • success: (0=success, anything else is an error)

• Example:

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

resetFrameSettings

• Definition:

  • Expose ALL reset types on Event Master processor with different options.

• Request:

  • params: {"reset":x},

    “x” can be 0 – 5

    • 0: Soft reset.
    • 1: Factory reset.
    • 2: Factory reset (save IP).
    • 3: Factory reset (save IP/EDID).
    • 4: Factory reset (save VPID).
    • 5: Power down.

• Response:

  • response: null
  • success: (0=success, anything else is an error)

• Example:

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

powerStatus

• Definition:

  • This queries the power plug status of the Event Master processor. (There can be 1 or 2 power slots in Event Master processor).

• Request:

  • params: {} - It doesn’t require any parameter.

• Response:

  • response: {FrameId1 :{ PwrStatus1, PwrStatus2},{FrameId2 :{ PwrStatus1, PwrStatus2}

    • PwrStatus1 gives the power status of the 1st slot in Event Master processor with frame id FrameId1, FrameId2.

    • PwrStatus2 gives the power status of the 2nd slot in Event Master processor with frame id FrameId1, FrameId2.

      • 0: Power supply module is not present.
      • 1: Power supply module is present, but there is no power cable.
      • 2: Power supply module is present, and the cable is plugged in, but there is no DC current.
      • 3: Power supply module is present, and everything is OK.
  • success: (0=success, anything else is an error)

• Example:

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

listPresets

• Definition:

  • This queries the list of Presets on a particular destination or on the system.

• Request:

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

    “x” can be:

    • –2: Do not include any destinations of this type. (Has priority over particular id, if passed as a parameter.)
    • –1: Do not care (All presets). (Has priority over particular id, if passed as a parameter.)
    • 0–999: want to see the presets with the destination this particular id in it or array of ids. Eg. "ScreenDestination":[{"id": 2}, {"id": 3}]

• Response:

  • response: Array of: [{"id": 0, "Name": "Preset3.00", "LockMode": 0, "presetSno":

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

    • Response contains the array of presets. Above response contains id, name, lock mode preset serial number of the all the presets.
  • success: (0=success, anything else is an error)

• Example:

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

listDestinationsForPreset

• Definition:

  • Lists the content of a Preset.

• Request:

  • params: {"id":x },

    “x” can be:

    • –1: List all Presets.
    • 0–999: list only that specific Preset.

• Response:

  • response: Array of: [{"id": 0, "Name": "Preset3.00", "LockMode": 0, "presetSno":

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

    {"id": 1}]}]

    • Response contains the array of Presets.
  • success: (0=success, anything else is an error)

• Example:

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

    "jsonrpc":"2.0"}

savePreset

• Definition:

  • Creates a Preset on the Event Master processor.

• Request:

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

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

    • “presetName”—Name of the Preset to save.
    • ScreenDestinations—ScreenDest id for the Preset to be created.
    • AuxDestinations—AuxDest id for the Preset to be created.
    • ScreenDestination, AuxDestinations are optional parameters. If user didn’t provide it, Preset will be saved for selected destinations.

• Response:

  • response: null
  • success: (0=success, anything else is an error)

• Example:

  • {"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"}

  Key points regarding Preset, which are same for rename, activate, and delete:

  • “id”—id of the preset.

  • “presetSno”—preset serial number. User can provide floating point number if required. Eg. "presetSno": 1.01, "presetSno": 1.00, "presetSno": 1, "presetSno": 1.1, "presetSno": 1.10.

    Kindly note that 1.1 and 1.10 or 1.00 and 1 are same.

  • “presetName”—Name of the preset.

renamePreset

• Definition:

  • Rename a Preset on the Event Master processor. User can rename Preset with id, Preset serial number, or Preset name.
  • Send any one of the parameters to rename Preset.

• Request params:

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

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

    • “newPresetName”—New Preset name to set.

• Response:

  • response: null
  • success: (0=success, anything else is an error)

• Example:

  • {"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

• Definition:

  • Recall a Preset on the Event Master processor. User can recall Preset with id, Preset serial number, or Preset name.
  • Send any one of the parameters to recall Preset.

• Request params:

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

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

    • “type”—0 to recall in preview (default), 1 to recall in program.

      This is not a mandatory parameter but should be given when the user wants to recall a Preset in program.

• Response:

  • response: null
  • success: (0=success, anything else is an error)

• Example:

  • {"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

• Definition:

  • Recall the next Preset on the Event Master processor.

    No parameter is required.

  • Make sure that the user has at least recalled one Preset. Web app recalls the next Preset from the last Preset recalled.

• Request:

  • params: {}

• Response:

  • response: null
  • success: (0=success, anything else is an error)
  • An error is shown if there was no last recalled Preset or if there is no next Preset in the list.

• Example:

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

deletePreset

• Definition:

  • Delete a Preset on the Event Master processor.

    User can delete Preset with id, Preset serial number, or Preset name.

  • Send any one of the parameters to delete Preset.

• Request:

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

• Response:

  • response: null
  • success: (0=success, anything else is an error)

• Example:

  • {"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

• Definition:

  • This API lists all the destinations with properties such as layers, outputs, id, size, and name.

• Request:

  • params: {"type": x}

    • 0—Show all the destinations.

      0 is the default value for the type parameter.

    • 1—Only screen destinations.
    • 2—Only aux destinations.

• Response:

  • response: Array of : {"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}]}"

  • success: (0=success, anything else is an error)

• Example:

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

listSources

• Definition:

  • This API lists all the input sources with properties.

• Request:

  • params: {"type": x}

    • 0—Show all the input sources.

      0 is the default value for the type parameter.

    • 1—Only background sources.

• Response:

  • response: Array of : {"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 = Input, 1 = StillStore

    • InputCfgVideoStatus: Input video status

      • 0 = Invalid; there is sync, but cannot acquire / lock
      • 1 = Valid; Video is OK
      • 2 = MismatchFormat; Format mismatch between input cfg and connector(s)
      • 3 = OutOfRange; connector capacity is too low to acquire format
      • 4 = NoSync; no video
  • success: (0=success, anything else is an error)

• Example:

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

listContent

• Definition:

  • This API shows the content of a screen destination.

• Request:

  • params: {"id": x}

    • “id”—Screen destination index.

• Response:

  • response: { "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 of screen destination.
    • Name—Name of ScreenDestination.

    • BGLyr—Background layer index, Last source index of background.

      “id”:0 affects the Background in Program. “id”:1 affects the Background in Preview.

    • LastBGSoureIndex—This is –1 if no background is dropped, else this is index of last background dropped on screen destination.
    • BGShowMatte—This is if BG to be matte or not.
    • BGColor—This is background color.
    • Layers—Lists layers on screen destination with its properties.
    • Transition—This property of screen destination contains the transition time (from time to move from preview to program).
  • success: (0=success, anything else is an error)

• Example:

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

3dControl

• Definition:

  • This API provides the option to modify 3d Controls.

• Request:

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

    • id – Index of the input config.
    • type – "x" can be: 0 – Type Off. 0 is the default value for the type parameter. 1 – Type Sequentia.
    • syncSource – "y" can be: 1 – mini-Din 1, 2 – mini-Din 2, 3 – mini-Din 3, 4 – mini-Din 4. Default value is 1.
    • syncInvert – "z" can be: 0 – Type Off. 0 is the default value for the syncInvert. 1 – Type Invert.
    • To reset, do not provide any parameter except "id".

• Response:

  • response: {"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}

  • success: (0=success, anything else is an error)

• Example:

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

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

changeContent

• Definition:

  • This API changes the content of a screen destination by putting background and layers in it.

• Request:

  • 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—Screen destination index.

    • BGLyr—Background layer index, Last source index of background.

      “id”:0 affects the Background in Program. “id”:1 affects the Background in Preview.

    • Layers—Layer information.
    • Window—Layer window size.
    • Source—Source info and size.
    • Mask—Crop the visible part of the layer.
    • PvwMode—Set 1 if you want the content in preview. (Default)
    • PgmMode—Set 1 if you want the content in program.

• Response:

  • response: null
  • success: (0=success, anything else is an error)

• Example:

  • {"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"}.

freezeDestSource

• Definition:

  • This API Freezes/Unfreezes the sources.

• Request:

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

    • type—type of source.

      • 0—Input source.
      • 1—Background source.
      • 2—ScreenDestination.
      • 3—AuxDestination.
    • id—Index of the source.
  • Screengroup—For future use. Always set to 0.
  • Mode—0 : UnFreeze, 1 : Freeze.

• Response:

  • response: null
  • success: (0=success, anything else is an error)

• Example:

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

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

listStill

• Definition:

  • This API lists all the stills with properties such as id, Name, H/V size, LockMode, StillState, PngState, File size.

• Request:

  • params: {}

• Response:

  • response: Array of : [{"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 of still store.
    • Name—Name of still store.
    • LockMode—For future use. Always set to 0.
    • H/V size—Horizontal and vertical size, Min, max and current value. It shows the current value.
    • StillState—This tells user if the still is currently being captured or not, or if it is getting deleted.
    • PngState—The “PNG” for stills are for the thumbnails we capture for the stills.
    • FileSize—Size of the file created in KBs.
  • success: (0=success, anything else is an error)

• Example:

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

deleteStill

• Definition:

  • This API deletes a still.

• Request:

  • params: {"id": x}

    • id—Index of still.

• Response:

  • response: null
  • success: (0=success, anything else is an error)

• Example:

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

takeStill

• Definition:

  • This API creates/overwrites a still.

• Request:

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

    • type—0 for input source, 1 for BG source.
    • Id—Index of the source. If the source id of the destination is provided, no still is created and an error is shown.
    • File—still file id. If you pass “file” : 5, this creates StillStore6.

• Response:

  • response: null
  • success: (0=success, anything else is an error)

• Example:

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

    "jsonrpc":"2.0"}

    • This creates a still from input source id 1 as StillStore6.

getFrameSettings

• Definition:

  • This API shows system information, including all the frames information.

• Request:

  • params: {}

• Response:

  • {"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—System name and index.
    • FrameCollection—Collection of frames in a system containing frame information.
    • Frame—Contains frame information.
    • Id—Mac Id of the frame.
    • Name—Name of the frame.
    • Contact—Contact information.
    • Version—Current version of the software installed on the frame.
    • OSVersion—Current OS version installed on the frame.
    • FrameType—0: E2, 1:S3, 2: Ex.
    • FrameTypeName—Type of the frame: E2/S3/Ex.
    • Enet—Ethernet settings.
    • SysCard—System card information.
    • Slot—List of Input/Output/Expansion card information.
  • success: (0=success, anything else is an error)

• Example:

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

listAuxContent

• Definition:

  • This API shows Aux destination information.

• Request:

  • params: {"id" : x}

    • id—Index of the Aux destination.

• Response:

  • response: {"id":0,"Name":"AuxDest1","PvwLastSrcIndex":0,"PgmLastSrcIndex":0}

    • id—Index of Aux destination.
    • Name—Name of Aux destination.
    • PvwLastSrcIndex—Input/Background source index in the preview area.
    • PgmLastSrcIndex—Input/Background source index in the program area.
  • success: (0=success, anything else is an error)

• Example:

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

changeAuxContent

• Definition:

  • This API changes the source in the Aux destinations.

• Request:

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

    • id—Index of the Aux destination.
    • Name—Name of Aux destination. (Optional paramter)
    • PvwLastSrcIndex—Input/Background source index to set in Aux destination in the preview area.
    • PgmLastSrcIndex—Input/Background source index to set in Aux destination in the program area.

• Response:

  • response: null
  • success: (0=success, anything else is an error)

• Example:

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

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

Subscription and Un-Subscription

When a subscription is done from a JSON-based application, a notification is sent to the ip port where the application is running when there is change for which the user has subscribed.

Actual notification is sent asynchronously as an HTTP Post, with the following structure: {result: {method:

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

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

The change field contains the XmlId(s) of the screens that were added/removed or updated.

Note: All subscriptions are lost once the Event Master processor is restarted, and they must be subscribed again if required.

subscribe

• Definition:

  • User can use this API to subscribe to change events in the Event Master processor.
  • Once subscribed, the API sends a notification in the form of an HTTP Post to the Url: http://hostname:port/.

• Request:

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

    • hostname—Hostname or IP Address to which the notifications are sent.
    • port—TCP port to which the notification are posted.

    • notificationTypes—an array of notifications to which a user wants to subscribe.

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

• Response:

  • response: {"method": "subscribe"}
  • success: (0=success, anything else is an error)

• Example:

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

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

    "jsonrpc":"2.0"}

unsubscribe

• Definition:

  • User can use this API to remove the subscription for the given hostname, port, and notificationType.

• Request:

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

    • hostname—Hostname or IP Address from which the subscription is to be removed.
    • port—TCP port.

    • notificationTypes—an array of notifications to which a user wants to subscribe.

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

• Response:

  • response: {"method": "unsubscribe"}
  • success: (0=success, anything else is an error)

• Example:

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

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

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