Dell UP3218K SDK for Monitors - Application Programming Interface Guide
Dell UP3218K Manual
![]() |
View all Dell UP3218K manuals
Add to My Manuals
Save this manual to your list of manuals |
Dell UP3218K manual content summary:
- Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 1
Dell SDK for Monitors Application Programming Interface Guide for SDK version 1.4 - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 2
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.; Microsoft®, Windows®, and the Windows start button logo are either trademarks - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 3
Contents Contents ...3 Introduction ...6 API Return Codes...6 Monitor Management ...7 GetAvailableMonitors...7 ConnectMonitor ...7 DisconnectMonitor ...7 SetAssetTag ...7 GetAssetTag ...7 GetMonitorName ...8 GetMonitorSerialNumber ...8 GetBacklightHours ...8 Power Management...9 GetPowerState ...9 - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 4
GetSaturation...15 SetSaturation...15 GetHue ...15 SetHue ...16 GetColorTempCaps ...16 GetColorTemp ...16 SetColorTemp ...17 GetColorSpaceCaps...17 GetColorSpaceState...17 SetColorSpaceState ...18 GetInputColorFormat ...18 SetInputColorFormat ...18 GetColorPresetCaps ...19 GetColorPreset ...19 - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 5
SetPxPMode ...28 GetPxPSubInput ...28 SetPxPSubInput ...29 GetPxPLocation ...29 SetPxPLocation ...30 OSD ...31 GetOSDTransparency ...31 SetOSDTransparency ...31 GetOSDLanguage ...31 SetOSDLanguage...32 GetOSDRotation ...32 SetOSDRotation ...32 GetOSDTimer ...32 SetOSDTimer ...33 GetOSDButtonLock ... - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 6
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. UP2516D 2. UP2716D 3. UP3017 4. UP3218K The API described in this document corresponds to SDK version 1.4. API Return - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 7
monitor(s) API MONITOR_CODE GetAvailableMonitors(BYTE *pbCount) Params byMonitors[] Array for return values Return pbCount Number of supported monitors connected ConnectMonitor Connect to monitor and start session API MONITOR_CODE ConnectMonitor(BYTE iID) Params iID Index of monitor - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 8
API MONITOR_CODE GetAssetTag(BYTE *pbyAssetTag) Params *pbyAssetTag Pointer to return asset tag ID string Return pbyAssetTag Asset tag ID string (max 10 chars) GetMonitorName Returns the monitor name API MONITOR_CODE GetMonitorName(BYTE *pbyMonitorName) Params *pbyMonitorName Pointer to - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 9
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 pu8Val Power State 0 Off 1 On 2 Standby SetPowerState Set the monitor on or standby API MONITOR_CODE SetPowerState( - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 10
MONITOR_CODE SetPowerLED(UBYTE u8Val) Params u8Val Power LED Setting 0 Off during Active 1 On during Active GetPowerUSB Returns the power USB setting of the monitor API MONITOR_CODE GetPowerUSB(UBYTE *pu8Val) Params *pu8Val Pointer to return power USB setting Return pu8Val Power USB Setting - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 11
Image Management GetBrightness Returns the brightness level of the monitor API MONITOR_CODE GetBrightness(UBYTE *pu8Val) Params *pu8Val Pointer to return brightness value Return pu8Val Brightness value Integer value 0 (dark) to 100 (bright) Default 75 Values in increments of 1 SetBrightness - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 12
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 GetDynamicContrast Returns the dynamic contrast setting. Applicable for Movies - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 13
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:9 1 Auto Resize 2 4:3 3 1:1 GetSharpness Returns the sharpness level API MONITOR_CODE GetSharpness(UBYTE *pu8Val) Params *pu8Val - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 14
Params *pu8Val Return pu8Val Pointer to return response time value 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 14 | Image Management - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 15
Color Management GetSaturation Returns the color saturation level NOTE: Only works in Color Preset Game or Movie. API MONITOR_CODE GetSaturation(UBYTE *pu8Val) Params *pu8Val Pointer to return color saturation level Return pu8Val Color Saturation level Integer value 0 to 100 Default 50 Values - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 16
SetHue(UBYTE u8Val) Params u8Val Hue level Integer value 0 to 100 Default 50 Values in increments of 1 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 - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 17
RGB 0x00000002 sRGB 0x00000004 Rec 709 0x00000008 DCI-P3 0x00000010 CAL 1 0x00000020 CAL 2 For example: 0x00000013 would indicate Adobe RGB, sRGB and CAL 1 supported GetColorSpaceState Returns the current color space state NOTE: Only works in Color Preset Color Space. API Color Management | 17 - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 18
MONITOR_CODE GetColorSpaceState(UWORD32 *pu32Val) Params *pu32Val Pointer to return color space state Return pu32Val Color space 0x00000001 0x00000002 0x00000004 0x00000008 0x00000010 0x00000020 Adobe RGB sRGB Rec 709 DCI-P3 CAL 1 CAL 2 SetColorSpaceState Sets the color space state NOTE: Only - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 19
GetColorPresetCaps(UWORD32 *pu32Val) Params *pu32Val Pointer to return color space capabilities Return pu32Val Bitwise representation of supported color presets 0x00000001 Standard 0x00000002 Multimedia 0x00000004 Movie 0x00000008 Game 0x00000010 Paper 0x00000020 Color Temp. 0x00000040 Color - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 20
MONITOR_CODE SetColorPreset(UWORD32 u32Val) Params u32Val Color preset 0x00000001 0x00000002 0x00000004 0x00000008 0x00000010 0x00000020 0x00000040 0x00000080 Standard Multimedia Movie Game Paper Color Temp. Color Space Custom Color GetCustomColor Returns the current custom color NOTE: Only - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 21
GetGammaMode(UBYTE *pu8Val) Params *pu8Val Pointer to return gamma mode Return pu8Val Gamma Mode 0 PC 1 MAC Note Not supported on UP3218K SetGammaMode Sets the gamma mode API MONITOR_CODE SetGammaMode(UBYTE u8Val) Params u8Val Gamma Mode 0 PC 1 MAC Color Management | 21 - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 22
Note Not supported on UP3218K GetUniformityCompensation Returns the uniformity compensation setting API MONITOR_CODE GetUniformityCompensation(UBYTE *pu8Val) Params *pu8Val Pointer to return uniformity compensation setting Return pu8Val Uniformity Compensation 0 Off 2 On - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 23
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. API MONITOR_CODE GetCalibrationHours(SWORD16 *ps16Val) Params *ps16Val Pointer to return monitor calibration hours Return ps16Val - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 24
NOTE: Only works in Color Preset Color Space CAL1 or CAL2. API MONITOR_CODE SetColorControl(UBYTE u8Val) Params u8Val 0 Disable 1 Enable SetLUT Setup the LUT (Look Up Tables) for CAL1 or CAL2. NOTE: Only works in Color Preset Color Space CAL1 or CAL2. API MONITOR_CODE SetLUT(UWORD16 - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 25
*arrPreGamma *arrPostGamma arrColorMatrix Array with arrGammaLen-size 16-bit color values for RGB channels, where [0][arrGammaLen] for Red channel, [1][arrGammaLen] for Green channel and [2][arrGammaLen] for Blue channel Array with arrGammaLen-size 16-bit color values for RGB channels, where [0][ - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 26
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 pu8Val Auto Select 0 Off 1 On SetAutoSelect Turns on/off input source auto select API MONITOR_CODE - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 27
For example: 0x00000149 would indicate HDMI1, DP1, VGA1 and DVI1 available GetVideoInput Returns the current video input source API MONITOR_CODE GetVideoInput(UWORD32 *pu32Val) Params *pu32Val Pointer to return video input source Return pu32Val Video Input Source 0x00000001 HDMI1 0x00000002 - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 28
to return PIP/PBP mode Return pu8Val PIP/PBP Mode 0 Off 1 PIP Small 2 PIP Large 3 PBP Aspect Ratio 4 PBP Fill Note Not supported on UP3218K 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 - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 29
HDMI2 0x00000004 HDMI3 0x00000008 DP1 0x00000010 DP2 0x00000020 DP3 0x00000040 VGA1 0x00000080 VGA2 0x00000100 DVI1 0x00000200 DVI2 Note Not supported on UP3218K SetPxPSubInput Sets the PxP sub video input source API MONITOR_CODE SetPxPSubInput(UWORD32 u32Val) Params u32Val Video Input Source - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 30
3 Bottom-Left Note Not supported on UP3218K 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 Note Not supported on UP3218K 30 | PIP/PBP Management - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 31
Language API MONITOR_CODE GetOSDLanguage(UBYTE *pu8Val) Params *pu8Val Pointer to return OSD Language value Return pu8Val OSD Language 0 English 1 Espanol 2 Francais 3 Deutsch 4 Português (Brasil) 5 6 OSD | 31 - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 32
7 日本語 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 日本語 GetOSDRotation Get the OSD Rotation API MONITOR_CODE GetOSDRotation(UBYTE *pu8Val) Params *pu8Val Pointer - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 33
API MONITOR_CODE GetOSDTimer(UBYTE *pu8Val) Params *pu8Val Pointer to return OSD Timer value Return pu8Val 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 u8Val OSD Timer - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 34
GetButtonSound(UBYTE *pu8Val) Params *pu8Val Pointer to return Button Sound value Return pu8Val Button Sound 0 Off 1 On Note Not supported on UP3218K SetButtonSound Set the button sound on or off API MONITOR_CODE SetButtonSound(UBYTE u8Val) Params u8Val Button Sound 0 Off 1 On Note - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 35
System Management GetVersionFirmware Returns the firmware version of the monitor API MONITOR_CODE GetVersionFirmware(BYTE *ps16Val) Params *pbyFirmwareVersion Pointer to firmware version for return Return pbyFirmwareVersion Version string (max 10 chars) GetVersionSDK Returns the SDK version - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 36
Turns on / off the MST API MONITOR_CODE SetMST(UBYTE u8Val) Params u8Val MST value to set 0 Off 1 On Note Not supported on UP3218K GetLCDConditioning Returns if the LCD Conditioning is enabled or disabled API MONITOR_CODE GetLCDConditioning(UBYTE *pu8Val) Params *pu8Val Pointer to return LCD - Dell UP3218K | SDK for Monitors - Application Programming Interface Guide - Page 37
API MONITOR_CODE FactoryReset(void) Params - 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 System Management | 37
![](/manual_guide/products/dell-up3218k-sdk-monitors-application-programming-interface-guide-154ff2c/1.png)
Dell SDK for Monitors
Application Programming Interface Guide
for SDK version 1.4