SDK DocsSetting Keys

SettingKey — Complete Reference

evolis.SettingKey is an enum that identifies every configurable print setting.
Settings are divided by prefix:

  • F — Front face
  • B — Back face
  • G — Global (applies to both faces or entire job)
  • I — Image / internal configuration
  • W — WiseCube scanner settings
  • U — UI / driver-level settings

Front Face Settings

KeyTypeValuesDescription
FBlackManagementLISTNOBLACKPOINT, ALLBLACKPOINT, TEXTINBLACK, BMPBLACKHow the K panel is used on the front
FBlackPrintingLISTON, OFFEnable/disable front K panel
FColorBrightnessINT1–20Front color brightness
FColorContrastINT1–20Front color contrast
FDualDepositeLISTON, OFFFront dual deposit
FHalftoningLISTTHRESHOLD, FLOYD, DITHERING, CLUSTERED_DITHERINGFront halftoning algorithm
FMonochromeContrastINT1–20Front monochrome contrast
FOverlayContrastINT1–20Front overlay contrast
FOverlayManagementLISTNOVARNISH, FULLVARNISH, BMPVARNISHFront overlay (O panel) mode
FOverlaySecondManagementLISTNOVARNISH, FULLVARNISH, BMPVARNISHFront second overlay mode
FPageRotate180LISTON, OFFRotate front image 180°
FRwErasingSpeedINT1–10Front RW erasing speed
FRwErasingTemperatureINT1–20Front RW erasing temperature
FRwManagementLISTWRITEONLY, FULLREWRITE, BMPREWRITEFront RW mode
FRwPrintingSpeedINT1–10Front RW printing speed
FRwPrintingTemperatureINT1–20Front RW printing temperature
FUvBrightnessINT1–20Front UV panel brightness
FUvContrastINT1–20Front UV panel contrast
FUvManagementLISTNOUV, BMPUVFront UV panel mode
FSilverManagementLISTNOSILVERFront silver panel (Avansia)
FGammaLISTON, OFFFront gamma correction
FGammaFactorINT0–100Front gamma factor

Back Face Settings

KeyTypeValuesDescription
BBlackManagementLISTNOBLACKPOINT, ALLBLACKPOINT, TEXTINBLACK, BMPBLACKHow the K panel is used on the back
BBlackPrintingLISTON, OFFEnable/disable back K panel
BColorBrightnessINT1–20Back color brightness
BColorContrastINT1–20Back color contrast
BDualDepositeLISTON, OFFBack dual deposit
BHalftoningLISTTHRESHOLD, FLOYD, DITHERING, CLUSTERED_DITHERINGBack halftoning algorithm
BMonochromeContrastINT1–20Back monochrome contrast
BOverlayContrastINT1–20Back overlay contrast
BOverlayManagementLISTNOVARNISH, FULLVARNISH, BMPVARNISHBack overlay mode
BOverlaySecondManagementLISTNOVARNISH, FULLVARNISH, BMPVARNISHBack second overlay mode
BPageRotate180LISTON, OFFRotate back image 180°
BRwErasingSpeedINT1–10Back RW erasing speed
BRwErasingTemperatureINT1–20Back RW erasing temperature
BRwManagementLISTWRITEONLY, FULLREWRITE, BMPREWRITEBack RW mode
BRwPrintingSpeedINT1–10Back RW printing speed
BRwPrintingTemperatureINT1–20Back RW printing temperature
BUvBrightnessINT1–20Back UV brightness
BUvContrastINT1–20Back UV contrast
BUvManagementLISTNOUV, BMPUVBack UV mode
BSilverManagementLISTNOSILVERBack silver panel (Avansia)
BGammaLISTON, OFFBack gamma correction
BGammaFactorINT0–100Back gamma factor

Global Settings

KeyTypeValuesDescription
GCardPreloadingLISTON, OFFCard pre-loading
GDigitalScramblingLISTON, OFFDigital scrambling
GDuplexTypeLISTDUPLEX_CC, DUPLEX_CM, DUPLEX_MC, DUPLEX_MMDuplex flip type
GFeederCfgLISTPRINTER, AUTO, FEEDERAFEEDERD, ALTERNATE, FEEDER1FEEDER4, NONEFeeder selection
GFeederPosLISTPRINTER, FEEDERAFEEDERD, MIDDLE, OFFFeeder position
GHighQualityModeLISTON, OFFHigh quality print mode
GInputTrayLISTPRINTER, FEEDER, AUTO, MANUAL, HOPPER, BEZELInput card source
GMagCoercivityLISTOFF, LOCO, HICOMagnetic encoding coercivity
GMagT1EncodingLISTISO1, ISO2, ISO3, SIPASS, C2, JIS2, C4, NONETrack 1 encoding format
GMagT2EncodingLISTsameTrack 2 encoding format
GMagT3EncodingLISTsameTrack 3 encoding format
GOutputTrayLISTPRINTER, HOPPER, REAR, MANUAL, REJECT, BEZELOutput destination
GPipeDetectionLISTOFF, DEFAULT, CUSTOMPipe detection mode
GRejectBoxLISTPRINTER, DEFAULTREJECT, HOPPER, MANUAL, REJECT, BEZELError card destination
GRibbonTypeLISTRC_YMCKI, RC_YMCK, RM_KBLACK, … (see RibbonType)Active ribbon type
GRwCardLISTMBLACK, MBLUE, CUSTOM_FRONT, CUSTOM_DUPLEXRW card type
GPrintingModeLISTD2T2, RW_2IN1Print technology mode
GShortPanelManagementLISTAUTO, CUSTOM, OFFShort panel handling
GSmoothingLISTSTDSMOOTH, ADVSMOOTH, NOSMOOTHImage smoothing
GUvPremiumLISTON, OFFUV premium mode
GColorProfileModeLISTNOPROFILE, DRIVERPROFILE, CUSTOMColor profile mode
GColorProfileLISTSTDPROFILEActive color profile
GColorProfileRenderingLISTPERCEPTUAL, SATURATIONColor rendering intent

Job-Level Settings

KeyTypeValuesDescription
DuplexLISTNONE, HORIZONTALEnable duplex printing
OrientationLISTLANDSCAPE_CC90, PORTRAITCard orientation
PaperSizeLISTCR80, ISOCR80, CR120X50, CR150X50, AVANSIACR80Card size
ResolutionLISTDPI300260, DPI300, DPI600300, DPI600, DPI1200300Print resolution

Image / Internal Settings

KeyTypeDescription
IBBlackCustom / IFBlackCustomTEXTCustom black region definition
IBBlackLevelValue / IFBlackLevelValueINT 1–255Black level threshold
IBDarkLevelValue / IFDarkLevelValueINT 0–255Dark level value
IBNoTransferAreas / IFNoTransferAreasTEXTNo-transfer zone definition
IBOverlayCustom / IFOverlayCustomTEXTCustom overlay region
IBRegionPrintingMode / IFRegionPrintingModeLIST RESIN, BLACK_COMPOSITERegion printing mode
IBRwCustom / IFRwCustomTEXTCustom RW region
IBTextRegion / IFTextRegionTEXTText region definition
IBThresholdValue / IFThresholdValueINT 1–255Image threshold value
IBUvCustom / IFUvCustomTEXTCustom UV region
IGBlackSubTEXTBlack sub-region definition
IGMonochromeSpeedINT 1–10Monochrome printing speed
IGRegionOrientationLIST LANDSCAPE, PORTRAITRegion orientation
IGSendIQLALIST ON, OFFSend IQLA data
IGDisableAutoEjectLIST ON, OFFDisable auto-eject
IGColorProfileCustomTEXTPath to custom ICC profile
IPostSmoothingLIST STDSMOOTH, ADVSMOOTH, NOSMOOTHPost-processing smoothing
ISendBlankPanelLIST ON, OFFSend a blank panel
IShortPanelShiftINT 0–9999Short panel shift in units

Scanner Settings (WiseCube)

KeyTypeValuesDescription
WIScanImageDepthLISTBPP8, BPP16, BPP24, BPP32Scan color depth
WIScanImageResolutionLISTDPI300, DPI600Scan resolution
WIScanImageFileFormatLISTJPG, BMP, PNGScan image file format
WIScanSpeedINT0–40Scan speed
WIScanOffsetINT0–40Scan offset
WIScanCardSidesLISTFRONT_BACK, FRONT_ONLY, BACK_ONLYSides to scan

Usage Example

import evolis
 
with evolis.Connection("Evolis Primacy") as co:
    ps = evolis.PrintSession(co, evolis.RibbonType.YMCKO)
 
    # Print at 600 DPI
    ps.set_setting(evolis.SettingKey.Resolution, "DPI600")
 
    # Use bitmap-defined black (explicit K panel)
    ps.set_setting(evolis.SettingKey.FBlackManagement, "BMPBLACK")
 
    # Full varnish overlay
    ps.set_setting(evolis.SettingKey.FOverlayManagement, "FULLVARNISH")
 
    ps.set_image(evolis.CardFace.FRONT, "/path/to/color.bmp")
    ps.set_black(evolis.CardFace.FRONT, "/path/to/black.bmp")
 
    rc = ps.print()
    print("Result:", rc)