About commands

The following commands are not compatible with Event Master processors that can not run the specified version of Event Master Toolset. For more information on commands for other Event Master Toolset versions, see the other chapters of this manual.

Some commands only work on a select Event Master processors. For more information, see the ‘Availability’ section of the desired command.

getFrameSettings

• Availability: all

• Definition:

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

• Request:

  • params: {}

• Response:

  • response: {"jsonrpc":"2.0","id":"1234","result":{"success":0,"response":{"System":{"id":0,"Name":"System1","MacAddress":"74:fe:48:7f:22:30","Simulator":0,"FrameCollection":{"id":0,"Frame":{"id":"74:fe:48:7f:22:30","Name":"ENCORE3","Contact":"","Version":"10.0.0.b7e01ed8852.3640","OSVersion":"0.0.23","FrameType":8,"FrameTypeName":"Encore3","UnitRegistered":{"Min":0,"Max":1,"$t":0},"Enet":{"DhcpMode":0,"DhcpModeName":"Static","IP":"192.168.0.200","StaticIP":"192.168.0.200","MacAddress":"74:fe:48:7f:22:30","StaticMask":"255.255.255.0","StaticGateway":"192.168.0.1","DNSServer":"192.168.0.1","StaticDNSServer":"192.168.0.1"},"SysCard":{"SlotState":2,"CardTypeID":80,"CardTypeLabel":"MBoard","CardID":0,"CardStatusID":2,"CardStatusLabel":"Ready","OverTemp":0,"FanWarn":0},"Slot":[{"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":70,"CardTypeLabel":"High Speed Link","CardID":"Port1:4","OverTemp":0,"FanWarn":0}}, {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":4,"CardTypeLabel":"HDMI 2.0 Input","CardID":"Card1","OverTemp":0,"FanWarn":0}}, {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":4,"CardTypeLabel":"HDMI 2.0 Input","CardID":"Card2","OverTemp":0,"FanWarn":0}}, {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":5,"CardTypeLabel":"DP 1.2 Input","CardID":"Card3","OverTemp":0,"FanWarn":0}}, {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":3,"CardTypeLabel":"TriCombo Input","CardID":"Card4","OverTemp":0,"FanWarn":0}}, {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":25,"CardTypeLabel":"TriCombo Output","CardID":"Card5","OverTemp":0,"FanWarn":0}}, {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":26,"CardTypeLabel":"HDMI 2.0 Output","CardID":"Card6","OverTemp":0,"FanWarn":0}}], "VPID":0,"Identify":0,"DispBright":50,"LockFrontPanel":0,"FirmwareUpdateStatus":0, "PowerButtonPressed":0,"ExportLogsStatus":0,"DisplayPowerStatus":{"Min":0,"Max":2, "$t":2},"WebVersion":"1.0.0b4b801561a5e58b3694c6638efd485cd12ab123"}},"WebLockMode":0,"WidgetLockMode":0,"ApiExtControl":1,"VPID":0,"LockMode":"0","isHost":true},"VpCount":1}}}

    • 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, 3:IP-4K, 5:E2-Gen2, 6:PDS-4K, 8:Encore3
    • FrameTypeName — Type of the frame: Encore3, E2, S3, Ex, etc.
    • 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"}

powerStatus

• Availability: all

• Definition:

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

• Request:

  • params: {}

• Response:

  • response: {FrameId0:{PwrStatus1, PwrStatus2},{FrameId1 :{ 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 AC current detected.
    • 2: Power supply module is present, and the AC current is detected, 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"}

listInputs

• Availability: all

• Definition:

  • This queries the list of inputs configured.

• Request:

  • params: {"inputId": x}

    ‘x’ can be:

    • -1: For All inputs. (inputId is optional parameter, if not provided list of all inputs configured will be returned.)
    • Anything else will be treated as input config index and will return input of that index.

• Response:

  • response: [{"id":8,"Name":"DPInput1","SyncStatus":"None","VideoStatus":"No Sync", "Format":"3840x2160p @59.94", "Color_Space":"RGB, Full Range", "Colorimetry":"BT.709", "GammaFx":"SDR", "ColorDepth":"8", "Capacity":"4K"}]

    • Response contains an array of inputs. Above response contains ID, Name, Sync Status, Video Status, Format, Color Space, Colorimetry, Gamma Fx, and Color Depth and Capacity.
  • success: (0=success, anything else is an error)

• Example:

  • {"params":{"inputId": 1}, "method":"listInputs", "id":"1234", "jsonrpc":"2.0"}

listOutputs

• Availability: all

• Definition:

  • This queries the list of outputs configured.

• Request:

  • params: {"outputCfgId": x}

    ‘x’ can be:

    • -1: For All outputs. (outputCfgId is not mandatory parameter, if not provided list of all outputs configured will be returned.)
    • Anything else will be treated as output config index and will return output of that index.

• Response:

  • response: [{"id":2,"Name":"HDMIOutput3","Format":"3840x2160p CEA @59.94","ColorSampleBit":"RGB/4:4:4/8","Color_Space":"RGB, Full Range","Colorimetry":"BT.709","GammaFx":"SDR","HDRMetaFileIndex":0}]

    • Response contains an array of outputs. Above response contains ID, Name, Format, Color/Sample/Bit, Color space, Colorimetry, Gamma Fx, and HDRMetaFileIndex.
  • success: (0=success, anything else is an error)

• Example:

  • {"params":{"outputCfgId": 1}, "method":"listOutputs", "id":"1234", "jsonrpc":"2.0"}

resetFrameSettings

• Availability: all

• Definition:

  • Send a reset type to an 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 IP/EDID/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"}

3dControl

• Availability: E2 Gen1, E2 Gen2, S3-4K

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

3dControlOutput

• Availability: E2 Gen1, E2 Gen2, S3-4K

• Definition:

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

• Request:

  • params: {"outputId": 0, "3Dtype": 1}, "method":"3dControlOutput", "id":"1234", "jsonrpc":"2.0"}

    • outputId – Index of the output config.
    • 3Dtype — "x" can be: 0 – Type Off. 0 is the default value for the type parameter. 1 – Type Sequential.
    • To reset, do not provide any parameter except "outputId".

• Response:

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

• Example:

  • {"params": {"outputId": 0, "3Dtype": 1}, "method":"3dControlOutput", "id":"1234", "jsonrpc":"2.0"}

listOperators

• Availability: E2 Gen1, E2 Gen2, S3-4K, Ex, IP-4K

• Definition:

  • This queries the list of operators configured.

• Request:

  • params: {}

• Response:

  • response: [{"id":0,"Name":"Operator 1", "Enable":0, "StartRange":1, "EndRange":1000, "InvertColor":0,"DestCollection":[]},{"id":1,"Name":"Operator 2", "Enable":1, "StartRange":3, "EndRange":4, "InvertColor":0, "DestCollection":[{"id":0, "DestType":1, "DestXmlId":0, "Name":"ScreenDest1"}, {"id":1, "DestType":0, "DestXmlId":0, "Name":"AuxDest1"}]}, {"id":2,"Name":"Operator 3", "Enable":0, "StartRange":1, "EndRange":1000, "InvertColor":0, "DestCollection":[{"id":0, "DestType":1, "DestXmlId":0, "Name":"ScreenDest1"}]}]

    • Response contains an array of multi-operators. Above response contains ID, Name, Enable mode, Start Range of preset serial number, End Range of preset serial number, color of controller is inverted for this operator and collection of destinations selected for this operator.
  • success: (0=success, anything else is an error)

• Example:

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

configureOperator

• Availability: E2 Gen1, E2 Gen2, S3-4K, Ex, IP-4K

• Definition:

  • This API helps user to configure operators.

• Request:

  • params: {"operatorId": 2, "name": "qwert", "startRange":89, "endRange":95, "enable": 0, "add":{"destType": 1, "destIndex":0}, "remove" :{"destType": 1, "destIndex":1}}

    • operatorId: Operator index which needs to be configured.
    • name: User can set the name of the operator.
    • startRange : This is start range of preset serial number assigned to the operator.
    • endRange: This is end range of preset serial number assigned to the operator.
    • enable: enable (1) or disable (0) the operator.

    • add/remove: Add/Remove destination for the operator.

      destType: 0 – aux, 1 – screen, 2 – Super destination and 3 – super aux.

      destIndex: destination index.

• Response:

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

• Example:

  • {"params": {"operatorId": 2, "name": "qwert", "startRange":89, "endRange":95, "enable": 1}, "method":"configureOperator", "id":"1234", "jsonrpc":"2.0"}

    // Enables Operator 3 while changing its name to qwert and assigns preset range 89-95.

  • {"params": {"operatorId": 1, "add":{"destType": 1, "destIndex":0}, "remove": {"destType": 1, "destIndex":1}}, "method":"configureOperator", "id":"1234", "jsonrpc":"2.0"}

    // For Operator 2 – Removes Screen Destination 2 and adds Screen Destination 1 for this operator to control.

  • {"params": {"operatorId": 2, "name": "operator3", "endRange":134}, "method":"configureOperator", "id":"1234", "jsonrpc":"2.0"}

    // For Operator 3 – Renames the profile to operator3 and changes the ending preset in its range to 134.

  • {"params": {"operatorId": 1, "name": "operator2", "startRange":21}, "method":"configureOperator", "id":"1234", "jsonrpc":"2.0"}

    // For Operator 2 – Renames the profile to operator2 and changes the starting preset in its range to 21.

listSources

• Availability: all

• Definition:

  • This API lists all the input sources with properties.

• Request:

  • params: {"type": x}

    • 0 — Show all the input sources. (default)
    • 1 — Only background sources.

• Response:

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

    • ‘InputCfgVideoStatus’” possible values:

      0 - Invalid; there is sync, but cannot acquire / lock mismatch

      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": {}, "method":"listSources", "id":"1234", "jsonrpc":"2.0"}

listStill

• Availability: all

• 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: [{"id":0,"Name":"a.png","LockMode":{"Min":0,"Max":1,"$t":0},"HSize":{"Min":0,"Max":99999,"$t":3840},"VSize":{"Min":0,"Max":99999,"$t":2160},"AlphaMode":{"Min":0,"Max":1,"$t":0},"UmdColorStatus":{"LegalValues":"0 1 2 3 4  5","$t":1}, "StillState":{"Min":0,"Max":4,"$t":3}, "PngState":{"Min":0,"Max":2,"$t":0},"FileSize":{"Min":0,"Max":100000,"$t":33177.6}}]

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

takeStill

• Availability: all

• Definition:

  • This API captures/overwrites a still.

• Request:

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

    • type — 0 for input source
    • id — Index of the input. If the input 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 captures a still from input id 1 and saves it as StillStore6.

deleteStill

• Availability: all

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

listSourceMainBackup

• Availability: all

• Definition:

  • This API shows a list of inputs which have at least one backup input or still configured.

• Request:

  • params: {“inputType”: x}

    ‘x’ is not a mandatory parameter, but can be:

    • -1 (default) for all inputs
    • 0-99 for individual input ID

• Response:

  • response: {"id":0,"Name":"HDMIInput1","Backup":[{"id":0,"inputId":8,"stillId":null,"destId":null,"Name":"DPInput9"},{"id":2,"inputId":4,"stillId":null,"destId":null,"Name":"DPInput5"}]}

    • id — Index of input ID.
    • Name — Name of input.

    • VideoStatus:

      0: there is sync, but cannot acquire / lock mismatch

      1: Video status is OK

      2: Format mismatch between Input config and connector(s)

      3: Capacity / system mode error

      4: A connector lost sync

    • Array of Backup:

      id — backup Index (0, 1, 2). (Max we can set 3 backup)

      InputId: index of input which is configured as backup source.

      stillId: index of still which is configured as backup source.

      destId: index of screen destination which is configured as backup source.

      Name: Name of source configured as backup.

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

• Example:

  • {"params":{"inputType": -1}, "method":"listSourceMainBackup", "id":"1234", "jsonrpc":"2.0"}

activateSourceMainBackup

• Availability: all

• Definition:

  • This API configures backups for inputs and backgrounds.

• Request:

  • params: {"inputId":8, "Backup1": {"SrcType": 1, "SourceId": 1},"Backup2": {"SrcType": 0, "SourceId": 0 "Backup3": {"SrcType": 1, "SourceId": 0},"BackUpState":1}

    • inputId: index of input/Background for which backups are to be configured.

    • Backup1/Backup2/Backup3:

      SrcType: 0 for input, 1 for Stills.

      SourceId: Index of input or Still.

    • BackupState: Backup id which needs to be set for backup of the main input. -1 to set primary and is default (If not provided then primary will be activated).

• Response:

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

• Example:

  • {"params":{"inputId":8, "Backup1": {"SrcType": 1, "SourceId": 1}, "Backup2": {"SrcType": 0, "SourceId": 0}, "Backup3": {"SrcType": 1, "SourceId": 0}, "BackUpState":1}, "method":"activateSourceMainBackup", "id":"1234", "jsonrpc":"2.0"}

resetSourceMainBackup

• Availability: all

• Definition:

  • This API resets the applied Input backup to primary source.

• Request:

  • params: {“id”: 2}

    • id: Input index ID to be reset.

• Response:

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

• Example:

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

listDestinations

• Availability: all

• 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. (default)
    • 1 — Only screen destinations.
    • 2 — Only aux destinations.

• Response:

  • response: {"ScreenDestination":[{"id": 0, "Name": "Dest1", "HSize": 7680, "VSize": 2160, "Layers": null,"DestOutMapColl":[{"id": 0"DestOutMap":[{"id": 0, "Name": "HDMIOutput1", "HPos": 0, "VPos": 0, "HSize": 3840, "VSize":2160, "Freeze": 0},{"id": 1, "Name": "Out2", "HPos": 3840, "VPos": 0, "HSize": 3840, "VSize":2160, "Freeze": 0}]}]}],"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"}

listAuxContent

• Availability: E2 Gen1, E2, Gen2, S3-4K, Ex, IP-4K

• 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 source index in the preview area.
    • PgmLastSrcIndex — Input 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

• Availability: E2 Gen1, E2, Gen2, S3-4K, Ex, IP-4K

• 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 source index ID to set in Aux destination in the preview area.
    • PgmLastSrcIndex — Input source index ID to set in Aux destination in the program area.
    • TestPattern — Provide test pattern index ID number

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

    // Places Source ID 6 into preview and Source ID 1 on program for Aux Destination 1.

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

    // Turns on the 100% Color Bars Test Pattern in Aux Destination 1.

listContent

• Availability: E2 Gen1, E2 Gen2, S3-4K, PDS-4K

• Definition:

  • This API shows the content of a screen destination.

• Request:

  • params: {"id": x}

    • “id” — Screen destination index.

• Response:

  • response: {"jsonrpc":"2.0","result":{"success":0,"response":{"id":0,"Name":"ScreenDest1","IsActive":1,"BGLyr":[{"id":0,"LastBGSourceIndex":-1, "BGShowMatte":1, "BGColor":{"id":0, "Red":0, "Green":0, "Blue":0}},{"id":1, "LastBGSourceIndex":-1, "BGShowMatte":1, "BGColor":{"id":0, "Red":0, "Green":0, "Blue":0}}], "Layers":[{"id":0, "Name":"Layer1-A","LastSrcIdx":-1, "PvwMode":0, "PgmMode":0, "LinkLayerId":0, "LinkDestId":0, "Capacity":1, "PvwZOrder":0, "PgmZOrder":0, "Freeze":0, "ScalingMode":2, "Window":[{"HPos":0, "VPos":0, "HSize":1920, "VSize":1080}, {"HPos":0, "VPos":0, "HSize":1920, "VSize":1080}], "Source":[{"HPos":0,"VPos":0,"HSize":1920,"VSize":1080},{"HPos":0,"VPos":0,"HSize":1920,"VSize":1080}],"Mask":[{"id":0,"Top":0,"Left":0,"Right":0,"Bottom":0},{"id":0,"Top":0,"Left":0,"Right":0,"Bottom":0}]},{"id":1,"Name":"Layer1-B", "LastSrcIdx":-1, "PvwMode":0, "PgmMode":0, "LinkLayerId":1, "LinkDestId":0, "Capacity":1, "PvwZOrder":0, "PgmZOrder":0, "Freeze":0, "ScalingMode":2, "Window":[{"HPos":0,"VPos":0,"HSize":1920,"VSize":1080},{"HPos":0,"VPos":0,"HSize":1920,"VSize":1080}],"Source":[{"HPos":0,"VPos":0,"HSize":1920,"VSize":1080},{"HPos":0,"VPos":0,"HSize":1920,"VSize":1080}],"Mask":[{"id":0,"Top":0,"Left":0,"Right":0,"Bottom":0},{"id":0,"Top":0,"Left":0,"Right":0,"Bottom":0}]}],"Transition":[{"id":0,"TransTime":30,"TransPos":0,"ArmMode":1},{"id":1,"TransTime":30,"TransPos":0,"ArmMode":0}],"OutputCfg":[{"id":0,"Name":"HDMIOutput1","OutputAOI":[{"id":0,"TestPattern":[{"id":0,"TestPatternMode":0}]}]}]}},"id":"1234"}

    • id — index of screen destination.
    • Name — Name of Screen Destination.

    • 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 (Matte Color), else this is the index of the last input source used on BG of the screen destination.
    • BGShowMatte — This is if BG to be matte or not.
    • BGColor — This is the 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).
    • LinkLayerId: Link/Global Layer Index
    • LinkDestId: Link Destination Index
  • success: (0=success, anything else is an error)

• Example:

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

changeContent

• Availability: E2 Gen1, E2 Gen2, S3-4K, PDS-4K

• Definition:

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

• Request:

  • params: {"id":0, "TestPattern" :5, "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}]}

    • 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 collection.

      id — Layer index number.

      LastSrcIdx — Source Index number.

      Window — Layer window size.

      Source — Source size and offset.

      Mask — Crop the visible part of the layer. Mask parameters must be sent separately from Window and LastSrcIdx.

      PvwMode — Set 1 if you want the content in preview. (Default)

      PgmMode — Set 1 if you want the content in program.

    • TestPattern — Provide test pattern id (0=Off).

• Response:

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

• Example:

  • {"params":{"id":0,"BGLyr":[{"id":0,"LastBGSourceIndex":0,"BGShowMatte":1,"BGColor":[{"id":0,"Red":0,"Green":0,"Blue":0}]},{"id":1,"LastBGSourceIndex":0,"BGShowMatte":1,"BGColor":[{"id":0,"Red":0,"Green":1023,"Blue":0}]}]},"method":"changeContent","id":"1234","jsonrpc":"2.0"}

    // Sets the Background for Destination 1 to use a black matte on PGM and full green matte on PVW.

  • {"params": {"id": 0, "Layers": [{"id": 0, "LastSrcIdx":4, "Window":{"HPos": 320, "VPos": 180, "HSize": 1280, "VSize": 720}, "PvwMode":1}]}, "method":"changeContent", "id":"1234", "jsonrpc":"2.0"}

    // Places Source ID 4 into Layer 1A on Destination 1’s PVW at the given window size and position.

  • {"params": {"id": 0, "Layers": [{"id": 0, "Mask":{"Left":12.5, "Right":12.5}, "PvwMode":1}]}, "method":"changeContent", "id":"1234", "jsonrpc":"2.0"}

    // Sets the Mask values for Layer1A on Destination 1’s PVW to 12.5% on the left and right edges.

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

    // Turns on the 32x32 Grid Test Pattern for Destination 2.

listUserKey

• Availability: all

• Definition:

  • This API lists all User Keys in the system.

• Request:

  • params: {}

• Response:

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

• Example:

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

recallUserKey

• Availability: all

• Definition:

  • Recall a User Key on the Event Master processor. Users can recall User Key with id or User Key name. Send any one of the parameters to recall User Key.

• Request:

  • params: {"id": x, "ScreenDestination": [], "DestOutMap": [], "Layer":[] }

  • params: {“userkeyName”:”UserKeyName”, “ScreenDestination”: [], “Layer”:[] }

    • ScreenDestination — Indexes of screen destinations.

    • Layer — Array of layers index in screen destination on which UserKey is to be recalled.

      If user provides params: {“id”: x, “ScreenDestination”: [1,2], “Layer”:[1,2,3]} then this means Screen 1 – Layer 1,2,3, Screen 2 – Layer 1,2,3 and so on.

• Response:

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

• Example:

  • {"params": {"id": 0, "ScreenDestination": [0,1,2], "Layer":[0,2,4]}, "method":"recallUserKey", "id":"1234", "jsonrpc":"2.0"}

    // Applies UserKey ID 0 to Layers 1, 3 & 5 on Screens 1, 2 & 3.

  • {"params": {"userkeyName": "abc", "ScreenDestination": [0,1], "Layer":[0]}, "method":"recallUserKey", "id":"1234", "jsonrpc":"2.0"}

    // Applies UserKey name “abc” to Layer 1 on Screen 1 & 2.

fillHV

• Availability: E2 Gen1, E2 Gen2, S3-4K, PDS-4K

• Definition:

  • Fits layers to screen destination horizontally and vertically.

• Request:

  • params: {"screenId": x, "Layers": [{"id": 0}, {"id": 1}, {"id": 3}]}

    • screenId — index ID of screen destination
    • Layers — List of layer ID indices.

• Response:

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

• Example:

  • {"params": {"screenId": 0, "Layers": [{"id": 0}, {"id": 1}]}, "method":"fillHV", "id":"1234", "jsonrpc":"2.0"}

clearLayers

• Availability: E2 Gen1, E2 Gen2, S3-4K, PDS-4K

• Definition:

  • Clear layers from screen destinations.

• Request:

  • params: {"screenId": x, "Layers": [{"id": 0}, {"id": 1}, {"id": 3}]}

    • screenId — index ID of screen destination
    • Layers — List of layer ID indices.

• Response:

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

• Example:

  • {"params": {"screenId": 0, "Layers": [{"id": 0}, {"id": 1}]}, "method":"clearLayers", "id":"1234", "jsonrpc":"2.0"}

listSuperAuxContent

• Availability: E2 Gen1, E2 Gen2, S3-4K, Ex, IP-4K

• Definition:

  • This API shows the content of a super aux destination.

• Request:

  • params: {"id": x}

    • “id”—Super Aux destination index.

• Response:

  • response: {"jsonrpc":"2.0","result":{"success":0,"response":{"id":0,"Name":"SuperAux1","HDimention":2,"VDimention":1,"HSize":3840,"VSize":1080,"AuxDestCollection":[{"id":0,"DestType":0,"DestXmlId":0,"Name":"AuxDest1"},{"id":1,"DestType":0,"DestXmlId":1,"Name":"AuxDest2"}]}},"id":"1234"}

    • id—index of super aux destination.
    • Name—Name of super aux Destination.
    • HDimention — Horizontal dimension of super aux destination
    • VDimention — Vertical dimension of super aux destination
    • HSize: Horizontal size of super aux destination
    • VSize: Vertical size of super aux destination
    • AuxDestCollection —Array of aux destination with index and name of aux destination and destination type.
  • success: (0=success, anything else is an error)

• Example:

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

changeSuperAuxContent

• Availability: E2 Gen1, E2 Gen2, S3-4K, Ex, IP-4K

• Definition:

  • This API changes sources for any aux destination which is part of super aux.

• Request:

  • params: {"id":0,"Destinations”: [{"id":0, "Name": "AuxDest1”, "PvwLastSrcIndex":0, "PgmLastSrcIndex":0}]}

    • id—Super Aux destination index.
    • Destinations — Array of Aux destination with index, Name of aux destination to be renamed, Preview source and Program source to be modified in aux destination.
    • TestPattern — Test Pattern index of Aux Destination to be changed (0=Off).

• Response:

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

• Example:

  • {"params":{"id":0,"Destinations":[{"id":0, "Name": "AuxDest1" , "PvwLastSrcIndex": 0 , "PgmLastSrcIndex":0}]}, "method":"changeSuperAuxContent", "id":"1234", "jsonrpc":"2.0"}

    // Places source id 0 on both preview and program of Aux Destination 1.

  • {"params":{"id":0,"Destinations":[{"id":0, "Name": "AuxDest1" , "PvwLastSrcIndex": 10},{"id":1, "Name": "AuxDest2" , "PvwLastSrcIndex": 11}]}, "method": "changeSuperAuxContent", "id":"1234", "jsonrpc":"2.0"}

    // Places source id 10 in preview of Aux Destination 1 and source id 11 in preview of Aux Destination 2 of the SuperAux .

  • {"params":{"id":0,"Destinations":[{"id":0, "Name": "AuxDest1" , "TestPattern" :5}]}, "method":"changeSuperAuxContent", "id":"1234", "jsonrpc":"2.0"}

    // Turns on the 32x32 Grid Test Pattern for Aux Destination 1 in the SuperAux.

listSuperDestContent

• Availability: E2 Gen1, E2 Gen2, S3-4K

• Definition:

  • This API shows the content of a super screen destination.

• Request:

  • params: {"id": x}

    • “id”—Super/Link Screen destination index.

• Response:

  • response: {"jsonrpc":"2.0","result":{"success":0,"response":{"id":0,"Name":"SuperDest1","HDimention":1,"VDimention":1,"HSize":1920,"VSize":1080,"GlobalLayers":2,"DestCollection":[{"id":0,"DestType":1,"DestXmlId":0,"Name":"ScreenDest1"}],"GlobalLayerCollection":{"GlobalLayer":[{"id":0,"Name":"SuperLayer1-A","SuperLayerLinkedState":1,"LinkLayer":[{"LinkLayerXmlId":0,"DestXmlId":0}]},{"id":1,"Name":"SuperLayer1-B","SuperLayerLinkedState":1,"LinkLayer":[{"LinkLayerXmlId":1,"DestXmlId":0}]}]}}},"id":"1234"}

    • id — index of super screen destination.
    • Name — Name of super Screen Destination.
    • HDimention — Horizontal dimension of super screen destination
    • VDimention — Vertical dimension of super screen destination
    • HSize: Horizontal size of super screen destination
    • VSize: Vertical size of super screen destination
    • GlobalLayers — Count of global Layer.
    • DestCollection — Array of screen destination with index and name of screen destination and destination type.
    • GlobalLayerCollection — Array of global layer with information of index, name of link layer.
    • SuperLayerLinkedState — State of super/Link Layer.
    • LinkLayerXmlId: Link Layer Index
    • DestXmlId: Link layer part of screen Destination Index.
  • success: (0=success, anything else is an error)

• Example:

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

changeSuperDestContent

• Availability: E2 Gen1, E2 Gen2, S3-4K

• Definition:

  • This API changes layer parameters for each global super layer in all screen destinations that are part of a super destination.

• Request:

  • params: {"id":0,"GlobalLayers”: [{"id":0,"Window":{"HPos":0,"VPos":0,"HSize":700,"VSize":300}}]}

    • id — Super Screen destination index.

    • GlobalLayers — Array of Global Layers with index:

      Window — H/V position and H/V size.

      LastSrcIdx — Source index to be used in the Global Layer

      Mask — Mask position of the Global Layer with left, right, top, and bottom percentage. Mask parameters must be sent separately from Window and LastSrcIdx.

      PvwMode — Set 1 if you want the change on Preview (Default).

      PgmMode — Set 1 if you want the change on Program.

    • TestPattern — Test Pattern index for the SuperDestination to be changed.

• Response:

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

• Example:

  • {"params":{"id":0,"GlobalLayers":[{"id":0,"LastSrcIdx":10, "Window": {"HPos":100,"VPos":200,"HSize":700,"VSize":300},"PvwMode":0, "PgmMode":1},{"id":2,"LastSrcIdx":12, "Window": {"HPos":1600, "VPos":200, "HSize":1280,"VSize":720},"PvwMode":0, "PgmMode":1}]}, "method": "changeSuperDestContent", "id":"1234", "jsonrpc":"2.0"}

    // For SuperDest1, places source ID 10 into SuperLayer1a and source ID 12 into SuperLayer2a on program.

  • {"params":{"id":0,"GlobalLayers":[{"id":0, "Mask":{"Left":10,"Right":10,"Top":10, "Bottom":5}}]},"method":"changeSuperDestContent", "id":"1234", "jsonrpc":"2.0"}

    // Sets the masking percentage to the declared values for SuperLayer1 in SuperDest1.

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

    // Turns on the 32x32 Grid Test Pattern for All Destinations in SuperDest1.

listPresets

• Availability: all

• 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’s particular ID in it or array of IDs. E.g. "ScreenDestination":[{"id": 2}, {"id": 3}]

• Response:

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

    • Response contains an 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": -1}, "method":"listPresets", "id":"1234", "jsonrpc":"2.0"}

savePreset

• Availability: all

• Definition:

  • Creates a Preset on the Event Master processor.

• Request:

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

  • params: {"presetName": "NewPreset", "serialNo": 1.01, "saveFromProgram":1, "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 doesn’t provide it, Preset will be saved for selected destinations.
    • serialNo — serial number for the preset to be saved. If the serialNo exists, it will be overwritten (Optional). Only two-digit decimal points are recommended. If user provides more than 2 decimal places the number may be rounded off to two-digit decimal place (hundredths).
    • saveFromProgram — This flag is set to 1 if the preset is to be saved from program, else the default will be saved from preview (Optional).

• Multi-Operator Mode: (not available for PDS-4K)

  New parameters are introduced to work with multi-operator mode along with the above parameters. These parameters are used only when one or more operators are enabled.

  • params: {"presetName": "NewPreset", "operatorId": y} (normal operator)

    • “operatorId” — operator index (only 0, 1, 2 are valid indices).
    • If user wants to use “super-operator” mode, its password is required which is passed as a parameter.

  • params: {"presetName": "NewPreset", "password": "xyz"}

    • password — Super operator password saved. When this is passed, actions will be performed as if no operator is enabled.

• Response:

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

• Example:

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

    // Saves a preset named “NewPreset” from the selected destinations’ previews as the next available preset in the list.

  • {"params": {"presetName": "NewPreset-S1-A1", "ScreenDestination": {"id": 0},"AuxDestination":{"id": 0}}, "method":"savePreset", "id":"1234", "jsonrpc":"2.0"}

    // Selects Screen1 and Aux1 only and saves a preset from their previews named “NewPreset-S1-A1” as the next available preset in the list.

  • {"params": {"presetName": "NewSubPreset", "serialNo": 1.01, "saveFromProgram":1}, "method":"savePreset", "id":"1234", "jsonrpc":"2.0"}

    // Saves a preset named “NewSubPreset” from the selected destinations’ programs as the preset number 1.01 in the list.

  • {"params": {"presetName": "NewPreset5", "serialNo": 5.00, "operatorId": 2}, "method":"savePreset", "id":"1234", "jsonrpc":"2.0"} (normal operator)

    // Saves a preset named “NewPreset5” from the selected destinations’ previews with preset number 5.00 in Operator 3’s list.

  • {"params": {"presetName": "NewPreset", "password": "p@$$w0rD"}, "method":"savePreset", "id":"1234", "jsonrpc":"2.0"} (super operator)

    // Saves a preset named “NewPreset” from the selected destinations’ previews as the next available preset in the list.

renamePreset

• Availability: all

• Definition:

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

• Request:

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

deletePreset

• Availability: all

• Definition:

  • Delete a Preset on the Event Master system. 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"}

• Multi-Operator Mode: (not available for PDS-4K)

  New parameters are introduced to work with multi-operator mode along with the above parameters. These parameters are used only when one or more operators are enabled.

  • params: {"id": x, "operatorId": y} (normal operator)

    • “operatorId” — operator index (only 0, 1, 2 are valid indices).
    • If user wants to use “super-operator” mode, its password is required which is passed as a parameter.

  • params: {"id": x, "password": "xyz"} (super operator)

    • password — Super user password saved. When this is passed, actions will be performed as if no operator is enabled.

• 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"}
  • {"params": {"id": 5, "operatorId": 2}, "method":"deletePreset", "id":"1234", "jsonrpc":"2.0"} (normal operator)
  • {"params": {"id": 6, "password": "123"}, "method":"deletePreset", "id":"1234", "jsonrpc":"2.0"} (super operator)

activatePreset

• Availability: all

• Definition:

  • Recall a Preset on the Event Master system. User can recall Preset with ID, Serial number, or Preset name. Send any one of the parameters to recall Preset.

    Note: For proper outcome when using this API for presets that use Split layers, please ensure the system’s Preset conflict mode is set to either Auto or Force Recall.

• Request:

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

  • 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 to program.

• Multi-Operator Mode: (not available for PDS-4K)

  New parameters are introduced to work with multi-operator mode along with the above parameters. These parameters are used only when one or more operators are enabled.

  • params: {"id": x, "operatorId": y} (normal operator)

    • “operatorId” — operator index (Only 0, 1, 2 are valid index IDs).
    • If user wants to use “super-operator” mode, its password is required which is passed as a parameter.

  • params: {"id": x, "password": "xyz"} (super operator)

    • password — Super user password saved. When this is passed, actions will be performed as if no operator is enabled.

• 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 preset id 0 to preview.

  • {"params": {"presetName": "abc"}, "method":"activatePreset", "id":"1234", "jsonrpc":"2.0"}

    // Recall preset named “abc” to preview.

  • {"params": {"presetSno": 1.30, "type": 1}, "method":"activatePreset", "id":"1234", "jsonrpc":"2.0"}

    // Recall preset serial number 1.30 to program.

  • {"params": {"id": 5, "operatorId": 2}, "method":"activatePreset", "id":"1234", "jsonrpc":"2.0"} (normal operator)
  • {"params": {"id": 6, "password": "123"}, "method":"activatePreset", "id":"1234", "jsonrpc":"2.0"} (super operator)

recallNextPreset

• Availability: all

• Definition:

  • Recalls the next Preset by Index ID number on the Event Master processor. No parameter is required. Make sure that the user has recalled at least one Preset. Web app recalls the next Preset Index ID following the previously recalled Preset Index ID.

• Request:

  • params: {}

• Response:

  • response: null

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

    An error is shown if there was not a previously recalled Preset or if there is no next Preset in the list.

• Example:

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

listDestinationsForPreset

• Availability: all

• Definition:

  • Lists the Destination content of a Preset.

• Request:

  • params: {“id”:x}

    ‘x’ can be:

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

• Response:

  • response: [{"id": 0, "Name": "Preset3.00", "LockMode": 0, "presetSno": 3.00, "ScreenDest":[{"id": 0}, {"id": 3}],"AuxDest":[{"id": 0}, {"id": 1}]}]
  • success: (0=success, anything else is an error)

• Example:

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

freezeDestSource

• Availability: all

• Definition:

  • This API Freezes/Unfreezes the sources.

• Request:

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

    • type — type of source.

      0 — Input.

      2 — ScreenDestination.

      3 — AuxDestination.

    • id — Index of the Type.
    • 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"}

armUnarmDestination

• Availability: all

• Definition:

  • Arm or Unarm the destinations for transitions and saving presets.

• Request:

  • params: {"arm": x, "ScreenDestination":[{"id": 2}, {"id": 3}], "AuxDestination":[{"id": 1}, {"id": 2}]}

    • "arm": “x” can be: 0 to unarm and 1 to arm.
    • ScreenDestinations — ScreenDest IDs to arm/unarm.
    • AuxDestinations — AuxDest IDs to arm/unarm.

• Response:

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

• Example:

  • {"params": {"arm": 1, "ScreenDestination":[{"id": 0}, {"id": 2}], "AuxDestination":[{"id": 0}, {"id": 1}]}, "method":"armUnarmDestination", "id":"1234", "jsonrpc":"2.0"}

listDestGroups

• Availability: E2 Gen1, E2, Gen2, S3-4K, Ex, IP-4K

• Definition:

  • Queries the list of Destination Groups configured on the system.

• Request:

  • params: {"destGroupID": x}

    ‘x’ – Index of the Destination group, where x can be:

    • -1: For all destination groups (Optional parameter. If not provided, the list of all destination groups will be returned).
    • 0 – 9: Will return the information associated with the destGroupID number only.

  • params: {"destGroupSno": y}

    • ‘y’ – The serial number associated to the Destination Group, where y can be 1 – 10.

      Returns the list of Destinations configured in the Destination Group with that serial number.

  • params: {"destGroupName": z}

    • ‘z’ – Name of the Destination Group as shown in the Event Master Toolset.

      Returns the list of Destinations configured in the Destination Group with that name.

• Response:

  • response: Array of all Destination Group objects
  • success: (0=success, anything else is an error)

• Example:

  • {"params": {"destGroupID": -1}, "method":"listDestGroups", "id":"1234", "jsonrpc":"2.0"}
  • {"params": {"destGroupSno": 3}, "method":"listDestGroups", "id":"1234", "jsonrpc":"2.0"}
  • {"params": {"destGroupName": "Main Screens"}, "method":"listDestGroups", "id":"1234", "jsonrpc":"2.0"}

activateDestGroup

• Availability: E2 Gen1, E2, Gen2, S3-4K, Ex, IP-4K

• Definition:

  • Recall a DestGroup on the Event Master system. User can recall DestGroup with ID, DestGroup serial number, or DestGroup name. Send any one of the parameters to recall DestGroup.

• Request:

  • params: {"id": x}

  • params: {"destGrpName": "GroupName"}

    • id – Index of the Destination group.
    • destGrpSno – Destination group serial number.
    • destGrpName – Destnation group name.

• Response:

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

• Example:

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

allTrans

• Availability: all

• Definition:

  • It executes the “allTrans” command. If multi-operator mode is enabled, all-trans will affect only on those destinations which are selected for the requested operator.

• Request:

  • params: {"transTime": x}

    • integer value for the number of frames to use for the transition time. This will be applied to all armed destinations. (optional)

• Multi-Operator Mode: (not available for PDS-4K)

  New parameters are introduced to work with multi-operator mode along with the above parameters. These parameters are required only when one or more operators are enabled.

  • params: {"operatorId": y} (normal operator)

    • “operatorId”— operator index (Only 0, 1, 2 are valid ID numbers).
    • If user wants to use “super-operator” mode, its password is required to send as a parameter.

  • params: {"password": "xyz"} (super operator)

    • password — Super operator password saved. When this is passed, actions will be performed as if no other operator is enabled.

• Response:

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

• Example:

  • {"params": {}, "method":"allTrans", "id":"1234", "jsonrpc":"2.0"}
  • {"params": {"transTime": 40}, "method":"allTrans", "id":"1234", "jsonrpc":"2.0"}
  • {"params": {"operatorId": 1}, "method":"allTrans", "id":"1234", "jsonrpc":"2.0"} (normal operator)
  • {"params": {"password": "123"}, "method":"allTrans", "id":"1234", "jsonrpc":"2.0"} (super operator)

cut

• Availability: all

• Definition:

  • It executes the “Cut” command. If multi-operator mode is enabled, cut will affect only those destinations which are selected for the requested operator.

• Request:

  • params: {}

    None required, unless the system is using the multi-operator environment.

• Multi-Operator Mode: (not available for PDS-4K)

  New parameters are introduced to work with multi-operator mode along with the above parameters. These parameters are used only when one or more operators are enabled.

  • params: {"operatorId": y} (normal operator)

    • “operatorId” — operator index (only 0, 1, 2 are valid indices).
    • If user wants to use “super-operator” mode, its password is required which is passed as a parameter.

  • params: {"password": "xyz"} (super operator)

    • password — Super user password saved. When this is passed, actions will be performed as if no other operator is enabled.

• Response:

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

• Example:

  • {"params": {}, "method":"cut", "id":"1234", "jsonrpc":"2.0"}
  • {"params": {"operatorId": 1}, "method":"cut", "id":"1234", "jsonrpc":"2.0"} (normal operator)
  • {"params": {"password": "123"}, "method":"cut", "id":"1234", "jsonrpc":"2.0"} (super operator)

listCues

• Availability: all

• Definition:

  • List all the cues.

• Request:

  • params: {"id": x}

    • id — Index of the Cue.

• Response:

  • response: Array of cue objects.
  • success: (0=success, anything else is an error)

• Example:

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

activateCue

• Availability: all

• Definition:

  • This API gives options to play/pause/stop cue.

• Request:

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

    • id — Index of the cue.
    • type — (Optional). "y" can be: 0 — Play. 0 is the default value for the type parameter. 1 — Pause, 2 — Stop

• Response:

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

• Example:

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

    // Play – no params 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

mvrLayoutChange

• Availability: E2 Gen1, E2 Gen2, S3-4K, PDS-4K

• Definition:

  • This API changes layout in the given frame’s multiviewer.

• Request:

  • params: {"frameUnitId": x, "mvrLayoutId": x}

    • frameUnitId: Frame unit id for which MVR layout needs to be changed.
    • mvrLayoutId: MVR layout index. Possible value 0 to 9.
    • Both are mandatory parameters for this API.

• Response:

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

• Example:

  • {"params": {"frameUnitId": 0, "mvrLayoutId": 1}, "method":"mvrLayoutChange", "id":"1234", "jsonrpc":"2.0"}

subscribe

Note: All subscriptions are lost once the Event Master processor is restarted.

• Availability: all

• 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

      CueChanged

• Response:

  • response: null
  • 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

• Availability: all

• 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

      CueChanged

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