Manual

ManualsBrandsKramer Electronics ManualsMeasuring instrumentsVP-790

KRAMER ELECTRONICS LTD.

RS-232

PROTOCOL

GUIDE

VP-790

Protocol Document

P/N: 2900-300172 Rev 2

Summary of content (126 pages)

PAGE 1
K R A ME R E LE CT R O N IC S L T D .
PAGE 2
Contents 1 1.1 1.2 1.3 1.4 1.5 1.6 1.7 2 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 2.10 2.11 2.12 2.13 2.14 2.15 2.16 2.17 2.18 2.19 2.20 2.21 2.22 2.23 2.24 2.25 2.26 2.27 2.28 2.29 2.30 2.31 2.32 2.33 2.34 2.35 2.36 2.37 2.38 2.39 2.40 2.41 2.
PAGE 3
2.43 2.44 2.45 2.46 2.47 2.48 2.49 2.50 2.51 2.52 2.53 2.54 2.55 2.56 2.57 2.58 2.59 2.60 2.61 2.62 2.63 2.64 2.65 2.66 2.67 2.68 2.69 2.70 2.71 2.72 2.73 2.74 2.75 2.76 2.77 2.78 2.79 2.80 2.81 2.82 2.83 2.84 2.85 2.86 2.87 2.88 2.89 2.90 2.91 2.92 2.93 2.94 2.95 2.
PAGE 4
2.97 2.98 2.99 2.100 2.101 2.102 2.103 2.104 2.105 2.106 2.107 2.108 2.109 2.110 2.111 2.112 2.113 2.114 2.115 2.116 2.117 2.
PAGE 5
1 1.1 Communication API Call 2B Communication between the PC and the Scaler Board is through remote API calls and corresponding answers. i All the values indicated blue are fixed. They need to be sent or received, but the values will not change in the given context. An API function call has a 16 Byte logical header, followed by a 16 byte application Header, followed by the data package of variable length.
PAGE 6
The data to be sent is (hex): 53 41 50 01 FF FF FF FF 00 00 00 20 00 00 00 00 54 50 01 00 00 00 00 00 00 00 00 10 00 00 00 00 50 46 00 68 00 00 00 00 00 00 00 04 7F FF FF FF 1.2 Handshake All API calls (and API returns) are acknowledged by the RS232 receiver with the following (logical header only) (hex): 73 61 50 01 FF FF FF FF 00 00 00 00 00 00 00 00 1.3 API Return The acknowledgement is followed by the API return.
PAGE 7
Example: The Scaler Board answers to the BYTE byOSDBrighntessSet(UWORD32 u32_value) API call. The return value is 0x00, i.e.
PAGE 8
1.5 UART Connector and UART Configuration The board UART connector is PL9 or SK18. PL9 Connector Type: 3-way 0.1” male, mating type 3-way 0.1” female PL9 Pin SK18 Pin Signal name Function 1 3 RXDA232 RS232 levels, Rx (from the HOST) 2 2 TXDA232 RS232 levels, Tx (to the HOST) 3 5 DGND Ground Connect the PC’s serial port to the Scaler RS-232 connector using a 9-pin serial extension cable, that is one wired pin-pin with a male connector on one end and a female on the other.
PAGE 9
1.7 Examples 8B The following examples are used to explain how the API calls and protocol work: • Change the Contrast Setting for runtime use. Increase the contrast (gain) by 10% (see Section 1.7.1) • Save the Contrast Setting such that it is permanently stored in non-volatile memory (flash) and used the next time the system is reset or powered up again (see Section 1.7.2) • Read back the Contrast Setting from non-volatile memory (see Section 1.7.3) 1.7.1 • Switch between inputs (see Section 1.7.
PAGE 10
16 = 0x10 bytes. The logical header (line 1) indicates a payload of 16 bytes application header plus 16 bytes of the data package, i.e. 32 = 0x20 bytes. The API answer has a payload of 0x01 byte, the error code. The data package (line 3) is 12 bytes long plus the length of the data. Therefore, the application header (line 2) indicates now a payload of 13 = 0x0D bytes. The logical header (line 1) indicates a payload of 16 bytes application header plus 13 bytes of the data package, i.e. 29 = 0x1D bytes.
PAGE 11
For the API call the data is 0 = 0x00 bytes long since there are no parameters passed. The data package (line 3) is 12 bytes long plus the length of the data. Therefore, the application header (line 2) indicates a payload of 12 + 0 = 0x0C bytes. The logical header (line 1) indicates a payload of 16 bytes application header plus 12 bytes of the data package, i.e. 28 = 0x1C bytes.
PAGE 12
The return value(s) of this API function is the error code of BYTE type, i.e. a 1 byte value. It is 0x00 if the call was successful or an error occurred if it is not zero. Let us assume the call was successful for this example. The other return value is the current contrast setting of UWORD32 type, i.e. a 4 byte value. Let us assume it is the by 10% increased value of the foregoing example, i.e. 0x92 1A 18 50. The payload of the data is 5 bytes. The payload of the data package is 12 + 5 bytes = 0x11 bytes.
PAGE 13
Direction RS232 data PC sends command 53 41 50 01 FF FF FF FF 00 00 00 20 00 00 00 00 54 50 01 00 00 00 00 00 00 00 00 10 00 00 00 00 50 46 01 3E 00 00 00 00 00 00 00 04 00 00 00 08 Board acknowledges to have received a command 73 61 50 01 FF FF FF FF 00 00 00 00 00 00 00 00 Board sends answer (return values) 53 41 50 01 FF FF FF FF 00 00 00 1D 00 00 00 00 74 50 01 00 00 00 00 00 00 00 00 0D 00 00 00 00 70 46 01 3E 00 00 00 00 00 00 00 01 00 PC acknowledges to have received an 73 61 50 01 FF FF FF F
PAGE 14
Direction RS232 data PC sends command 53 41 50 01 FF FF FF FF 00 00 00 2E 00 00 00 00 54 50 01 00 00 00 00 00 00 00 00 1E 00 00 00 00 50 46 0B 89 00 00 00 00 00 00 00 12 00 00 00 01 00 00 00 0A 53 55 52 47 45 4F 4E 20 31 00 Board acknowledges to have received a command 73 61 50 01 FF FF FF FF 00 00 00 00 00 00 00 00 Board sends answer (return values) 53 41 50 01 FF FF FF FF 00 00 00 1D 00 00 00 00 74 50 01 00 00 00 00 00 00 00 00 0D 00 00 00 00 70 46 0B 89 00 00 00 00 00 00 00 01 00 PC acknowledges
PAGE 15
2 API Functions APIs may have a “Get”, “Set” and “Save” function. “Get” reads values, “Set” writes values into volatile RAM and “Save” writes values into the System Parameter Database which is located in non-volatile Flash. E.g. setting the brightness by a byOSDBrightnessSet API call will change the image brightness at runtime. After a Scaler Board reset the (default) value stored in the SPD is used to initialize the brightness setting.
PAGE 16
2.1.3 byOsdSdiLevBStreamSave API index: 3264 Saves the Stream setting from cache into the SPD. Input Parameters None Return Values Name Status Type BYTE Range 0x00-0xFF Description if successful, error code otherwise 2.2 4 Corner Black Level Uplift Reduction 2.2.
PAGE 17
2.3 4-Corner Lower Left Corner 1B 2.3.1 by4CornerX3SetValue 138B API index: 784 Moves the x-position of the lower left corner. The value is stored in cash and SPD, there is no separate Save function. Input Parameters Name Value Type SWORD32 Range -1000 .. +1000 Description Moves the x-position of the lower left corner. Return Values Name Status 2.3.2 Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise byOsd4CornerX3Get 139B API index: 738 Retrieves the position.
PAGE 18
2.3.4 byOSD4CornerY3Get API index: 739 Retrieves the position. Input Parameters Name Option Type BYTE Range 0: From cache 1: From SPD Description Retrieval method Return Values Name Type Range Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value SWORD32 -1000 .. +1000 Retrieves the position. 2.4 4-Corner Lower Right Corner 2.4.1 by4CornerX4SetValue API index: 786 Moves the x-position of the lower right corner.
PAGE 19
2.4.3 by4CornerY4SetValue 14B API index: 787 Moves the y-position of the lower right corner. The value is stored in cash and SPD, there is no separate Save function. Input Parameters Name Value Type SWORD32 Range -1000 .. +1000 Description Moves the y-position of the lower right corner. Return Values Name Status 2.4.4 Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise byOSD4CornerY4Get 145B API index: 741 Retrieves the position.
PAGE 20
2.5.2 byOsd4CornerX1Get API index: 734 Retrieves the position. Input Parameters Name Option Type BYTE Range 0: From cache 1: From SPD Description Retrieval method Return Values Name 2.5.3 Type Range Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value SWORD32 -1000 .. +1000 Retrieves the position. by4CornerY1SetValue API index: 781 Moves the y-position of the upper left corner. The value is stored in cash and SPD, there is no separate Save function.
PAGE 21
2.6 4-Corner Upper Right Corner 2.6.1 14B by4CornerX2SetValue 150B API index: 782 Moves the x-position of the upper right corner. The value is stored in cash and SPD, there is no separate Save function. Input Parameters Name Value Type SWORD32 Range -1000 .. +1000 Description Moves the x-position of the upper right corner. Return Values Name Status 2.6.2 Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise byOsd4CornerX2Get 15B API index: 736 Retrieves the position.
PAGE 22
2.6.4 byOSD4CornerY2Get API index: 737 Retrieves the position. Input Parameters Name Option Type BYTE Range Description 0: From cache 1: From SPD Retrieval method Return Values Name Type Range Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value SWORD32 -1000 .. +1000 Retrieves the position. 2.7 Alpha Map Activation 2.7.1 byOsdEdgeBlendCustAlphaSet API index: 3350 Activate the Custom Alpha Map.
PAGE 23
2.8 Announce Data 2.8.1 16B byOsdSetAnnounceAuxData 157B API index: 4210. Defines a string to be sent. Input Parameters Name Value Type STRING Range Description String with 16 ASCII characters /0 terminated Port Return Values Name Status 2.8.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdGetAnnounceAuxData 158B API index: 4209 Retrieves the string being sent. Input Parameters Name Type Range Description None Return Values Name 2.8.
PAGE 24
2.9 Announce Server Port 2.9.1 byOsdSetAnnounceServerPort API index: 4207 Set the Announce Message server port. Input Parameters Name Value Type UWORD16 Range Description 0x0000-0xFFFF (or decimal 0 ... 65535) Port Return Values Name Status 2.9.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOSDGetAnnounceServerPort API index: 4206 Retrieve the Announce Message server port.
PAGE 25
2.10 Announce Data Repeat Period 2.10.1 18B byOsdSetAnnounceRepeatPeriod 163B API index: 4213 Set the period after which the announce message is automatically repeated. Input Parameters Name Value Type UWORD32 Range Description 0x0000-0x270F (or decimal 0 ... 9999) Repeat rate in seconds. Return Values Name Status 2.10.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdGetAnnounceRepeatPeriod 164B API index: 4212 Retrieves the IP address from the SPD.
PAGE 26
2.11 Announce Server IP Address 2.11.1 byOsdSetAnnounceServerIPAddress API index: 4204 Set the IP address of the server where to send the messages. Input Parameters Name Value Type STRING Range Description nnn.nnn.nnn.nnn String with 15 ASCII characters /0 terminated IP address of server where to send the messages. Return Values Name Status 2.11.
PAGE 27
2.12 Auto Setup 2.12.1 20B byOsdAutoConfigSet 169B API index: 417 Initiates auto setup of VGA signal. Input Parameters Name Type Range Type Range Description None Return Values Name Status 2.13 BYTE 0x00-0xFF Description 0 if successful, error code otherwise AutoZoom 2.13.1 21B byOsdMultipleUnitAutozoomSet 170B API index: 3169 Enable/Disables AutoZoom Input Parameters Name Value Type UWORD32 Range 0: Off 1: On Description Enable/disable the automatic zoom.
PAGE 28
2.13.3 byOsdMultipleUnitAutozoomSave API index: 3171 Saves the AutoZoom status from cache into the SPD. Input Parameters None Return Values Name Status Type BYTE Range 0x00-0xFF 2.14 Blend Curve Type 2.14.1 byOsdEdgeBlendCurveTypeSet Description 0 if successful, error code otherwise API index: 3112 Sets the blend curve type. Input Parameters Name Value Type UWORD32 Name Status 2.14.2 Range Type BYTE Description 0: Off Sets the blend curve type.
PAGE 29
2.15 Black-Level 2.15.1 23B byOsdBlackLevelSet 176B API index: 104 (sic!) Sets the black level offset. Input Parameters Name Value Type UWORD32 Range Description 0x00000000: -25 IRE 0x7FFFFFFF: 0 IRE 0xFFFFFFFF: +25 IRE Black level Return Values Name Status 2.15.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdBlackLevelGet 17B API index: 123 Retrieves the black level offset from either cache or the SPD.
PAGE 30
2.16 Black-Level Offset Compensation 2.16.1 byOsdBlackLevelOffsetSet API index: 148 Sets the black level offset. Input Parameters Name Value Type UWORD32 Range 0: 0 IRE 1: 7.5 IRE Description Black level offset to compensate Return Values Name Status 2.16.2 Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise byOsdBlackLevelOffsetGet API index: 150 Retrieves the black level offset from either cache or the SPD.
PAGE 31
2.17 Black Level Uplift 2.17.1 25B byOsdEdgeBlendBlackLevelTopl/Top/Topr/Midl/Mid/Midr/Botl/Bot/Bo trSet 182B API indices: 3130/3133/3136/3139/3142/3145/3148/3151/3154 The black level is increased for the various blend regions (9 possible regions). Input Parameters Name Value Type UWORD32 Range Description 0 ... 25 Uplift Value Return Values Name Status 2.17.
PAGE 32
2.18 2.18.1 CCS byOsdCCSSet API index: 2975 Switches CCS (Cross Colour Suppression) filter on/off for the CVBS input. Input Parameters 2.18.2 Name Value Type UWORD32 Range 0: Off 1: On Return Values Description CCS switch Name Status Type BYTE Range 0x00-0xFF Description 0 if successful, error otherwise code byOsdCCSGet API index: 2976 Retrieves the status of the CCS from either cache or the SPD. Input Parameters 2.18.
PAGE 33
2.19 Contrast 2.19.1 27B byOsdContrastSet 18B API index: 124 Sets the contrast (gain). Input Parameters Name Value Type UWORD32 Range Description 0x00000000: 1–1/√2 0x7FFFFFFF: 1 0xFFFFFFFF: 1+1/√2 Contrast (signal gain) Return Values Name Status 2.19.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdContrastGet 189B API index: 126 Retrieves the contrast (gain) from either cache or the SPD.
PAGE 34
2.20 2.20.1 Clock byOsdAbsoluteClockSet API index: 2938 Sets the absolute clock value for sampling the VGA input image. Input Parameters Name Value Type UWORD32 Range Depending on VGA signal Description Absolute clock value Return Values Name Status 2.20.2 Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise byOsdAbsoluteClockGet API index: 2939 Retrieves the absolute clock value either cache or the SPD.
PAGE 35
2.20.4 byOsdAbsoluteClockSave 194B API index: 2940 Saves the absolute clock value from cache into the SPD. Input Parameters None Return Values Name Status 2.21 Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise Color Temperature 2.21.1 29B byOsdColorTempSet 195B API index: 349 Sets the color temperature to match the source color temperature.
PAGE 36
2.21.3 byOsdColorTempSave API index: 350 Saves the color temperature value from the cache into the SPD. Input Parameters None Return Values Name Status Type BYTE Range 0x00-0xFF 2.22 Component Mode 2.22.1 byOsdComponentModeSet Description 0 if successful, error code otherwise API index: 2959 Sets the component input mode. Input Parameters 2.22.
PAGE 37
2.23 Component Type 2.23.1 31B byOsdComponentTypeSet 201B API index: 2962 Sets the component input type, i.e. colorspace. Input Parameters 2.23.2 Name Value Type UWORD32 Range 0: RGB 1: YUV Return Values Description Component type (colorspace) Name Status Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise byOsdComponentTypeGet 20B API index: 2963 Retrieves setting for the component type from either cache or the SPD. 2.23.
PAGE 38
2.24 CTI Level 2.24.1 byOsdSTICTISet API index: 611 Sets the level of the CTI (chroma transient improvement) filter. Input Parameters Name Value Type UWORD32 Name Status 2.24.2 Type BYTE Range Description 0: Off CTI value 1: Low 2: High Return Values Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdSTICTIGet API index: 613 Retrieves the level of the CTI filter from either cache or the SPD.
PAGE 39
2.25 Detail Enhancement 2.25.1 3B byOsdDetailSet 207B API index: 133 Sets the level of the detail enhancement algorithm. Input Parameters Name Value Type UWORD32 Range Description 0x00000000: off 0xFFFFFFFF: max Detail enhancement value Return Values Name Status 2.25.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdDetailGet 208B API index: 135 Retrieves the level of the detail enhancement algorithm from either cache or the SPD.
PAGE 40
2.26 Display Mode 2.26.1 byOsdProcessingModeSet API index: 2965 Sets the processing mode. Input Parameters Name Value Type UWORD32 Range Description 0: CRT (low latency) 1: LCD (best picture) Processing mode Return Values Name Status 2.26.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdProcessingModeGet API index: 2966 Retrieves the processing mode setting from either cache or the SPD. Input Parameters Name Option Type BYTE Name 2.26.
PAGE 41
2.27 DVI Equalization 2.27.1 35B byOsdDVI1EQSet 213B API index: 2832 Sets the DVI port equalization Input Parameters 2.27.2 Name Value Type UWORD32 Range 0: Off 1: On Return Values Description Boost Equalization Name Status Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise byOsdDVI1EQGet 214B API index: 2833 Retrieves setting for DVI port equalization from either cache or the SPD.
PAGE 42
2.28 DVI Input Port configuration analog/digital 2.28.1 byOsdDVIIPortSet API index: 3300 Switches between processing of digital (TMDS) and analogue (VGA) input type (DVI-D or DVI-A). Input Parameters Name Value Type UWORD32 Range Description 0: digital (DVI-D) 1: analogue (DVI-A) Switches between digital and analogue input processing. Return Values Name Status 2.28.
PAGE 43
2.29 DVI Output Color Space 2.29.1 37B byOsdDviOutCscSet 219B API index: 3250 Sets DVI Output Color Space. Input Parameters Name Value Type UWORD32 Range Description 0: RGB 1: YPbPr Sets DVI Output Color Space. Return Values Name Status 2.29.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdDviOutCscGet 20B API index: 3251 Retrieves the DVI Output Color Space setting from cache or from the SPD.
PAGE 44
2.30 DVI Output Range 2.30.1 byOsdDviOutRangeSet API index: 3253 Sets DVI Output Range. Input Parameters Name Value Type UWORD32 Name Status 2.30.2 Range Type BYTE Description 0: Default Sets DVI Output Range. 1: Limited 2: Full Return Values Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdDviOutRangeGet API index: 3254 Retrieves the DVI Output Range setting from cache or from the SPD.
PAGE 45
2.31 Edge Blend Bottom Border 2.31.1 39B byOsdEdgeBlendBotBorderSet 25B API index: 3121 Sets the edge blend bottom border. Input Parameters Name Value Type UWORD32 Range Description 0x00-{output res./4} Sets the bottom border edge blend size. The actual range depends on Output resolution. It is limited to ¼ of the output resolution. Return Values Name Status 2.31.
PAGE 46
2.32 Edge Blend Bottom Border Offset 2.32.1 byOsdEdgeBlendBotOffsetSet API index: 3178 Sets the edge blend bottom border offset. Input Parameters Name Value Type UWORD32 Range Description 0x00{output res./4 overlap} Sets the bottom border edge blend offset. The actual range depends on Output resolution. It is limited to ¼ of the output resolution minus the overlap/actual blend region. Return Values Name Status 2.32.
PAGE 47
2.33 Edge Blend Left Border 2.33.1 41B byOsdEdgeBlendLeftBorderSet 231B API index: 3124 Sets the edge blend left border. Input Parameters Name Value Type UWORD32 Range Description 0x00-{output res./4} Sets the left border edge blend size. The actual range depends on Output resolution. It is limited to ¼ of the output resolution. For a 2x1 configuration the range is wider. Return Values Name Status 2.33.
PAGE 48
2.34 Edge Blend Left Border Offset 2.34.1 byOsdEdgeBlendLeftOffsetSet API index: 3181 Sets the edge blend left border offset. Input Parameters Name Value Type UWORD32 Range Description 0x00{output res./4 overlap} Sets the left border edge blend offset. The actual range depends on Output resolution. It is limited to ¼ of the output resolution minus the overlap/actual blend region. For a 2x1 configuration the range is wider. Return Values Name Status 2.34.
PAGE 49
2.35 Edge Blend Right Border 2.35.1 43B byOsdEdgeBlendRightBorderSet 237B API index: 3127 Sets the edge blend right border. Input Parameters Name Value Type UWORD32 Range Description 0x00-{output res./4} Sets the right border edge blend size. The actual range depends on Output resolution. It is limited to ¼ of the output resolution. For a 2x1 configuration the range is wider. Return Values Name Status 2.35.
PAGE 50
2.36 Edge Blend Right Border Offset 2.36.1 byOsdEdgeBlendRightOffsetSet API index: 3184 Sets the edge blend right border offset. Input Parameters Name Value Type UWORD32 Range Description 0x00{output res./4 overlap} Sets the right border edge blend offset. The actual range depends on Output resolution. It is limited to ¼ of the output resolution minus the overlap/actual blend region. For a 2x1 configuration the range is wider. Return Values Name Status 2.36.
PAGE 51
2.37 Edge Blend Top Border 2.37.1 45B byOsdEdgeBlendTopBorderSet 243B API index: 3118 Sets the edge blend top border. Input Parameters Name Value Type UWORD32 Range Description 0x00-{output res./4} Sets the top border edge blend size. The actual range depends on Output resolution. It is limited to ¼ of the output resolution. Return Values Name Status 2.37.
PAGE 52
2.38 Edge Blend Top Border Offset 2.38.1 byOsdEdgeBlendTopOffsetSet API index: 3175 Sets the edge blend top border offset. Input Parameters Name Value Type UWORD32 Range Description 0x00{output res./4 overlap} Sets the top border edge blend offset. The actual range depends on Output resolution. It is limited to ¼ of the output resolution minus the overlap/actual blend region. Return Values Name Status 2.38.
PAGE 53
2.39 Edge control 2.39.1 47B byOsdLeft/Right/Top/BottomEdgeSet 249B API indices: 2925/2928/2931/2934 Moves left/right/top/bottom edge of captured image inwards or outwards. Input Parameters Name Value Type SWORD32 Range Description -100: 100px out 100: 100px in Input capture edge position relative to output format edge Return Values Name Status 2.39.
PAGE 54
2.40 Frame Rate Settings Availability Control 2.40.1 byOsdAllowedFrameRateSet API index: 3276 Makes 24/48Hz frame rate settings available. Input Parameters Name Value Type UWORD32 Range Description Ouput Mode Frame Rate availability setting. 0: 50/60Hz 1: 24/50/60Hz 2: 48/50/60Hz 3: 24/48/50/60Hz Return Values Name Status 2.40.
PAGE 55
2.41 HDMI/DVI Input Color Space 2.41.1 49B byOsdDviInCSpaceSet 25B API index: 3256 Sets HDMI/DVI Input Color Space. Input Parameters Name Value Type Name Status 2.41.2 Range UWORD32 Description 0: RGB Sets DVI Input Color Space manually or automatically from AV InfoFrames.
PAGE 56
2.42 HDMI/DVI Input Range 2.42.1 byOsdDviInRangeSet API index: 3259 Sets HDMI/DVI Input Range. Input Parameters Name Value Type UWORD32 Range Description 0: Full 1: Limited 2: Auto Sets HDMI/DVI Input Range manually or automatically from AV InfoFrames. Return Values Name Status 2.42.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdDviInRangeGet API index: 3260 Retrieves the HDMI/DVI Input Range setting from cache or from the SPD.
PAGE 57
2.43 Horizontal Keystone 2.43.1 51B byOsdHKeystoneSet 261B API index: 332 Selects the embedded warp API. Input Parameters Name Value Type SWORD32 Range Description -40 ..+40 Sets the horizontal keystone value. Return Values Name Status 2.43.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdHKeystoneGet 26B API index: 334 Retrieves the number of the slot being selected.
PAGE 58
2.44 Horizontal Position 2.44.1 byOsdMainHorizontalSet API index: 362 Sets the horizontal position of the input image. Input Parameters Name Value Type UWORD32 Range Description 0 .. Htotal-HSyncHbackporch Horizontal input position Return Values Name Status 2.44.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdMainHorizontalGet API index: 364 Retrieves horizontal position from either cache or the SPD.
PAGE 59
2.45 Hue 2.45.1 53B byOsdHueSet 267B API index: 151 Sets the hue value. Input Parameters Name Value Type UWORD32 Range Description 0x00000000: -180° 0x7FFFFFFF: 0° 0xFFFFFFFF: +180° Hue value Return Values Name Status 2.45.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdHueGet 268B API index: 153 Retrieves the hue value from either cache or the SPD.
PAGE 60
2.46 Input 2.46.1 byOsdInputFormatSet API index: 318 Sets the main input channel given by the controlling application. Input Parameters Name Value Type UWORD32 Range 0: Composite 1 1: Composite 2 2: S-Video 3: Component 4: VGA 5: 3G-SDI 6: DVI 7: HDMI 8: DVI-A 9: Test Pattern Description Main input channel Return Values Name Status 2.46.
PAGE 61
2.46.3 byOsdInputFormatSave 27B API index: 319 Saves the main input channel from cache into the SPD. Input Parameters None Return Values Name Status 2.47 Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise Input Gamma 2.47.1 5B byOsdGammaInSet 273B API index: 343 Sets the gamma value of the input signal to compensate for. Input Parameters Name Value Type UWORD32 Range 0: Gamma=1.0 1: Gamma=1.5 2: Gamma=2.2 3: Gamma=2.
PAGE 62
2.47.3 byOsdGammaInSave API index: 344 Saves the input gamma value from cache into the SPD. Input Parameters None Return Values Name Status Type BYTE 2.48 Input Name 2.48.1 byOsdInputRenameSet Range 0x00-0xFF Description 0 if successful, error code otherwise API index: 2950 Renames one of the inputs. Input Parameters 2.48.2 Name InpNumber Name Type UWORD32 CHAR[] Range 0 .. 8 [A..Z ; 0..
PAGE 63
2.49 I/O Lock 2.49.1 57B byOSDIoLockSet 279B API index: 2978 Sets the Lock Type between PLL modulation and free run mode. Input Parameters Name Value Type UWORD32 Range Description 0: Off I/O Lock Type. 1: Source (locked to video input), 2:Genlock (locked to external source) Return Values Name Status 2.49.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdIoLockGet 280B API index: 2979 Retrieves the I/O Lock Type either cache or the SPD.
PAGE 64
2.50 IP Address 2.50.1 bySetStaticIPAddr API index: 111 Sets the static IP address and saves the setting in the SPD immediately. Input Parameters Name Value Type STRING Range nnn.nnn.nnn.nnn String with 15 ASCII characters /0 terminated Description Static IP address Return Values Name Status 2.50.2 Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise byGetStaticIPAddr API index: 112 Retrieves the IP address from the SPD.
PAGE 65
2.51.2 byGetDHCPStatus 285B API index: 84 Retrieves the IP address type from the SPD. Input Parameters Name Type Range Description None Return Values Name 2.52 Type Range Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value UWORD32 0: Static 1: DHCP IP address type Keypad Lock/Unlock 2.52.1 60B byOsdKeypadLockSet 286B API index: 2824 Activates/Deactivates the keypad locking.
PAGE 66
2.53 LED Screen Window Size 2.53.1 byOsdOutWinLeft/Right/Top/BottomEdgeSet API indices: 3308/3311/3314/3317 Changes the borders. Input Parameters Name Value Type UWORD32 Range Description 0 ... 1792 Change the border positions. Actual Range depends on o/p resolution. Upper left corner is 0, range is to lower right corner -128. Return Values Name Status 2.53.
PAGE 67
2.54 LED Screen Window Size Enabling 2.54.1 62B byOsdOutWinSizeEnableSetSave 29B API index: 3306 Enable Window Size Controls and save on/off setting to the SPD. Input Parameters Name Value Type UWORD32 Range 0: off 1: on Description Enables or disables the Window Size Controls. Return Values Name Status 2.54.2 Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise byOsdOutWinSizeEnableGet 293B API index: 3307 Retrieves the Window Size Controls enable/disable setting.
PAGE 68
2.56 LTI Level 2.56.1 byOsdSTILTISet API index: 608 Sets the level of the LTI (Luma Transient Improvement) filter. Input Parameters Name Value Type UWORD32 Name Status 2.56.2 Type BYTE Range Description 0: Off LTI value 1: Low 2: High Return Values Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdSTILTIGet API index: 610 Retrieves the level of the LTI filter from either cache or the SPD.
PAGE 69
2.57 Menu Display Time 2.57.1 65B byOsdMenuTimeSet 298B API index: 2968 Sets menu display timeout. Input Parameters Name Value Type UWORD32 Name Status 2.57.2 Type BYTE Range Description Menu display time 0: 5s 1: 10s .. 5: 30s 6: infinite Return Values Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdMenuTimeGet 29B API index: 2969 Retrieves the menu display timeout setting from either cache or the SPD. Input Parameters Name Option Type BYTE Name 2.57.
PAGE 70
2.58 Menu Position 2.58.1 byOsdMenuPositionSet API index: 2971 Sets menu position on screen. Input Parameters Name Value Type Name Status 2.58.2 Range Description Menu position 0: Center 1: Top Left 2: Top Right 3: Bottom Left 4: Bottom Right Return Values UWORD32 Type Range BYTE Description 0x00-0xFF 0 if successful, error code otherwise byOsdMenuPositionGet API index: 2972 Retrieves the menu position setting from either cache or the SPD. Input Parameters Name Option Type BYTE Name 2.
PAGE 71
2.59 MNR 2.59.1 67B byOsdCNRSet 304B API index: 251 Sets the level of the MNR (MPEG Codec noise reduction) algorithm. Input Parameters 2.59.2 Name Value Type UWORD32 Range 0: Off 1: Low 2: Medium 3: High Return Values Description MNR value Name Status Type BYTE Range 0x00-0xFF Description 0 if successful, error otherwise code byOsdCNRGet 305B API index: 253 Retrieves the level of the MNR from either cache or the SPD. Input Parameters 2.59.
PAGE 72
2.60 Moving Test Pattern Background Color 2.60.1 byOsdTpgBgColSet API index: 3293 Sets the background color of the moving test pattern. Input Parameters Name Value Type UWORD32 Name Status 2.60.2 Type BYTE Range Description Foreground color of the moving test 0: Black pattern.
PAGE 73
i 2.61 If attempting to set foreground and background color to the same tone an error message is reported E_OUT_OF_RANGE (0x5). The same error code is generated for values greater than 7. Moving Test Pattern Foreground Color 2.61.1 69B byOsdTpgFgColSet 310B API index: 3290 Sets the foreground color of the moving test pattern. Input Parameters Name Value Type UWORD32 Name Status 2.61.2 Type BYTE Range Description Foreground color of the moving test 0: Black pattern.
PAGE 74
2.61.3 byOsdTpgFgColSave API index: 3292 Saves the foreground color of the moving test pattern. Input Parameters None Return Values Name Status i Type BYTE Range 0x00-0xFF Description if successful, error code otherwise If attempting to set foreground and background color to the same tone an error message is reported E_OUT_OF_RANGE (0x5). The same error code is generated for values greater than 7. 2.62 Moving Test Pattern Line Thickness 2.62.
PAGE 75
2.62.3 byOsdTpgWidthSave 315B API index: 3298 Saves the line thickness of the moving test pattern from cache into the SPD. Input Parameters None Return Values Name Status 2.63 Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise Moving Test Pattern Speed 2.63.1 71B byOsdTpgSpeedSet 316B API index: 3286 Sets the motion speed of the diagonally moving test pattern. Input Parameters Name Value Type UWORD32 Range Description 1 ..
PAGE 76
2.64 Multiple Unit Height 2.64.1 byOsdMultipleUnitHeightSet API index: 3103 Sets the number of units in vertical direction. Input Parameters Name Value Type UWORD32 Name Status 2.64.2 Type BYTE Range Description 0x01-0x04 Number of units in vertical direction. Return Values Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdMultipleUnitHeightGet API index: 3104 Retrieves the number of units in horizontal direction.
PAGE 77
2.65 Multiple Unit Horizontal Set 2.65.1 73B byOsdMultipleUnitHorizontalSet 32B API index: 3106 Sets the horizontal address of the unit. Input Parameters Name Value Type UWORD32 Range Description 0x00-0x03 Horizontal address of the unit. The actual range is 0x00 to Horizontal Width – 1. Return Values Name Status 2.65.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdMultipleUnitHorizontalGet 32B API index: 3107 Retrieves the horizontal address of the unit.
PAGE 78
2.66 Multiple Unit Vertical Set 2.66.1 byOsdMultipleUnitVerticalSet API index: 3109 Sets the vertical address of the unit. Input Parameters Name Value Type UWORD32 Range Description 0x00-0x03 Vertical address of the unit. The actual range is 0x00 to Vertical Width – 1. Return Values Name Status 2.66.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdMultipleUnitVerticalGet API index: 3110 Retrieves the vertical address of the unit.
PAGE 79
2.67 Multiple Unit Width 2.67.1 75B byOsdMultipleUnitWidthSet 328B API index: 3100 Sets the number of units in horizontal direction. Input Parameters Name Value Type UWORD32 Range Description 0x01-0x04 Number of units in horizontal direction. Return Values Name Status 2.67.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdMultipleUnitWidthGet 329B API index: 3101 Retrieves the number of units in horizontal direction.
PAGE 80
2.68 Native Color Temp 2.68.1 byOsdNativeColorTempSet API index: 2827 Sets the Color Temperature of the output video signal. Input Parameters Name Value Type UWORD32 Name Status 2.68.2 Range Type BYTE Description Output Color Temperature. 0: 5500k 1: 6500k 2: 7500k 3: 9300k 4: 10000 Return Values Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdNativeColorTempGet API index: 2828 Retrieves the Color Temperature either cache or the SPD.
PAGE 81
2.69 Netmask 2.69.1 7B bySetSubnetMask 34B API index: 113 Sets the netmask and saves the setting in the SPD immediately. Input Parameters Name Value Type STRING Range nnn.nnn.nnn.nnn String with 15 ASCII characters /0 terminated Description Netmask Return Values Name Status 2.69.2 Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise byGetSubnetMask 35B API index: 114 Retrieves the IP address from the SPD.
PAGE 82
2.71 Optimize for Display 2.71.1 byOsdOptimiseSet API index: 2818 Activates communication with a display and sets optimum output display timing and color depth. Input Parameters Name Value Type UWORD32 Range Description 0: DVI/HDMI 1: Native 2: DVI-forced 1: Activates optimization mechanism 0,2: Deactivates optimization mechanism. DVI-forced outputs 8 bit per color only. DVI/HDMI selects color depth automatically. Return Values Name Status 2.71.
PAGE 83
2.71.4 byOsdEnableGet 340B API index: 3374 Retrieves the OSD enabling setting. Input Parameters Name Option Type BYTE Range Description 0: From cache 1: From SPD Retrieval method None Return Values Name 2.71.5 Type Range Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value UWORD32 0: off 1: on Determines if OSD is on or off. byOsdEnableSave 341B API index: 3375 Saves the OSD enabling setting from cache into the SPD.
PAGE 84
2.72.2 byOsdLanguageGet API index: 447 Retrieves the OSD language setting from either cache or the SPD. Input Parameters Name Option Type Name 2.72.3 Range BYTE Description 0: From cache 1: From SPD Retrieval method Return Values Range Type Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value UWORD32 0: English AE 1: English BE 2: German Menu position byOsdLanguageSave API index: 446 Saves the OSD language setting from cache into the SPD.
PAGE 85
Name 2.73.3 Type Range Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value UWORD32 0: Off 1: On OSD messaging setting byOsdOsdMessagesSave 347B API index: 3275 Saves the OSD messaging set-up from cache into the SPD. Input Parameters None Name Status 2.74 Type BYTE Return Values Range 0x00-0xFF Description 0 if successful, error code otherwise Output Blanking 2.74.1 82B byBlankOutputSet 348B API index: 2990 The output is blanked with a black image.
PAGE 86
2.75 Output Frame Rate 2.75.1 byOsdFrameRateSet API index: 2821 Sets the Ouput Mode Frame Rate. Input Parameters Name Value Type UWORD32 Name Status 2.75.2 Type BYTE Range Description Ouput Mode Frame Rate 0: 60Hz 1: 50Hz 2: 24Hz 3: 48Hz 4: Auto Return Values Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdFrameRateGet API index: 2822 Retrieves the Output Mode Frame Rate from either cache or the SPD. Input Parameters Name Option Type BYTE Name 2.75.
PAGE 87
2.76 Output Gamma 2.76.1 84B byOsdGammaOutSet 35B API index: 346 Sets the Ouput Gamma. Input Parameters Name Value Type UWORD32 Name Status 2.76.2 Type BYTE Range Description 0 .. 30 Ouput Gamma Value * 10 Return Values Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdGammaOutGet 354B API index: 348 Retrieves the Output Gamma Value from either cache or the SPD.
PAGE 88
2.77 Output Mode 2.77.1 byOsdOuputFormatSet API index: 324 Sets the Ouput Mode Resolution. Input Parameters Name Value Type UWORD32 Range 0: 640x480 1: 800x600 2: 1024x768 3: 1280x768 4: 1280x800 5: 1280x1024 6: 1400x1050 7: 1600x1200 8: 1920x1200 9: 480i 10: 576i 11: 480p 12: 576p 13: 720p 14: 1080i 15: 1080p Description Output Resolution Return Values Name Status 2.77.
PAGE 89
2.77.3 byOsdOutputFormatSave 358B API index: 325 Saves the Output Mode Resolution setting from cache into the SPD. Input Parameters None Return Values Name Type Status 2.78 BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise Overscan 2.78.1 86B byOsdOverscanSet 359B API index: 2944 Sets the input overscan percentage. Input Parameters Name Value Type UWORD32 Range 0: 0% 1: 2.5% 2: 5% 3: 7.5% Description Overscan value Return Values Name Status 2.78.
PAGE 90
2.78.3 byOsdOverscanSave API index: 2946 Saves the overscan setting from cache into the SPD. Input Parameters None Return Values Name Status Type BYTE Range 0x00-0xFF 2.79 Phase 2.79.1 byOsdAbsolutePhaseSet Description 0 if successful, error code otherwise API index: 2941 Sets the absolute phase value for sampling the VGA input image. Input Parameters Name Value Type SWORD32 Range Description -15 .. +15 Absolute phase value Return Values Name Status 2.79.
PAGE 91
2.80 Picture Format 8B 2.80.1 byOsdAspectRatioSet 365B API index: 186 Sets the picture format / aspect ratio treatment. Input Parameters Name Value Type Range UWORD32 Description Picture format index 0: Standard 1: Full Screen 2: Crop 3: Anamorphic Return Values Name Status 2.80.2 Type Range BYTE Description 0x00-0xFF 0 if successful, error code otherwise byOsdAspectRatioGet 36B API index: 188 Retrieves setting for picture format / aspect ratio treatment from either cache or the SPD.
PAGE 92
2.81 Pin/Barrel 2.81.1 byOsdPinBarrelSet API index: 476 Sets the Pin/Barrel distortion value. Input Parameters Name Value Type SWORD32 Range Description -20 ..+20 Sets the Pin/Barrel distortion value. Return Values Name Status 2.81.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdPinBarrelGet API index: 840 Retrieves the Pin/Barrel distortion value.
PAGE 93
2.82 PIP H-Pos 2.82.1 90B byOsdPipXSet 371B API index: 3211 Sets the PiP Horizontal Position. Input Parameters Name Value Type UWORD32 Range Description 0 ... 100 PiP Horizontal position in % of the main image, i.e. 0% PiP left edge aligns with main left edge and 100% PiP right edge aligns with main right edge. Return Values Name Status 2.82.
PAGE 94
2.83 PIP Input 2.83.1 byOsdPipInputFormatSet API index: 321 Sets the PiP input channel. Input Parameters Name Value Type UWORD32 Range Description PIP input channel 0: Composite 1 1: Composite 2 2: S-Video 3: Component 4: VGA 5: HDSDI 6: DVI 7: HDMI Return Values Name Status 2.83.1 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdPipInputFormatGet API index: 323 Retrieves the PiP input channel setting from either cache or the SPD.
PAGE 95
2.84 PIP Mode 2.84.1 92B byOsdPipOnOffSet 37B API index: 315 Sets the PiP mode. Input Parameters Name Value Type UWORD32 Range Description PIP mode 0: Off 1: PIP 2: PAP 3: POP Return Values Name Status 2.84.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdPipOnOffGet 378B API index: 317 Retrieves the PiP mode setting from either cache or the SPD.
PAGE 96
2.85 PiP/Multiple Unit Operation Mode 2.85.1 byOsdPIPEBOperationModeSet API index: 3172 Switches between PiP mode and Multiple Unit Mode. Multiple Unit mode does not support PiP, whereas PiP mode does not support Edge Blend and PC tool generated warp maps. Input Parameters Name Value Type UWORD32 Name Status 2.85.2 Range Type BYTE Description 0: PiP Mode Sets the operation mode.
PAGE 97
2.86 PIP Position 2.86.1 94B byOsdPipPosSet 38B API index: 368 Sets the PiP Position. Input Parameters Name Value Type UWORD32 Name Status 2.86.2 Type BYTE Range Description PIP position 0: Top Left 1: Top Right 2: Bottom Left 3: Bottom Right 4: Free H/V Return Values Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdPipPosGet 384B API index: 370 Retrieves the PiP Position from either cache or the SPD. Input Parameters Name Option Type BYTE Name 2.86.
PAGE 98
2.87 PIP Size 2.87.1 byOsdAbsolutePipSizeSetSave API index: 2974 Sets the PiP mode and saves the setting in the SPD immediately. Input Parameters Name Value Type UWORD32 Name Status 2.87.2 Range Type BYTE Description 0: Small PIP size 1: Medium 2: Large Return Values Range 0x00-0xFF Description 0 if successful, error code otherwise byOsdPipSizeGet API index: 361 Retrieves the PiP size setting from either cache or the SPD.
PAGE 99
2.88.2 byOsdPipYGet 389B API index: 3215 Retrieves the PiP Vertical Position from either cache or the SPD. Input Parameters Name Option Type BYTE Name 2.88.3 Range Description 0: From cache 1: From SPD Retrieval method Return Values Range Type Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value UWORD32 0 ... 100 PIP Vertical position in % of the main image, i.e. 0% PiP top edge aligns with main top edge and 100% PiP bottom edge aligns with bottom edge.
PAGE 100
2.89.2 byOsdPtzAspectGet API index: 3238 Retrieves the Aspect Lock setting from cache or from the SPD. Input Parameters Name Option Type BYTE Range Description 0: From cache 1: From SPD Retrieval method None Return Values Name 2.89.3 Type Range Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value UWORD32 0: On 1: Off Aspect Lock setting on or off. byOsdPtzAspectSave API index: 3239 Saves the Aspect Lock setting from cache into the SPD.
PAGE 101
2.90.2 byOsdPtzEnableGet 395B API index: 3221 Retrieves the PTZ enable setting from cache or from the SPD. Input Parameters Name Option Type BYTE Range 0: From cache 1: From SPD Description Retrieval method None Return Values Name 2.91 Type Range Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value UWORD32 0: Off 1: On PTZ enabling PTZ Horizontal Zoom 2.91.1 9B byOsdPtzZoomHSet 396B API index: 3231 Zooms/Shrinks the image in horizontal direction.
PAGE 102
2.91.3 byOsdPtzZoomHSave API index: 3233 Saves the horizontal zoom factor from cache into the SPD. Input Parameters None Return Values Name Status Type BYTE 2.92 PTZ Pan 2.92.1 byOsdPtzPanSet Range 0x00-0xFF Description 0 if successful, error code otherwise API index: 3225 Sets the Pan position. Input Parameters Name Value Type SWORD16 Name Status 2.92.2 Type BYTE Range Description -50 ... +50 Pan position.
PAGE 103
2.93 PTZ Settings Scope 2.93.1 10B byOsdPtzSettingSet 402B API index: 3222 Sets the scope of the PTZ settings from global to Per-mode. Input Parameters Name Value Type UWORD32 Range Description 0: Use Globally 1: Use Per-Mode Scope of PTZ settings. Return Values Name Status 2.93.2 Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdPtzSettingGet 403B API index: 3223 Retrieves the PTZ scope setting from cache or from the SPD.
PAGE 104
2.94 PTZ Tilt 2.94.1 byOsdPtzTiltSet API index: 3228 Sets the Tilt position. Input Parameters Name Value Type SWORD16 Name Status 2.94.2 Type BYTE Range Description -50 ... +50 Tilt position. Return Values Range Description 0x00-0xFF 0 if successful, error code otherwise byOsdPtzTiltGet API index: 3229 Retrieves the Tilt position from cache or from the SPD. Input Parameters Name Option Type BYTE Range Description 0: From cache 1: From SPD Retrieval method None Return Values Name 2.94.
PAGE 105
2.95 PTZ Vertical Zoom 2.95.1 103B byOsdPtzZoomVSet 408B API index: 3234 Zooms/Shrinks the image in vertical direction. When Aspect Lock is On Vertical Zoom is not available. The Horizontal Zoom factor determines the overall zoom/shrink. Input Parameters Name Value Type UWORD32 Name Status 2.95.2 Type BYTE Range Description 50 ... 400 Vertical Zoom Factor in %.
PAGE 106
2.96 Reset Blend Width, Offset and Black Level Uplift 2.96.1 byOSDEdgeBlendReset API index: 3249 The blend width, offset and black level uplift or combinations thereof can be reset to zero. Input Parameters Name Value Type UWORD32 Name Status Range Type BYTE 2.97 Reset Profile 2.97.1 byOsdProfileReset Description 1: Reset Blend Width Resets blend width, offset and black 2: Reset Blend Offset level uplift or combinations thereof, 3: Reset Black Level e.g. 7: Reset all three.
PAGE 107
2.98.2 byOsdR/G/BOffsetGet 41B API indices: 2810/2813/2816 Retrieves the R/G/B offset from either cache or the SPD. Input Parameters Name Type Range Description Option BYTE 0: From cache 1: From SPD Retrieval method Name Type Range Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value UWORD32 0x00000000: -25 IRE 0x7FFFFFFF: 0 IRE 0xFFFFFFFF: +25 IRE R/G/B Offset Return Values 2.98.
PAGE 108
2.99.2 byOsdR/G/BGainGet API indices: 2801/2804/2807 Retrieves the gain value from either the cache or the SPD. Input Parameters Name Option Type Range BYTE Description 0: From cache 1: From SPD Retrieval method Return Values Name 2.99.
PAGE 109
2.100.2 byOsdRotationGet 420B API index: 844 Retrieves the Pin/Barrel distortion value. Input Parameters Name Option Type BYTE Range Description 0: From cache 1: From SPD Retrieval method Return Values Name Type Range Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value SWORD32 -20 ..+20 Retrieves the Rotation Angle value. 2.100.1 byOsdRotationSave 421B API index: 846 Saves the value from cache into the SPD.
PAGE 110
2.101.2 byOsdColorGet API index: 129 Retrieves the color saturation from either cache or the SPD. Input Parameters Name Option Type BYTE Range Description 0: From cache 1: From SPD Retrieval method Return Values Name 2.101.3 Type Range Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value UWORD32 0x00000000: min 0x7FFFFFFF: normal 0xFFFFFFFF: max Color saturation byOsdColorSave API index: 128 Saves the color saturation from cache into the SPD.
PAGE 111
2.103 S-Curve Value 1B 2.103.1 byOsdEdgeBlendScurveValueSet 426B API index: 3115 Sets the S-curve value. Input Parameters Name Value Type Range UWORD32 Description 0x10-0x19 S-Curve power value. The power ranges from 1.0 to 2.5. The value set is the in multiples of 1/10. Return Values Name Status Type Range BYTE Description 0x00-0xFF 0 if successful, error code otherwise 2.103.2 byOsdEdgeBlendScurveValueGet 427B API index: 3116 Retrieves the S-curve value.
PAGE 112
2.104 SDI Audio Channel Mapping 2.104.1 byOsdSdiAudioChannelSet API index: 3280 Sets the SDI audio channel mapping from SDI input to HDMI and SDI output. Input Parameters Name Value Type UWORD32 Range Description Sets the SDI audio input to HDMI/SDI audio output channel mapping. Channel 1,2 means SDI i/p channel 1,2 are on HDMI and SDI o/p channel 1,2 (no other SDI channels present). Channel 3,4 means SDI i/p channel 3,4 is on HDMI and SDI o/p channel 1,2 ... and so forth.
PAGE 113
2.105 SDI Audio SPDIF Routing 13B 2.105.1 byOsdSdiOnSpdifSet 432B API index: 3283 Sets whether SDI audio is output with the SDI/HDMI output data stream or routed to the SPDIF connector. They are mutually exclusive. Input Parameters Name Value Type UWORD32 Range Description 0: HDMI/SDI 1: SPDIF Set audio routing to SPDIF connector or embed to the HDMI/SDI output stream. Return Values Name Status Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise 2.105.
PAGE 114
2.106 SDI Output Data Map 2.106.1 byOsdSdiDataMapSet API index: 3265 Sets the SDI output mode. Input Parameters Name Value Type Name Status Range Description Sets the SDI output mode. 0: Level A 1: Level B 2: 4:2:2 YCbCr 3: 4:4:4 YCbCr 4: 4:4:4 RGB Return Values UWORD32 Type Range BYTE Description 0x00-0xFF 0 if successful, error code otherwise 2.106.2 byOsdSdiDataMapGet API index: 3266 Retrieves the SDI output mode setting from cache or from the SPD.
PAGE 115
2.107 Select Warp Application 15B 2.107.1 byOsdProjectionAppsSet 438B API index: 1645 Selects the embedded warp API. Input Parameters Name Value Type Range UWORD32 0: Keystone 1: 4-Corner 2: Rotation Description Selects embedded warp API. Only certain combinations of non-linear scaling are applicable. Keystone can be combined with Pin/Barrel, Rotation with Pin/Barrel and Anyplace is stand alone. The PC generated free form warp API is started by selecting a UserMap.
PAGE 116
2.108 Select Warp Map Slot 2.108.1 byOsdUserMapSet API index: 139 Selects the embedded warp API. Input Parameters Name Value Type UWORD32 Range Description Switches on (1 to 8) the PC generated free from warp map processing and selects a warp map being downloaded into the given slot. With parameter 0 = off no warp map is applied. Slot 9 and Slot 10 are reserved for Portrait 90 and Portrait 270 warp maps. 0: Off 1: Slot1 2: Slot2 ...
PAGE 117
2.109 Sharpness 17B 2.109.1 byOsdSharpnessSet 4B API index: 130 Sets the characteristic of the sharpness filter. Input Parameters Name Value Type UWORD32 Name Status Type BYTE Range Description 0x00000000: soften 0x7FFFFFFF: off 0xFFFFFFFF: sharpen Return Values Range Sharpness filter characteristic Description 0x00-0xFF 0 if successful, error code otherwise 2.109.2 byOsdSharpnessGet 45B API index: 132 Retrieves the characteristic of the sharpness filter from either cache or the SPD.
PAGE 118
2.110 Sync Mode VGA Output 2.110.1 byOsdOutputSyncModeSet API index: 3246 Switches between separate, composite and sync on green schemes on the VGA output. Input Parameters Name Value Type UWORD32 Range Description 0: Separate Sync 1: Composite Sync 2: Sync-on_Green Switches the synchronisation scheme on the VGA output. Return Values Name Status Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise 2.110.
PAGE 119
2.111 Test Pattern Selection 19B 2.111.1 byOsdTestPatternSet 450B API index: 3320 Selects the test pattern to be displayed. Input Parameters Name Value Type UWORD32 Name Status Type BYTE Range Description Set the test pattern to be displayed.
PAGE 120
2.112 TRNR 2.112.1 byOsdTRNRSet API index: 239 Sets the level of the TRNR (temporal recursive noise reduction) algorithm. Input Parameters Name Value Type UWORD32 Range Description TRNR value 0: Off 1: Low 2: Medium 3: High Return Values Name Status Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise 2.112.2 byOsdTRNRGet API index: 241 Retrieves the level of the TRNR from either cache or the SPD.
PAGE 121
2.113 User 12B 2.113.1 byOsdCurrentUserSet 456B API index: 2947 Selectes the current user profile. Input Parameters Name Value Type UWORD32 Range 0 .. 3 Return Values Description Profile number Name Status Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise 2.113.2 byOsdCurrentUserGet 457B API index: 2948 Retrieves the currently selected profile number from either cache or the SPD.
PAGE 122
2.114 User Name 2.114.1 byOsdUserRenameSet API index: 2953 Renames one of the user profiles. Input Parameters Name UsrNumber Name Type UWORD32 CHAR[] Range 0 .. 3 [A..Z ; 0..9] Return Values Description User number User name (null terminated) Name Status Type BYTE Range 0x00-0xFF Description 0 if successful, error code otherwise 2.114.2 byOsdUserRenameGet API index: 2954 Retrieves a user name from either cache or the SPD. Input Parameters Name Option Type BYTE Range 0: From cache 1: From SPD 0 ..
PAGE 123
2.115 Vertical Keystone 123B 2.115.1 byOsdVKeystoneSet 462B API index: 336 Selects the embedded warp API. Input Parameters Name Value Type SWORD32 Range Description -30 ..+30 Sets the vertical keystone value. Return Values Name Status Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise 2.115.2 byOsdVKeystoneGet 463B API index: 338 Retrieves the number of the slot being selected.
PAGE 124
2.116 Vertical Position 2.116.1 byOsdMainVerticalSet API index: 365 Sets the vertical position of the input image. Input Parameters Name Value Type Range UWORD32 Description 0 .. Vtotal-VSyncVbackporch Vertical input position Return Values Name Status Type Range BYTE Description 0x00-0xFF 0 if successful, error code otherwise 2.116.2 byOsdMainVerticalGet API index: 367 Retrieves vertical position from either cache or the SPD.
PAGE 125
2.117 VT Filter Recursion Setting 125B 2.117.1 byOsdVTRecursionSet 468B API index: 3243 Switches the recursion filter on and off. Input Parameters Name Value Type Range UWORD32 Description 0: Off 1: On Switches the recursion on/off. Return Values Name Status Type Range BYTE Description 0x00-0xFF 0 if successful, error code otherwise 2.117.2 byOsdVTRecursionGet 469B API index: 3244 Retrieves the recursion filter setting.
PAGE 126
2.118 VT Filter Strength 2.118.1 byOsdVTStrengthSet API index: 3240 Sets the strength of the vertical temporal filter. Input Parameters Name Value Type UWORD32 Range Description 0 .. 4 Strength of the VT filter. 0 means no filtering and 4 being the highest strength. Return Values Name Status Type BYTE Range Description 0x00-0xFF 0 if successful, error code otherwise 2.118.2 byOsdVTStrengthGet API index: 3241 Retrieves the strength setting of the vertical temporal filter.