Setup Guide

ManualsBrandsDell ManualsComputer Monitors30" 16:10 IPS Monitor

Dell SDK for Monitors

Application Programming Interface

Guide

for SDK version 1.3

Summary of content (61 pages)

PAGE 1
Dell SDK for Monitors Application Programming Interface Guide for SDK version 1.
PAGE 2
Information in this document is subject to change without notice. © 2016 Dell Inc. All rights reserved. Reproduction of these materials in any manner whatsoever without the written permission of Dell Inc. is strictly forbidden. Trademarks used in this text: Dell™, the DELL logo, and UltraShrap™ are trademarks of Dell Inc.
PAGE 3
Contents Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Monitor Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 GetAvailableMonitors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 ConnectMonitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 DisconnectMonitor . . . . . . . . . . . . . .
PAGE 4
Color Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 GetSaturation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 SetSaturation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 GetHue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 SetHue . . . . . . . . . . . . .
PAGE 5
PIP/PBP Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 GetPxPMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 SetPxPMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 GetPxPSubInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 SetPxPSubInput . . . . . . . . . . .
PAGE 6
Introduction This document describes the APIs for supported Dell UltraSharp monitors on Linux(x86), OSX and Windows platforms. These APIs are to be used for remote display management and control from a Host PC to supported Dell UltraSharp monitors via a USB connection. A USB 3.0 A to B cable should be used for the connection between the host and the display. The following monitors are supported: 1. UP3017 The API described in this document corresponds to SDK version 1.3.
PAGE 7
Monitor Management GetAvailableMonitors Returns the number of supported monitor(s) API MONITOR_CODE GetAvailableMonitors(BYTE *pbCount) Params byMonitors[] Array for return values Return MONITOR_CODE pbCount Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Number of supported monitors connected ConnectMonitor Connect to monitor and start session API MONITOR_CODE ConnectMonitor(BYTE iID) Params iID Index of monitor as returned
PAGE 8
DisconnectMonitor Disconnect to monitor and end session API MONITOR_CODE DisconnectMonitor(void) Params Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure SetAssetTag Set the asset tag of the monitor.
PAGE 9
GetAssetTag Returns the monitor asset tag. Asset Tag will be empty until set by SetAssetTag.
PAGE 10
GetMonitorSerialNumber Returns the monitor serial number API MONITOR_CODE GetMonitorSerialNumber(BYTE *pbySerialNumber) Params *pbySerialNumber Pointer to return monitor serial number Return MONITOR_CODE pbySerialNumber Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Monitor serial number string (max 12 chars) GetBacklightHours Returns the monitor backlight hours API MONITOR_CODE GetBacklightHours(SWORD16 *ps16Val) Params *ps1
PAGE 11
Power Management GetPowerState Returns the current power state of the monitor API MONITOR_CODE GetPowerState(UBYTE *pu8Val) Params *pu8Val Pointer to return power state Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Power State 0 Off 1 On 2 Standby Power Management | 11
PAGE 12
SetPowerState Set the monitor on or standby API MONITOR_CODE SetPowerState(UBYTE u8Val) Params u8Val Power state to set 0 Off 1 On 2 Standby Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure GetPowerLED Returns the power LED setting of the monitor API MONITOR_CODE GetPowerLED(UBYTE *pu8Val) Params *pu8Val Pointer to return power LED setting Return MONITOR_CODE pu8Val 12 | Code describing the resul
PAGE 13
SetPowerLED Set the power LED setting API MONITOR_CODE SetPowerLED(UBYTE u8Val) Params u8Val Power LED Setting 0 Off during Active 1 On during Active Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure GetPowerUSB Returns the power USB setting of the monitor API MONITOR_CODE GetPowerUSB(UBYTE *pu8Val) Params *pu8Val Pointer to return power USB setting Return MONITOR_CODE pu8Val Code describing the result o
PAGE 14
SetPowerUSB Set the power USB setting API MONITOR_CODE SetPowerUSB(UBYTE u8Val) Params u8Val Power USB Setting 0 Off during Standby 1 Off during Standby Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Reset Power Reset power to the monitor API MONITOR_CODE ResetPower(void) Params Return MONITOR_CODE 14 | Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not co
PAGE 15
Image Management GetBrightness Returns the brightness level of the monitor API MONITOR_CODE GetBrightness(UBYTE *pu8Val) Params *pu8Val Pointer to return brightness value Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Brightness value Integer value 0 (dark) to 100 (bright) Default 75 Values in increments of 1 Image Management | 15
PAGE 16
SetBrightness Set the brightness level of the monitor API MONITOR_CODE SetBrightness(UBYTE u8Val) Params u8Val Brightness value Integer value 0 (dark) to 100 (bright) Default 75 Values in increments of 1 Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure GetContrast Returns the contrast level of the monitor API MONITOR_CODE GetContrast(UBYTE *pu8Val) Params *pu8Val Pointer to return contrast value Return MONIT
PAGE 17
SetContrast Set the contrast level of the monitor. NOTE: Uniformity Compensation must be turned off for this to work. API MONITOR_CODE SetContrast(UBYTE u8Val) Params u8Val Contrast value Integer value 0 (minimal) to 100 (maximum) Default 75 Values in increments of 1 Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure GetDynamicContrast Returns the dynamic contrast setting. Applicable for Movies and Gaming.
PAGE 18
pu8Val Dynamic Contrast 0 On 1 Off SetDynamicContrast Turns on/off the dynamic contrast setting. Applicable for Movies and Gaming. NOTE: Only works in Color Preset Game or Movie.
PAGE 19
pu8Val Aspect Ratio 0 Wide 16:10 1 Auto Resize 2 4:3 3 1:1 SetAspectRatio Sets the aspect ratio API MONITOR_CODE SetAspectRatio(UBYTE u8Val) Params u8Val Aspect Ratio 0 Wide 16:10 1 Auto Resize 2 4:3 3 1:1 Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Image Management | 19
PAGE 20
GetSharpness Returns the sharpness level API MONITOR_CODE GetSharpness(UBYTE *pu8Val) Params *pu8Val Pointer to return sharpness value Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Sharpness value Integer value 0 to 100 Default 50 Values in increments of 10 SetSharpness Sets the sharpness level API MONITOR_CODE SetSharpness(UBYTE u8Val) Params u8Val Sharpness value Integer value 0 to 100 Default 5
PAGE 21
GetResponseTime Returns the response time API MONITOR_CODE GetResponseTime(UBYTE *pu8Val) Params *pu8Val Pointer to return response time value Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Response Time 0 Normal 1 Fast SetResponseTime Sets the response time API MONITOR_CODE SetResponseTime(UBYTE u8Val) Params u8Val Response Time 0 Normal 1 Fast Return MONITOR_CODE Code describing the resul
PAGE 22
Color Management GetSaturation Returns the color saturation level NOTE: Only works in Color Preset Game or Movie.
PAGE 23
SetSaturation Sets the color saturation level NOTE: Only works in Color Preset Game or Movie. API MONITOR_CODE SetSaturation(UBYTE u8Val) Params u8Val Color Saturation level Integer value 0 to 100 Default 50 Values in increments of 1 Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure GetHue Returns the hue level NOTE: Only works in Color Preset Game or Movie.
PAGE 24
pu8Val Color Saturation level Integer value 0 to 100 Default 50 Values in increments of 1 SetHue Sets the hue level NOTE: Only works in Color Preset Game or Movie. API MONITOR_CODE SetHue(UBYTE u8Val) Params u8Val Hue level Integer value 0 to 100 Default 50 Values in increments of 1 Return MONITOR_CODE 24 | Code describing the result of the API call.
PAGE 25
GetColorTempCaps Returns the supported color temperatures of the monitor NOTE: Only works in Color Preset Color Temp. API MONITOR_CODE GetColorTempCaps(UWORD32 *pu32Val) Params *pu32Val Pointer to return color temperature capabilities.
PAGE 26
MONITOR_CODE pu32Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Color temperature 0x00000001 5000K 0x00000002 5700K 0x00000004 6500K 0x00000008 7500K 0x00000010 9300K 0x00000020 10000K SetColorTemp Sets the color temperature NOTE: Only works in Color Preset Color Temp.
PAGE 27
GetColorSpaceCaps Returns the supported color spaces of the monitor NOTE: Only works in Color Preset Color Space.
PAGE 28
MONITOR_CODE pu32Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Color space 0x00000001 Adobe RGB 0x00000002 sRGB 0x00000004 Rec 709 0x00000008 DCI-P3 0x00000010 CAL 1 0x00000020 CAL 2 SetColorSpaceState Sets the color space state NOTE: Only works in Color Preset Color Space.
PAGE 29
GetInputColorFormat Returns the input color format API MONITOR_CODE GetInputColorFormat(UBYTE *pu8Val) Params *pu8Val Pointer to return response time value Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Input Color Format 0 RGB 1 YPbPr SetInputColorFormat Sets the input color format API MONITOR_CODE SetInputColorFormat(UBYTE u8Val) Params u8Val Input Color Format 0 RGB 1 YPbPr Return MONITOR
PAGE 30
GetColorPresetCaps Returns the available color presets API MONITOR_CODE GetColorPresetCaps(UWORD32 *pu32Val) Params *pu32Val Pointer to return color space capabilities Return MONITOR_CODE pu32Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Bitwise representation of supported color presets 0x00000001 Standard 0x00000002 Multimedia 0x00000004 Movie 0x00000008 Game 0x00000010 Paper 0x00000020 Color Temp.
PAGE 31
GetColorPreset Returns the current color preset API MONITOR_CODE GetColorPreset(UWORD32 *pu32Val) Params *pu32Val Pointer to return color preset Return MONITOR_CODE pu32Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Color preset 0x00000001 Standard 0x00000002 Multimedia 0x00000004 Movie 0x00000008 Game 0x00000010 Paper 0x00000020 Color Temp.
PAGE 32
SetColorPreset Sets the color preset API MONITOR_CODE SetColorPreset(UWORD32 u32Val) Params u32Val Color preset 0x00000001 Standard 0x00000002 Multimedia 0x00000004 Movie 0x00000008 Game 0x00000010 Paper 0x00000020 Color Temp.
PAGE 33
GetCustomColor Returns the current custom color NOTE: Only works in Color Preset Custom Color.
PAGE 34
SetCustomColor Sets the custom color NOTE: Only works in Color Preset Custom Color.
PAGE 35
GetGammaMode Returns the gamma mode API MONITOR_CODE GetGammaMode(UBYTE *pu8Val) Params *pu8Val Pointer to return gamma mode Return MONITOR_CODE u8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Gamma Mode 0 2.2 1 1.8 SetGammaMode Sets the gamma mode API MONITOR_CODE SetGammaMode(UBYTE u8Val) Params u8Val Gamma Mode 0 2.2 1 1.
PAGE 36
GetUniformityCompensation Returns the uniformity compensation setting API MONITOR_CODE GetUniformityCompensation(UBYTE *pu8Val) Params *pu8Val Pointer to return uniformity compensation setting Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Uniformity Compensation 0 Off 2 On SetUniformityCompensation Sets the uniformity compensation API MONITOR_CODE SetUniformityCompensation(UBYTE u8Val) Params u8
PAGE 37
ResetColor Reset all color settings to default API MONITOR_CODE ResetColor(void) Params Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Color Management | 37
PAGE 38
LUT Management GetCalibrationHours Returns the calibration hours of CAL1 or CAL2 since last SetLUT. NOTE: Only works in Color Preset Color Space CAL1 or CAL2.
PAGE 39
MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure CAL brightness value Integer value 0 (dark) to 100 (bright) Values in increments of 1 SetCalBrightness Set the brightness level of CAL1 or CAL2. NOTE: Only works in Color Preset Color Space CAL1 or CAL2.
PAGE 40
SetColorControl Enables or disables color engine for native color. NOTE: Only works in Color Preset Color Space CAL1 or CAL2. API MONITOR_CODE SetColorControl(UBYTE u8Val) Params u8Val 0 Disable 1 Enable Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure SetLUT Setup the LUT (Look Up Tables) for CAL1 or CAL2. NOTE: Only works in Color Preset Color Space CAL1 or CAL2.
PAGE 41
arrColorMatrix 2’s complement values of the 3x3 16-bit color matrix, in the order from a1 to a9 Rout = (1+a1)Rin + a2Gin + a3Bin Gout = a4Rin + (1+a5)Gin + a6Bin Bout = a7Rin + a8Gin + (1+a9)Bin Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure LUT Management | 41
PAGE 42
Video Input Management GetAutoSelect Returns the input source auto select setting API MONITOR_CODE GetAutoSelect(UBYTE *pu8Val) Params *pu8Val Pointer to return auto select setting Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Auto Select 0 Off 1 On SetAutoSelect Turns on/off input source auto select API MONITOR_CODE SetAutoSelect(UBYTE u8Val) Params u8Val Auto Select 0 Off 1 On Return 42
PAGE 43
MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure GetVideoInputCaps Returns the available video inputs API MONITOR_CODE GetVideoInputCaps(UWORD32 *pu32Val) Params *pu32Val Pointer to return available video inputs Return MONITOR_CODE pu32Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Bitwise representation of available video inputs 0x00
PAGE 44
GetVideoInput Returns the current video input source API MONITOR_CODE GetVideoInput(UWORD32 *pu32Val) Params *pu32Val Pointer to return video input source Return MONITOR_CODE pu32Val 44 | Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Video Input Source 0x00000001 HDMI1 0x00000002 HDMI2 0x00000004 HDMI3 0x00000008 DP1 0x00000010 DP2 0x00000020 DP3 0x00000040 VGA1 0x00000080 VGA2 0x00000100 DVI1 0x0000020
PAGE 45
SetVideoInput Sets the video input source API MONITOR_CODE SetVideoInput(UWORD32 u32Val) Params u32Val Video Input Source 0x00000001 HDMI1 0x00000002 HDMI2 0x00000004 HDMI3 0x00000008 DP1 0x00000010 DP2 0x00000020 DP3 0x00000040 VGA1 0x00000080 VGA2 0x00000100 DVI1 0x00000200 DVI2 Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Video Input Management | 45
PAGE 46
PIP/PBP Management GetPxPMode Returns the current PIP/PBP mode API MONITOR_CODE GetPxPMode(UBYTE *pu8Val) Params *pu8Val Pointer to return PIP/PBP mode Return MONITOR_CODE pu8Val 46 | Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure PIP/PBP Mode 0 Off 1 PIP Small 2 PIP Large 3 PBP Aspect Ratio 4 PBP Fill PIP/PBP Management
PAGE 47
SetPxPMode Sets the PIP/PBP mode API MONITOR_CODE SetPxPMode(UBYTE u8Val) Params u8Val PIP/PBP Mode 0 Off 1 PIP Small 2 PIP Large 3 PBP Aspect Ratio 4 PBP Fill Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure GetPxPSubInput Returns the current PxP sub video input source API MONITOR_CODE GetPxPSubInput(UWORD32 *pu32Val) Params *pu32Val Pointer to return PxP sub video input source Return MONITOR_CODE
PAGE 48
pu32Val Video Input Source 0x00000001 HDMI1 0x00000002 HDMI2 0x00000004 HDMI3 0x00000008 DP1 0x00000010 DP2 0x00000020 DP3 0x00000040 VGA1 0x00000080 VGA2 0x00000100 DVI1 0x00000200 DVI2 SetPxPSubInput Sets the PxP sub video input source API MONITOR_CODE SetPxPSubInput(UWORD32 u32Val) Params u32Val Video Input Source 0x00000001 HDMI1 0x00000002 HDMI2 0x00000004 HDMI3 0x00000008 DP1 0x00000010 DP2 0x00000020 DP3 0x00000040 VGA1 0x00000080 VGA2 0x00000100 DVI1 0x0000020
PAGE 49
GetPxPLocation Returns the current PIP/PBP location API MONITOR_CODE GetPxPLocation(UBYTE *pu8Val) Params *pu8Val Pointer to return PIP/PBP location Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure PIP/PBP Location 0 Top-Right 1 Top-Left 2 Bottom-Right 3 Bottom-Left PIP/PBP Management | 49
PAGE 50
SetPxPLocation Sets the PIP/PBP location API MONITOR_CODE SetPxPLocation(UBYTE u8Val) Params u8Val PIP/PBP Location 0 Top-Right 1 Top-Left 2 Bottom-Right 3 Bottom-Left Return MONITOR_CODE 50 | Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure PIP/PBP Management
PAGE 51
OSD GetOSDTransparency Get the OSD Transparency API MONITOR_CODE GetOSDTransparency(UBYTE *pu8Val) Params *pu8Val Pointer to return OSD Transparency value Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure OSD Transparency Integer value 0 (opaque) to 100 (transparent) Default 20 Values in increments of 20 SetOSDTransparency Set the OSD Transparency API MONITOR_CODE SetOSDTransparency(UBYTE u8Val) Param
PAGE 52
MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure GetOSDLanguage Get the OSD Language API MONITOR_CODE GetOSDLanguage(UBYTE *pu8Val) Params *pu8Val Pointer to return OSD Language value Return MONITOR_CODE pu8Val 52 | Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure OSD Language OSD 0 English 1 Espanol 2 Francais 3 Deutsch 4 P
PAGE 53
SetOSDLanguage Set the OSD Language API MONITOR_CODE SetOSDLanguage(UBYTE u8Val) Params u8Val OSD Language 0 English 1 Espanol 2 Francais 3 Deutsch 4 Português (Brasil) 5 Русский 6 简体中文 7 日本語 Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure OSD | 53
PAGE 54
GetOSDRotation Get the OSD Rotation API MONITOR_CODE GetOSDRotation(UBYTE *pu8Val) Params *pu8Val Pointer to return OSD Rotation value Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure OSD Rotation 0 0 degree 1 90 degrees 2 270 degrees 3 180 degrees SetOSDRotation Set the OSD Rotations API MONITOR_CODE SetOSDRotation(UBYTE u8Val) Params u8Val OSD Rotation 0 0 degree 1 90 degrees 2 270 degr
PAGE 55
GetOSDTimer Get the OSD Timer API MONITOR_CODE GetOSDTimer(UBYTE *pu8Val) Params *pu8Val Pointer to return OSD Timer value Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure OSD Timer Integer value 5 to 60 seconds Default 20 seconds Values in increments of 1 SetOSDTimer Set the OSD Timer API MONITOR_CODE SetOSDTimer(UBYTE u8Val) Params pu8Val OSD Timer Integer value 5 to 60 seconds Default 20 seconds V
PAGE 56
GetOSDButtonLock Get the OSD Timer API MONITOR_CODE GetOSDButtonLock(UBYTE *pu8Val) Params *pu8Val Pointer to return OSD Timer value Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure OSD Button Lock 0 Unlock 1 Lock SetOSDButtonLock Set the OSD Timer API MONITOR_CODE SetOSDButtonLock(UBYTE u8Val) Params u8Val OSD Button Lock 0 Unlock 1 Lock Return MONITOR_CODE 56 | OSD Code describing the
PAGE 57
ResetOSD Reset OSD to default settings API MONITOR_CODE ResetOSD(void) Params Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure OSD | 57
PAGE 58
System Management GetVersionFirmware Returns the firmware version of the monitor API MONITOR_CODE GetVersionFirmware(BYTE *ps16Val) Params *pbyFirmwareVersion Pointer to return OSD Transparency value Return MONITOR_CODE pbyFirmwareVersion Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Version string (max 10 chars) GetVersionSDK Returns the SDK version API MONITOR_CODE GetVersionSDK(SWORD16 *ps16Val) Params *pbyVersion Point
PAGE 59
GetMST Returns if the MST is on or off API MONITOR_CODE GetMST(UBYTE *pu8Val) Params *pu8Val Pointer to return MST value Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure MST value 0 Off 1 On SetMST Turns on / off the MST API MONITOR_CODE SetMST(UBYTE u8Val) Params u8Val MST value to set 0 Off 1 On Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parame
PAGE 60
GetLCDConditioning Returns if the LCD Conditioning is enabled or disabled API MONITOR_CODE GetLCDConditioning(UBYTE *pu8Val) Params *pu8Val Pointer to return LCD Conditioning value Return MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure LCD Conditioning 0 Disabled 1 Enabled SetLCDConditioning Enable / Disable the LCD Conditioning API MONITOR_CODE SetLCDConditioning (UBYTE u8Val) Params u8Val LCD Conditio
PAGE 61
FactoryReset Reset to factory settings API MONITOR_CODE FactoryReset(void) Params Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure SetDebugLevel Set the level of debug for the SDK API MONITOR_CODE SetDebugLevel(UBYTE u8Val) Params u8Val Debug Level 0 Turn off debug 1 Errors 2 Warnings 3 Debug 4 Trace Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Errors 2 Parameters E