Table of Contents
Subscribe to Our Youtube Channel
Related Manuals for Blackbox VIDEOPLEX 4000
Summary of Contents for Blackbox VIDEOPLEX 4000
- Page 1 APPLICATION PROGRAM INTERFACE MANUAL VSC-VPLEX4000 VIDEOPLEX 4000 API MANUAL 24/7 TECHNICAL SUPPORT AT 1.877.877.2269 OR VISIT BLACKBOX.COM POWER POWER INPUT INPUT VIDEOPLEX4000 VIDEO WALL CONTROLLER STATUS STATUS P R O A V S O L U T I O N S...
-
Page 2: Table Of Contents
4.9 Output Image Source .....................................35 4.10 Output Genlock Source ..................................36 4.11 Output Genlock Status ..................................37 4.12 Output HDCP Status .....................................38 4.13 Output Link Training Result .................................38 5. DISCLAIMER/TRADEMARKS ..............................40 5.1 Disclaimer .......................................40 5.2 Trademarks Used in this Manual ................................40 1.877.877.2269 BLACKBOX.COM... -
Page 3: Introduction
Input and Output functions can be set on a per input or output basis. If a password is set on the device, then all POST requests must have a “Password” member that matches the password that has been set. See Password.cgx for more details. 1.877.877.2269 BLACKBOX.COM... -
Page 4: Device Properties
Get the firmware, config, hardware and FPGA version numbers of the device, along with the build date and time of the application and bootloader. Example URI GET /SystemInfo.cgx Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “FirmwareVersion”: 261, “ConfigVersion”: 256, “HardwareVersion”: 1, “FPGAVersion”: 5, “ApplicationBuildDate”: “Apr 20 2016”, “ApplicationBuildTime”: “13:12:50”, 1.877.877.2269 BLACKBOX.COM... -
Page 5: System Health
2.3 SYSTEM HEALTH Get System Health GET/SystemHealth.cgx Get power supply state and temperature. Example URI GET /SystemHealth.cgx Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “PowerSupply”: { “IO”: true, “1.8V”: true, “1.2V”: true “Temperature”: { “Average”: 34.312, “Maximum”: 39, “Minimum”: 23 1.877.877.2269 BLACKBOX.COM... -
Page 6: Friendly Name
GET/FriendlyName.cgx Example URI GET /FriendlyName.cgx Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “FriendlyName”: “VideoPlex4000” Set Friendly Name POST/FriendlyName.cgx Example URI POST /FriendlyName.cgx Request Show Headers Content-Type: application/json Body “FriendlyName”: “My Fx4” Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “Success”: true 1.877.877.2269 BLACKBOX.COM... -
Page 7: Network Settings
For dynamic IP address assignment set DHCP to true, the other fields are then not required. For static IP address configuration set DHCP to false and specify an IPAddress, Gateway and Subnet. Example URI POST /NetworkSettings.cgx Request Show Headers Content-Type: application/json Body “DHCP”: false, “IPAddress”: “192.168.1.2”, 1.877.877.2269 BLACKBOX.COM... -
Page 8: Password
“NewPassword”. If the password is forgotten, it must be reset via the USB interface. To remove password protection, set an empty string. Example URI POST /Password.cgx Request Show Headers Content-Type: application/json Body “NewPassword”: “secret” Response 200 Show Headers Content-Type: application/json; charset=utf-8 1.877.877.2269 BLACKBOX.COM... -
Page 9: Smoothness
Set Smoothness to 0 for text optimization. Set Smoothness to non-zero for video optimization. Get Smoothness GET/Smoothness.cgx Example URI GET /Smoothness.cgx Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “Smoothness”: 0 Set Smoothness POST/Smoothness.cgx Example URI POST /Smoothness.cgx Request Show Headers Content-Type: application/json Body “Smoothness”: 0 1.877.877.2269 BLACKBOX.COM... -
Page 10: No Signal Behavior
Set to true if outputs should not output a signal if no inputs are connected. Get No Signal Behavior GET/OutputNoSignal.cgx Example URI GET /OutputNoSignal.cgx Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “NoSignal”: true Set No Signal Behavior POST/OutputNoSignal.cgx Example URI POST /OutputNoSignal.cgx Request Show Headers Content-Type: application/jso 1.877.877.2269 BLACKBOX.COM... -
Page 11: Preferred Input
Select which input is preferred as the active source. If the selected input is not available, it will fall back to inputs in the following order: 2, 0, 1. A value of null can be used to indicate no preferred input. 1.877.877.2269 BLACKBOX.COM... -
Page 12: Active Input
Get which input is currently being used as the source. If none of the inputs have a signal, then a value of null will be returned. Example URI GET /ActiveInput.cgx Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “Input”: 0 1.877.877.2269 BLACKBOX.COM... -
Page 13: Save Settings
Reset all settings, apart from the network settings unless specified. To reset network settings at the same time, ResetIP must be true. WARNING: The default network settings have DHCP enabled. If ResetIP is true and a static IP address was configured, this will be reset to DHCP enabled and your current IP address may change. Example URI POST /ResetSettings.cgx 1.877.877.2269 BLACKBOX.COM... - Page 14 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 2: DEVICE PROPERTIES TECHNICAL SUPPORT 1.877.877.2269 Request Show Headers Content-Type: application/json Body “ResetIP”: false, “ResetFriendlyName”: true Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “Success”: true 1.877.877.2269 BLACKBOX.COM...
-
Page 15: Input Properties
Content-Type: application/json; charset=utf-8 Body “HorFrequency”: 67432, “VerFrequency”: 59939, “PixelClock”: 148351478, “Flags”: 0, “HorAddrTime”: 1920, “HorRightBorder”: 0, “HorFrontPorch”: 44, “HorSyncTime”: 88, “HorBackPorch”: 148, “HorLeftBorder”: 0, “VerAddrTime”: 1080, “VerBottomBorder”: 0, “VerFrontPorch”: 4, “VerSyncTime”: 5, “VerBackPorch”: 36, “VerTopBorder”: 0, “SDILevel”: “A” 1.877.877.2269 BLACKBOX.COM... -
Page 16: Input Preferred Timings
Show Headers Content-Type: application/json; charset=utf-8 Body “HorFrequency”: 67432, “VerFrequency”: 59939, “PixelClock”: 148351478, “Flags”: 0, “HorAddrTime”: 1920, “HorRightBorder”: 0, “HorFrontPorch”: 44, “HorSyncTime”: 88, “HorBackPorch”: 148, “HorLeftBorder”: 0, “VerAddrTime”: 1080, “VerBottomBorder”: 0, “VerFrontPorch”: 4, “VerSyncTime”: 5, “VerBackPorch”: 36, “VerTopBorder”: 0 1.877.877.2269 BLACKBOX.COM... - Page 17 “VerFrequency”: 59939, “PixelClock”: 148351478, “Flags”: 0, “HorAddrTime”: 1920, “HorRightBorder”: 0, “HorFrontPorch”: 44, “HorSyncTime”: 88, “HorBackPorch”: 148, “HorLeftBorder”: 0, “VerAddrTime”: 1080, “VerBottomBorder”: 0, “VerFrontPorch”: 4, “VerSyncTime”: 5, “VerBackPorch”: 36, “VerTopBorder”: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “Success”: true 1.877.877.2269 BLACKBOX.COM...
-
Page 18: Input Edid
Read or write the entire EDID for an input. The contents of the EDID are Base64 encoded. Read Input EDID GET/InputEDID.cgx{?input} Example URI GET /InputEDID.cgx?input=0 URI Parameters Hide input number (required) Example: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “EDID”:”AP Write Input EDID POST/InputEDID.cgx Example URI POST /InputEDID.cgx Request Show Headers Content-Type: application/json Body “Input”:0, “EDID”:”AP 1.877.877.2269 BLACKBOX.COM... -
Page 19: Input Edid Create
If using a custom mode, the “Custom” object is mandatory. Otherwise, it will be ignored. Example URI POST /InputEDIDCreate.cgx Request Show Headers Content-Type: application/json Body “Input”: 0, “Extension”: “CEA-861”, “Mode”: “Custom”, “Name”: “CustomHDEDID”, “Custom”: { “Timings”: { “PixelClock”: 148351478, “Flags”: 0, “HorAddrTime”: 1920, “HorRightBorder”: 0, “HorFrontPorch”: 44, “HorSyncTime”: 88, 1.877.877.2269 BLACKBOX.COM... -
Page 20: Input Edid Reset
Reset the EDID to default for a specified input or all inputs. To reset a single input’s EDID, Input must be a number. To reset all input EDIDs, Input must be “All”. Example URI POST /InputEDIDReset.cgx Request Show Headers Content-Type: application/json 1.877.877.2269 BLACKBOX.COM... -
Page 21: Input Hdcp Enable
Enable or disable HDCP on an input, in same cases it may be beneficial to disable it to avoid the source attempting and potentially failing to use HDCP when it is not necessary. Get Input HDCP Enable GET/InputHDCPEnable.cgx{?input} Example URI GET /InputHDCPEnable.cgx?input=0 URI Parameters Hide input number (required) Example: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “Enable”:true, 1.877.877.2269 BLACKBOX.COM... -
Page 22: Input Hdcp Status
3.7 INPUT HDCP STATUS Get the status of HDCP of an input. Status will be “Unknown”, “Unencrypted”, “Encrypted”, “Error” or “Failure”. Get Input HDCP Status GET/InputHDCPStatus.cgx{?input} Example URI GET /InputHDCPStatus.cgx?input=0 URI Parameters Hide input number (required) Example: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 1.877.877.2269 BLACKBOX.COM... -
Page 23: Input Maximum Link Rate
Set the maximum link rate of the input. LinkRate must be “RBR”, “HBR” or “HBR2”. Get Input Maximum Link Rate GET/InputMaxLinkRate.cgx{?input} Example URI GET /InputMaxLinkRate.cgx?input=0 URI Parameters Hide input number (required) Example: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “LinkRate”:”HBR2”, Set Input Maximum Link Rate POST/InputMaxLinkRate.cgx Example URI POST /InputMaxLinkRate.cgx Request Show Headers Content-Type: application/json 1.877.877.2269 BLACKBOX.COM... - Page 24 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 3: INPUT PROPERTIES TECHNICAL SUPPORT 1.877.877.2269 Body “Input”:0, “LinkRate”:”HBR2”, Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “Success”: true 1.877.877.2269 BLACKBOX.COM...
-
Page 25: Output Properties
Get Output Crop GET/OutputCrop.cgx{?output} Example URI GET /OutputCrop.cgx?output=0 URI Parameters Hide output number (required) Example: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “X0”: 0, “Y0”: 0, “X1”: 1, “Y1”: 1 Set Output Crop POST/OutputCrop.cgx Example URI POST /OutputCrop.cgx Request Show Headers Content-Type: application/json 1.877.877.2269 BLACKBOX.COM... -
Page 26: Output Transform
When a flip and rotation is applied simultaneously, the flip transformation is applied before the rotation. Note that flipping both the Horizontal and Vertical is equivalent to a rotation of 180 degrees. Get Output Transform GET/OutputTransform.cgx{?output} Example URI GET /OutputTransform.cgx?output=0 URI Parameters Hide output number (required) Example: 0 Response 200 1.877.877.2269 BLACKBOX.COM... - Page 27 Show Headers Content-Type: application/json; charset=utf-8 Body “Rotation”: 0, “Flip”: “None” Set Output Transform POST/OutputTransform.cgx Example URI POST /OutputTransform.cgx Request Show Headers Content-Type: application/json Body “Output”: 0, “Rotation”: 0, “Flip”: “None” Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “Success”: true 1.877.877.2269 BLACKBOX.COM...
-
Page 28: Output Enable
Enable or disable outputs. Get Output Enable GET/OutputEnable.cgx{?output} Example URI GET /OutputEnable.cgx?output=0 URI Parameters Hide output number (required) Example: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “Enable”: true Set Output Enable POST/OutputEnable.cgx Example URI POST /OutputEnable.cgx Request Show Headers Content-Type: application/json Body “Output”:0, “Enable”:true, 1.877.877.2269 BLACKBOX.COM... -
Page 29: Output Current Timings
Get the current output timings. Example URI GET /OutputCurrentTimings.cgx?output=0 URI Parameters Hide output number (required) Example: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “HorFrequency”: 67432, “VerFrequency”: 59939, “PixelClock”: 148351478, “Flags”: 0, “HorAddrTime”: 1920, “HorRightBorder”: 0, “HorFrontPorch”: 44, “HorSyncTime”: 88, “HorBackPorch”: 148, “HorLeftBorder”: 0, “VerAddrTime”: 1080, 1.877.877.2269 BLACKBOX.COM... -
Page 30: Output Preferred Timings
Hide output number (required) Example: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “HorFrequency”: 67432, “VerFrequency”: 59939, “PixelClock”: 148351478, “Flags”: 0, “HorAddrTime”: 1920, “HorRightBorder”: 0, “HorFrontPorch”: 44, “HorSyncTime”: 88, “HorBackPorch”: 148, “HorLeftBorder”: 0, “VerAddrTime”: 1080, “VerBottomBorder”: 0, “VerFrontPorch”: 4, “VerSyncTime”: 5, 1.877.877.2269 BLACKBOX.COM... -
Page 31: Output Default Timings
Content-Type: application/json; charset=utf-8 Body “HorFrequency”: 67432, “VerFrequency”: 59939, “PixelClock”: 148351478, “Flags”: 0, “HorAddrTime”: 1920, “HorRightBorder”: 0, “HorFrontPorch”: 44, “HorSyncTime”: 88, “HorBackPorch”: 148, “HorLeftBorder”: 0, “VerAddrTime”: 1080, “VerBottomBorder”: 0, “VerFrontPorch”: 4, “VerSyncTime”: 5, “VerBackPorch”: 36, “VerTopBorder”: 0, “SDILevel”: “A” 1.877.877.2269 BLACKBOX.COM... - Page 32 “VerFrequency”: 59939, “PixelClock”: 148351478, “Flags”: 0, “HorAddrTime”: 1920, “HorRightBorder”: 0, “HorFrontPorch”: 44, “HorSyncTime”: 88, “HorBackPorch”: 148, “HorLeftBorder”: 0, “VerAddrTime”: 1080, “VerBottomBorder”: 0, “VerFrontPorch”: 4, “VerSyncTime”: 5, “VerBackPorch”: 36, “VerTopBorder”: 0, “SDILevel”: “A” Response 200 Show Headers Content-Type: application/json; charset=utf-8 1.877.877.2269 BLACKBOX.COM...
-
Page 33: Output Timing Source
“Default”: Use the “Default” timing specified by OutputDefaultTimings Get Output Timing Source GET/OutputTimingSource.cgx{?output} Example URI GET /OutputTimingSource.cgx?output=0 URI Parameters Hide output number (required) Example: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “Source”: “Monitor” Set Output Timing Source POST/OutputTimingSource.cgx Example URI POST /OutputTimingSource.cgx Request Show Headers Content-Type: application/json 1.877.877.2269 BLACKBOX.COM... -
Page 34: Output Current Timing Source
Get the current timing source. Source will be one of the following: “Monitor”: Use the connected monitor’s preferred timings “Default”: Use the “Default” timing specified by OutputDefaultTimings Get Output Timing Source GET/OutputCurrentTimingSource.cgx{?output} Example URI GET /OutputCurrentTimingSource.cgx?output=0 URI Parameters Hide output number (required) Example: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “Source”: “Monitor” 1.877.877.2269 BLACKBOX.COM... -
Page 35: Output Image Source
Get Output Image Source GET/OutputImageSource.cgx{?output} Example URI GET /OutputImageSource.cgx?output=0 URI Parameters Hide output number (required) Example: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “Source”: “InputCapture” Set Output Image Source POST/OutputImageSource.cgx Example URI POST /OutputImageSource.cgx Request Show Headers Content-Type: application/json Body “Output”: 0, “Source”: “InputCapture” 1.877.877.2269 BLACKBOX.COM... -
Page 36: Output Genlock Source
“Input0”: Try and genlock to input 0 “Input1”: Try and genlock to input 1 “Input2”: Try and genlock to input 2 Get Output Genlock Source GET/OutputGenlockSource.cgx{?output} Example URI GET /OutputGenlockSource.cgx?output=0 URI Parameters Hide output number (required) Example: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “GenlockSource”: “Sync” 1.877.877.2269 BLACKBOX.COM... -
Page 37: Output Genlock Status
Show Headers ontent-Type: application/json; charset=utf-8 Body “Success”: true 4.11 OUTPUT GENLOCK STATUS Output Get Genlock Status GET/OutputGenlockStatus.cgx Get the genlock status. Will be “None”, “Sync”, “Input”, “Input0”, “Input1” or “Input2”. Example URI GET /OutputGenlockStatus.cgx Response 200 Show Headers Content-Type: application/json; charset=utf-8 1.877.877.2269 BLACKBOX.COM... -
Page 38: Output Hdcp Status
Content-Type: application/json; charset=utf-8 Body “Status”:”Encrypted”, 4.13 OUTPUT LINK TRAINING RESULT GET/OutputLinkTraining.cgx{?output} For a DisplayPort output, get the link training result. LinkRate will be “None”, “RBR”, “HBR” or “HBR2”. LaneCount will be 0, 1, 2 or 4. Example URI GET /OutputLinkTraining.cgx?output=0 1.877.877.2269 BLACKBOX.COM... - Page 39 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 CHAPTER 4: OUTPUT PROPERTIES TECHNICAL SUPPORT 1.877.877.2269 URI Parameters Hide output number (required) Example: 0 Response 200 Show Headers Content-Type: application/json; charset=utf-8 Body “LinkRate”:”HBR2” “LaneCount”:4 1.877.877.2269 BLACKBOX.COM...
-
Page 40: Disclaimer/Trademarks
5.2 TRADEMARKS USED IN THIS MANUAL Black Box and the Black Box logo type and mark are registered trademarks of Black Box Corporation. Any other trademarks mentioned in this manual are acknowledged to be the property of the trademark owners. 1.877.877.2269 BLACKBOX.COM... - Page 41 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 NOTES TECHNICAL SUPPORT 1.877.877.2269 __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ _________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________\ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ _________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ 1.877.877.2269 BLACKBOX.COM...
- Page 42 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 NOTES TECHNICAL SUPPORT 1.877.877.2269 __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ _________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________\ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ _________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ 1.877.877.2269 BLACKBOX.COM...
- Page 43 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 NOTES TECHNICAL SUPPORT 1.877.877.2269 __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ _________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________\ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ _________________________________________________________________________________________________ __________________________________________________________________________________________________ __________________________________________________________________________________________________ 1.877.877.2269 BLACKBOX.COM...
- Page 44 NEED HELP? LEAVE THE TECH TO US LIVE 24/7 TECHNICAL SUPPORT 1.877.877.2269 © COPYRIGHT 2017 BLACK BOX CORPORATION. ALL RIGHTS RESERVED.
Need help?
Do you have a question about the VIDEOPLEX 4000 and is the answer not in the manual?
Questions and answers