Calibre UK HQView-500 Series Bedienungsanleitung

Issue 2.00 Page i 06 June 2012 HQView/LEDView API Protocol

Issue 2.00 Page x 06 June 2012 2.89.3. byOsdSaveAnnounceAuxData 78 2.90. Announce Data Repeat Period 78 2.90.1. byOsdSetAnnounceRepeatPeriod 7

Issue 2.00 Page 88 06 June 2012 2.104. HDMI/DVI Input Range 2.104.1. byOsdDviInRangeSet API index: 3259 Sets HDMI/DVI Input Range. Input Pa

Issue 2.00 Page 89 06 June 2012 2.105. 3G-SDI Level B Stream Selection 2.105.1. byOsdSdiLevBStreamSet API index: 3262 Selects Stream 1 or 2

Issue 2.00 Page 90 06 June 2012 2.106.2. byOsdSdiDataMapGet API index: 3266 Retrieves the SDI output mode setting from cache or from the SPD.

Issue 2.00 Page 91 06 June 2012 2.107.3. byOsdEdgeBlendBlackLevelTopl/Top/Topr/Midl/Mid/Midr/Botl/Bot/BotrSave API indices: 3132/3135/3138/314

Issue 2.00 Page 92 06 June 2012 2.109. SDI Audio Channel Mapping 2.109.1. byOsdSdiAudioChannelSet API index: 3280 Sets the SDI audio channel

Issue 2.00 Page 93 06 June 2012 2.110. SDI Audio SPDIF Routing 2.110.1. byOsdSdiOnSpdifSet API index: 3283 Sets whether SDI audio is out

Issue 2.00 Page 94 06 June 2012 2.111. Test Pattern Selection 2.111.1. byOsdTestPatternSet API index: 3320 Selects the test pattern to be di

Issue 2.00 Page 95 06 June 2012 2.112. Moving Test Pattern Speed 2.112.1. byOsdTpgSpeedSet API index: 3286 Sets the motion speed of the diago

Issue 2.00 Page 96 06 June 2012 2.113. Moving Test Pattern Foreground Color 2.113.1. byOsdTpgFgColSet API index: 3290 Sets the foreground col

Issue 2.00 Page 97 06 June 2012 2.114. Moving Test Pattern Background Color 2.114.1. byOsdTpgBgColSet API index: 3293 Sets the background col

Issue 2.00 Page xi 06 June 2012 2.105.3. byOsdSdiLevBStreamSave 89 2.106. SDI Output Data Map 89 2.106.1. byOsdSdiDataMapSet 89 2.106.2. byOsd

Issue 2.00 Page 98 06 June 2012 2.115. Moving Test Pattern Line Thickness 2.115.1. byOsdTpgWidthSet API index: 3296 Sets the line thickness o

Issue 2.00 Page 99 06 June 2012 2.116. VT Filter Strength 2.116.1. byOsdVTStrengthSet API index: 3240 Sets the strength of the vertical tempo

Issue 2.00 Page 100 06 June 2012 2.117. VT Filter Recursion Setting 2.117.1. byOsdVTRecursionSet API index: 3243 Switches the recursion filte

Issue 2.00 Page 101 06 June 2012 2.118. Sync Mode VGA Output 2.118.1. byOsdOutputSyncModeSet API index: 3246 Switches between separate, compo

Issue 2.00 Page 102 06 June 2012 2.119. LED Screen Window Size Enabling 2.119.1. byOsdOutWinSizeEnableSetSave API index: 3306 Enable Window S

Issue 2.00 Page 103 06 June 2012 2.120. LED Screen Window Size 2.120.1. byOsdOutWinLeft/Right/Top/BottomEdgeSet API indices: 3308/3311/3314/

Issue 2.00 Page 104 06 June 2012 2.121. OSD Enabling/Disabling 2.121.1. byOsdEnableSet API index: 3373 Switches off the OSD. Note; This com

Issue 2.00 Page xii 06 June 2012 2.121. OSD Enabling/Disabling 104 2.121.1. byOsdEnableSet 104 2.121.2. byOsdEnableGet 104 2.121.3. byOsdEnabl

Issue 2.00 Page 1 06 June 2012 1. Communication 1.1. API Call Communication between the PC and the Scaler Board is through remote API calls an

Issue 2.00 Page 2 06 June 2012 74 50 01 00 00 00 00 00 ww xx yy zz 00 00 00 00 ww xx yy zz is the payload size (type UWORD32) of the follow

Issue 2.00 Page 3 06 June 2012 Connect the PC’s serial port to the PV6 Scaler SK18 connector using a 9-pin serial extension cable, that is one

Issue 2.00 Page 4 06 June 2012 values) 74 50 01 00 00 00 00 00 00 00 00 0D 00 00 00 00 70 46 00 7C 00 00 00 00 00 00 00 01 00 PC a

Issue 2.00 Page 5 06 June 2012 contrast setting. The value in the SPD and cache can differ, if a change was issued by calling

Issue 2.00 Page 6 06 June 2012 Board acknowledges to have received a command None Board sends answer (return values) 74 50 01 00 00 00 00 00 0

Issue 2.00 Page 7 06 June 2012 2. API Functions APIs may have a “Get”, “Set” and “Save” function. “Get” reads values, “Set” writes values into

Issue 2.00 Page ii 06 June 2012 Revision History Version Author Modification Date 1.00 DB Initial Release 05.03.2010 1.01 DB Added Edge Blend Offs

Issue 2.00 Page 8 06 June 2012 2.1.3. byOsdInputFormatSave API index: 319 Saves the main input channel from cache into the SPD. Input Paramete

Issue 2.00 Page 9 06 June 2012 2.3. Black-Level 2.3.1. byOsdBlackLevelSet API index: 104 (sic!) Sets the black level offset. Input Parameters

Issue 2.00 Page 10 06 June 2012 2.4.2. byOsdContrastGet API index: 126 Retrieves the contrast (gain) from either cache or the SPD. Input Param

Issue 2.00 Page 11 06 June 2012 2.5.3. byOsdColorSave API index: 128 Saves the color saturation from cache into the SPD. Input Parameters None

Issue 2.00 Page 12 06 June 2012 2.7. R/G/B Bias 2.7.1. byOsdR/G/BOffsetSet API indices: 2809/2812/2815 Sets the offset. For the individual col

Issue 2.00 Page 13 06 June 2012 2.8.2. byOsdR/G/BGainGet API indices: 2801/2804/2807 Retrieves the gain value from either cache or the SPD. In

Issue 2.00 Page 14 06 June 2012 2.9.3. byOsdColorTempSave API index: 350 Saves the color temperature value from cache into the SPD. Input Para

Issue 2.00 Page 15 06 June 2012 2.11. Horizontal Position 2.11.1. byOsdMainHorizontalSet API index: 362 Sets the horizontal position of the i

Issue 2.00 Page 16 06 June 2012 2.12.2. byOsdMainVerticalGet API index: 367 Retrieves vertical position from either cache or the SPD. Input Pa

Issue 2.00 Page 17 06 June 2012 2.13.3. byOsdLeft/Right/Top/BottomEdgeSave API indices: 2927/2930/2933/2936 Saves the left/right/top/bottom ed

Issue 2.00 Page iii 06 June 2012 This manual details the protocol used to remotely control your HQView and LEDView image scaler. If you have

Issue 2.00 Page 18 06 June 2012 2.15. Auto Setup 2.15.1. byOsdAutoConfigSet API index: 417 Initiates auto setup of VGA signal. Input Paramete

Issue 2.00 Page 19 06 June 2012 2.16.3. byOsdAbsoluteClockGetRange API index: 4000 Retrieves the allowed range for the absolute clock value. I

Issue 2.00 Page 20 06 June 2012 2.18. Select Warp Application 2.18.1. byOsdProjectionAppsSet API index: 1645 Selects the embedded warp API. I

Issue 2.00 Page 21 06 June 2012 2.19. Select Warp Map Slot 2.19.1. byOsdUserMapSet API index: 139 Selects the embedded warp API. Input Parame

Issue 2.00 Page 22 06 June 2012 2.20. Horizontal Keystone 2.20.1. byOsdHKeystoneSet API index: 332 Selects the embedded warp API. Input Param

Issue 2.00 Page 23 06 June 2012 2.21.2. byOsdVKeystoneGet API index: 338 Retrieves the number of the slot being selected. Input Parameters Nam

Issue 2.00 Page 24 06 June 2012 2.22.3. by4CornerY1SetValue API index: 781 Moves the y-position of the upper left corner. The value

Issue 2.00 Page 25 06 June 2012 2.23.3. by4CornerY2SetValue API index: 783 Moves the y-position of the upper right corner. The value

Issue 2.00 Page 26 06 June 2012 2.24.3. by4CornerY3SetValue API index: 785 Moves the y-position of the lower left corner. The value

Issue 2.00 Page 27 06 June 2012 2.25.3. by4CornerY4SetValue API index: 787 Moves the y-position of the lower right corner. The value

Issue 2.00 Page iv 06 June 2012 Contents 1. Communication 1 1.1. API Call 1 1.2. Handshake 1 1.3. API Return 1 1.4. Data Types 2 1.5. UAR

Issue 2.00 Page 28 06 June 2012 2.26.3. byOsdPinBarrelSave API index: 842 Saves the value from cache into the SPD. Input Parameters None Retur

Issue 2.00 Page 29 06 June 2012 2.28. Picture Format 2.28.1. byOsdAspectRatioSet API index: 186 Sets the picture format / aspect ratio treatm

Issue 2.00 Page 30 06 June 2012 2.29.2. byOsdOverscanGet API index: 2945 Retrieves overscan setting from either cache or the SPD. Input Parame

Issue 2.00 Page 31 06 June 2012 2.30.2. byOsdPipInputFormatGet API index: 323 Retrieves the PIP input channel setting from either cache or the

Issue 2.00 Page 32 06 June 2012 2.31.2. byOsdPipOnOffGet API index: 317 Retrieves the PIP mode setting from either cache or the SPD. Input Par

Issue 2.00 Page 33 06 June 2012 2.33. PIP Position 2.33.1. byOsdPipPosSet API index: 368 Sets the PiP Position. Input Parameters Name Type Ra

Issue 2.00 Page 34 06 June 2012 2.34.2. byOsdPipXGet API index: 3212 Retrieves the PiP Horizontal Position from either cache or the SPD. Input

Issue 2.00 Page 35 06 June 2012 2.35.3. byOsdPipYSave API index: 3216 Saves the PiP Position setting from cache into the SPD. Input Parameters

Issue 2.00 Page 36 06 June 2012 2.37. Detail Enhancement 2.37.1. byOsdDetailSet API index: 133 Sets the level of the detail enhancement algor

Issue 2.00 Page 37 06 June 2012 2.38.2. byOsdSTILTIGet API index: 610 Retrieves the level of the LTI filter from either cache or the SPD. Inpu

Issue 2.00 Page v 06 June 2012 2.13.2. byOsdLeft/Right/Top/BottomEdgeGet 16 2.13.3. byOsdLeft/Right/Top/BottomEdgeSave 17 2.14. Aspect Ratio Co

Issue 2.00 Page 38 06 June 2012 2.39.3. byOsdSTICTISave API index: 612 Saves the level of the CTI filter from cache into the SPD. Input Parame

Issue 2.00 Page 39 06 June 2012 2.41. MNR 2.41.1. byOsdCNRSet API index: 251 Sets the level of the MNR (MPEG Codec noise reduction) algorithm

Issue 2.00 Page 40 06 June 2012 2.42.2. byOsdCCSGet API index: 2976 Retrieves the status of the CCS from either cache or the SPD. Input Parame

Issue 2.00 Page 41 06 June 2012 2.44. Input Name 2.44.1. byOsdInputRenameSet API index: 2950 Renames one of the inputs. Input Parameters Name

Issue 2.00 Page 42 06 June 2012 2.45.2. byOsdUserRenameGet API index: 2954 Retrieves a user name from either cache or the SPD. Input Parameter

Issue 2.00 Page 43 06 June 2012 2.48. Save profile as 2.48.1. byOsdProfileSaveAs API index: 2958 Copies all settings from the current profile

Issue 2.00 Page 44 06 June 2012 2.50. Component Type 2.50.1. byOsdComponentTypeSet API index: 2962 Sets the component input type, i.e. colors

Issue 2.00 Page 45 06 June 2012 2.51.2. byOsdDVI1EQGet API index: 2833 Retrieves setting for DVI port equalization from either cache or the S

Issue 2.00 Page 46 06 June 2012 2.52.3. byOsdProcessingModeSave API index: 2967 Saves the processing mode setting from cache into the SPD. Inp

Issue 2.00 Page 47 06 June 2012 2.54. Menu Position 2.54.1. byOsdMenuPositionSet API index: 2971 Sets menu position on screen. Input Paramete

Issue 2.00 Page vi 06 June 2012 2.27.1. byOsdRotationAngleSet 28 2.27.2. byOsdRotationGet 28 2.27.3. byOsdRotationSave 28 2.28. Picture Forma

Issue 2.00 Page 48 06 June 2012 2.55.2. byOsdOsdMessagesGet API index: 3274 Retrieves the set-up of OSD messaging. Input Parameters Name Type

Issue 2.00 Page 49 06 June 2012 2.56.3. byOsdLanguageSave API index: 446 Saves the OSD language setting from cache into the SPD. Input Paramet

Issue 2.00 Page 50 06 June 2012 2.58. Display Type 2.58.1. byOsdDisplayTypeSet API index: 3303 Sets the Ouput Display Type. Input Parameters

Issue 2.00 Page 51 06 June 2012 2.59. Optimise for Display 2.59.1. byOsdPV6OptimiseSet API index: 2818 Activates communication with a display

Issue 2.00 Page 52 06 June 2012 2.60. Ouput Mode 2.60.1. byOsdOuputFormatSet API index: 324 Sets the Ouput Mode Resolution. Input Parameters

Issue 2.00 Page 53 06 June 2012 2.60.3. byOsdOutputFormatSave API index: 325 Saves the Output Mode Resolution setting from cache into the SPD.

Issue 2.00 Page 54 06 June 2012 2.62. Frame Rate Settings Availability Control Note: This feature is only available on HQView-5xx. 2.62.1. by

Issue 2.00 Page 55 06 June 2012 2.63. I/O Lock 2.63.1. byOSDIoLockSet API index: 2978 Sets the Lock Type between PLL modulation and free run

Issue 2.00 Page 56 06 June 2012 2.64. Native Color Temp 2.64.1. byOsdNativeColorTempSet API index: 2827 Sets the Color Temperature of the out

Issue 2.00 Page 57 06 June 2012 2.65. Ouput Gamma 2.65.1. byOsdGammaOutSet API index: 346 Sets the Ouput Gamma. Input Parameters Name Type Ra

Issue 2.00 Page vii 06 June 2012 2.42.2. byOsdCCSGet 40 2.42.3. byOsdCCSSave 40 2.43. User 40 2.43.1. byOsdCurrentUserSet 40 2.43.2. byOsdC

Issue 2.00 Page 58 06 June 2012 2.66.2. byGetDHCPStatus API index: 84 Retrieves the IP address type from the SPD. Input Parameters Name Type R

Issue 2.00 Page 59 06 June 2012 2.68.2. byGetSubnetMask API index: 114 Retrieves the IP address from the SPD. Input Parameters Name Type Range

Issue 2.00 Page 60 06 June 2012 2.70. Multiple Unit Width 2.70.1. byOsdMultipleUnitWidthSet API index: 3100 Sets the number of units in horiz

Issue 2.00 Page 61 06 June 2012 2.71.2. byOsdMultipleUnitHeightGet API index: 3104 Retrieves the number of units in horizontal direction. Inp

Issue 2.00 Page 62 06 June 2012 2.72.3. byOsdMultipleUnitHorizontalSave API index: 3108 Saves the number from cache into the SPD. Input Param

Issue 2.00 Page 63 06 June 2012 2.74. Blend Curve Type 2.74.1. byOsdEdgeBlendCurveTypeSet API index: 3112 Sets the blend curve type. Input Pa

Issue 2.00 Page 64 06 June 2012 2.75. S-Curve Value 2.75.1. byOsdEdgeBlendScurveValueSet API index: 3115 Sets the S-curve value. Input Parame

Issue 2.00 Page 65 06 June 2012 2.76. Alpha Map Activation 2.76.1. byOsdEdgeBlendCustAlphaSet API index: 3350 Activate the Custom Alpha Map.

Issue 2.00 Page 66 06 June 2012 2.77. Edge Blend Top Border 2.77.1. byOsdEdgeBlendTopBorderSet API index: 3118 Sets the edge blend top border

Issue 2.00 Page 67 06 June 2012 2.78. Edge Blend Bottom Border 2.78.1. byOsdEdgeBlendBotBorderSet API index: 3121 Sets the edge blend bottom

Issue 2.00 Page viii 06 June 2012 2.59. Optimise for Display 51 2.59.1. byOsdPV6OptimiseSet 51 2.59.2. byOsdPV6OptimiseGet 51 2.59.3. byOsdPV

Issue 2.00 Page 68 06 June 2012 2.79. Edge Blend Left Border 2.79.1. byOsdEdgeBlendLeftBorderSet API index: 3124 Sets the edge blend left bor

Issue 2.00 Page 69 06 June 2012 2.80. Edge Blend Right Border 2.80.1. byOsdEdgeBlendRightBorderSet API index: 3127 Sets the edge blend right

Issue 2.00 Page 70 06 June 2012 2.81. Edge Blend Top Border Offset 2.81.1. byOsdEdgeBlendTopOffsetSet API index: 3175 Sets the edge blend top

Issue 2.00 Page 71 06 June 2012 2.82. Edge Blend Bottom Border Offset 2.82.1. byOsdEdgeBlendBotOffsetSet API index: 3178 Sets the edge blend

Issue 2.00 Page 72 06 June 2012 2.83. Edge Blend Left Border Offset 2.83.1. byOsdEdgeBlendLeftOffsetSet API index: 3181 Sets the edge blend l

Issue 2.00 Page 73 06 June 2012 2.84. Edge Blend Right Border Offset 2.84.1. byOsdEdgeBlendRightOffsetSet API index: 3184 Sets the edge blend

Issue 2.00 Page 74 06 June 2012 2.85. PiP/Multiple Unit Operation Mode Only available on HQView-410/420 models. 2.85.1. byOsdPIPEBOperationMo

Issue 2.00 Page 75 06 June 2012 2.86. Enable Announce Messages Announce Messages are only available on the HQView-3xx, 200 and 100 modules. 2.

Issue 2.00 Page 76 06 June 2012 2.87. Announce Server IP Address 2.87.1. byOsdSetAnnounceServerIPAddress API index: 4204 Set the IP address o

Issue 2.00 Page 77 06 June 2012 2.88.2. byOSDGetAnnounceServerPort API index: 4206 Retrieve the Announce Message server port. Input Parameters

Issue 2.00 Page ix 06 June 2012 2.74.3. byOsdEdgeBlendCurveTypeSave 63 2.75. S-Curve Value 64 2.75.1. byOsdEdgeBlendScurveValueSet 64 2.75.2.

Issue 2.00 Page 78 06 June 2012 2.89.3. byOsdSaveAnnounceAuxData API index: 4208 Saves the string from cache into the SPD. Input Parameters No

Issue 2.00 Page 79 06 June 2012 2.91. Output Blanking 2.91.1. byBlankOutputSet API index: 2990 The output is blanked with a black image. Inp

Issue 2.00 Page 80 06 June 2012 2.93. PTZ Enabling 2.93.1. byOsdPtzEnableSetSave API index: 3220 Enables PTZ and saves the setting in the SPD

Issue 2.00 Page 81 06 June 2012 2.94.3. byOsdPtzSettingSave API index: 3224 Saves the PTZ scope setting from cache into the SPD. Input Paramet

Issue 2.00 Page 82 06 June 2012 2.96. PTZ Tilt 2.96.1. byOsdPtzTiltSet API index: 3228 Sets the Tilt position. Input Parameters Name Type Ra

Issue 2.00 Page 83 06 June 2012 2.97.2. byOsdPtzZoomHGet API index: 3232 Retrieves the horizontal zoom factor from cache or from the SPD. Inpu

Issue 2.00 Page 84 06 June 2012 2.98.3. byOsdPtzZoomVSave API index: 3236 Saves the vertical zoom factor from cache into the SPD. Input Parame

Issue 2.00 Page 85 06 June 2012 2.100. DVI Output Color Space 2.100.1. byOsdDviOutCscSet API index: 3250 Sets DVI Output Color Space. Input

Issue 2.00 Page 86 06 June 2012 2.101.2. byOsdDviOutRangeGet API index: 3254 Retrieves the DVI Output Range setting from cache or from the SPD

Issue 2.00 Page 87 06 June 2012 2.102.3. byOsdDVIIPortSave API index: 3302 Saves the DVI-I input port processing setting from cache into the S