Namespace LrDevelopController

 Parameters in panels: (these panel IDs can be used with revealPanel)
 
 adjustPanel = {
 "Temperature",
 "Tint",
 "Exposure",
 "Highlights", 	(controls Recovery in Version 1 and Version 2)
 "Shadows", 	(controls Fill Light in Version 1 and Version 2)
 "Brightness", (no effect unless in Version 1 or Version 2)
 "Contrast",
 "Whites", 	(no effect in Version 1 and Version 2)
 "Blacks",
 "Texture",
 "Clarity",
 "Dehaze",
 "Vibrance",
 "Saturation",
 "PresetAmount",
 "ProfileAmount",
 }
 
 tonePanel = {
 "ParametricDarks",
 "ParametricLights",
 "ParametricShadows",
 "ParametricHighlights",
 "ParametricShadowSplit",
 "ParametricMidtoneSplit",
 "ParametricHighlightSplit",
 "ToneCurve",
 "ToneCurvePV2012",
 "ToneCurvePV2012Red",
 "ToneCurvePV2012Blue",
 "ToneCurvePV2012Green",
 "CurveRefineSaturation",
 }
 
 mixerPanel = {
 -- HSL / Color
 "SaturationAdjustmentRed",
 "SaturationAdjustmentOrange",
 "SaturationAdjustmentYellow",
 "SaturationAdjustmentGreen",
 "SaturationAdjustmentAqua",
 "SaturationAdjustmentBlue",
 "SaturationAdjustmentPurple",
 "SaturationAdjustmentMagenta",
 "HueAdjustmentRed",
 "HueAdjustmentOrange",
 "HueAdjustmentYellow",
 "HueAdjustmentGreen",
 "HueAdjustmentAqua",
 "HueAdjustmentBlue",
 "HueAdjustmentPurple",
 "HueAdjustmentMagenta",
 "LuminanceAdjustmentRed",
 "LuminanceAdjustmentOrange",
 "LuminanceAdjustmentYellow",
 "LuminanceAdjustmentGreen",
 "LuminanceAdjustmentAqua",
 "LuminanceAdjustmentBlue",
 "LuminanceAdjustmentPurple",
 "LuminanceAdjustmentMagenta",
 -- Point Colors 
 "PointColors",
 -- B & W
 "GrayMixerRed",
 "GrayMixerOrange",
 "GrayMixerYellow",
 "GrayMixerGreen",
 "GrayMixerAqua",
 "GrayMixerBlue",
 "GrayMixerPurple",
 "GrayMixerMagenta",
 }
 
 colorGradingPanel = {
 "SplitToningShadowHue",
 "SplitToningShadowSaturation",
 "ColorGradeShadowLum",
 "SplitToningHighlightHue",
 "SplitToningHighlightSaturation",
 "ColorGradeHighlightLum",
 "ColorGradeMidtoneHue",
 "ColorGradeMidtoneSat",
 "ColorGradeMidtoneLum",
 "ColorGradeGlobalHue",
 "ColorGradeGlobalSat",
 "ColorGradeGlobalLum",
 "SplitToningBalance",
 "ColorGradeBlending",
 }
 
 detailPanel = {
 "Sharpness",
 "SharpenRadius",
 "SharpenDetail",
 "SharpenEdgeMasking",
 "LuminanceSmoothing",
 "LuminanceNoiseReductionDetail",
 "LuminanceNoiseReductionContrast",
 "ColorNoiseReduction",
 "ColorNoiseReductionDetail",
 "ColorNoiseReductionSmoothness",
 }
 
 effectsPanel = {
 -- Post-Crop Vignetting
 "PostCropVignetteAmount",
 "PostCropVignetteMidpoint",
 "PostCropVignetteFeather",
 "PostCropVignetteRoundness",
 "PostCropVignetteStyle",
 "PostCropVignetteHighlightContrast",
 -- Grain
 "GrainAmount",
 "GrainSize",
 "GrainFrequency",
 }
 
 lensCorrectionsPanel = {
 -- Chromatic Aberration
 "AutoLateralCA",
 -- Enable Lens Correction
 "LensProfileEnable",
 -- Profile
 "LensProfileDistortionScale",
 "LensProfileVignettingScale",
 "LensManualDistortionAmount",
 -- Color
 "DefringePurpleAmount",
 "DefringePurpleHueLo",
 "DefringePurpleHueHi",
 "DefringeGreenAmount",
 "DefringeGreenHueLo",
 "DefringeGreenHueHi",
 "VignetteAmount",
 "VignetteMidpoint",
 -- Manual Perspective
 "PerspectiveVertical",
 "PerspectiveHorizontal",
 "PerspectiveRotate",
 "PerspectiveScale",
 "PerspectiveAspect",
 "PerspectiveX",
 "PerspectiveY",
 "PerspectiveUpright",
 }
 
 calibratePanel = {
 "ShadowTint",
 "RedHue",
 "RedSaturation",
 "GreenHue",
 "GreenSaturation",
 "BlueHue",
 "BlueSaturation",
 }
 
 lensBlurPanel = {
 "LensBlurActive",
 "LensBlurAmount",
 "LensBlurCatEye",
 "LensBlurHighlightsBoost",
 "LensBlurFocalRange",
 }
 
 Crop Angle:
 
 "straightenAngle"
 
 Localized Adjustments:
 
 Version 2:
 "local_ToningLuminance"
 "local_Exposure"
 "local_Contrast"
 "local_Clarity"
 "local_Saturation"
 "local_Sharpness"
 "local_ToningHue"
 "local_ToningSaturation"
 Version 3:
 "local_Temperature"
 "local_Tint"
 "local_Exposure"
 "local_Contrast"
 "local_Highlights"
 "local_Shadows"
 "local_Clarity"
 "local_Saturation"
 "local_ToningHue"
 "local_ToningSaturation"
 "local_Sharpness"
 "local_LuminanceNoise"
 "local_Moire"
 "local_Defringe"
 "local_Blacks"
 "local_Whites"
 "local_Dehaze"
 "local_PointColors" 
 Version 4:
 "local_Temperature"
 "local_Tint"
 "local_Exposure"
 "local_Contrast"
 "local_Highlights"
 "local_Shadows"
 "local_Clarity"
 "local_Saturation"
 "local_ToningHue"
 "local_ToningSaturation"
 "local_Sharpness"
 "local_LuminanceNoise"
 "local_Moire"
 "local_Defringe"
 "local_Blacks"
 "local_Whites"
 "local_Dehaze"
 "local_PointColors" 
 Version 5:
 "local_Temperature"
 "local_Tint"
 "local_Exposure"
 "local_Contrast"
 "local_Highlights"
 "local_Shadows"
 "local_Clarity"
 "local_Saturation"
 "local_ToningHue"
 "local_ToningSaturation"
 "local_Sharpness"
 "local_LuminanceNoise"
 "local_Moire"
 "local_Defringe"
 "local_Blacks"
 "local_Whites"
 "local_Dehaze"
 "local_PointColors" 
 "local_Texture"
 "local_Hue"
 "local_Amount"
 "local_Maincurve"
 "local_Redcurve"
 "local_Greencurve"
 "local_Bluecurve"
 Version 6:
 "local_Temperature"
 "local_Tint"
 "local_Exposure"
 "local_Contrast"
 "local_Highlights"
 "local_Shadows"
 "local_Clarity"
 "local_Saturation"
 "local_ToningHue"
 "local_ToningSaturation"
 "local_Sharpness"
 "local_LuminanceNoise"
 "local_Moire"
 "local_Defringe"
 "local_Blacks"
 "local_Whites"
 "local_Dehaze"
 "local_PointColors" 
 "local_Texture"
 "local_Hue"
 "local_Amount"
 "local_Maincurve"
 "local_Redcurve"
 "local_Greencurve"
 "local_Bluecurve"
 "local_Grain"
 "local_RefineSaturation"
 
 

Summary

Functions

LrDevelopController.addAdjustmentChangeObserver( functionContext, observer, callback )

Registers a callback to be called any time the adjustments in the Develop module change.

Must be called while the Develop module is active.

Do not show modal dialogs inside the callback.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. functionContext

(LrFunctionContext) The function context that retains the observation.

2. observer

(object) An object that uniquely identifies the observer. Will be passed into the callback.

3. callback

( function( observer ) ) Function that will be called.

LrDevelopController.addPointColorSwatch( swatchTable, isForMasking )

Add new Point Color Swatch.

Must be called while the Develop module is active and current image is on Process Version 3 or above.

First supported in version 13.2 of Lightroom Classic SDK.

Parameters

1. swatchTable

(table). A table with the following fields :-

• SrcHue: (number) Source color's hue value. Values from 0 to 6 are allowed.
• SrcSat: (number) Source color's saturation value. Values from 0 to 1 are allowed.
• SrcLum: (number) Source color's luminance value. Values from 0 to 1 are allowed.
• HueShift: (optional,number) Hue shift. Values from -1 to 1 are allowed. Default: 0.
• SatScale: (optional,number) Saturation shift. Values from -1 to 1 are allowed. Default: 0.
• LumScale: (optional,number) Luminance shift. Values from -1 to 1 are allowed. Default: 0.
• RangeAmount: (optional,number) Range amount. Values from 0 to 1 are allowed. Default: 0.5
• HueRange: (optional,table) Hue range.
• LowerNone: (number) outer left limit. Values from 0 to 1 are allowed.
• LowerFull: (number) inner left limit. Values from 0 to 1 are allowed.
• UpperFull: (number) inner right limit. Values from 0 to 1 are allowed.
• UpperNone: (number) outer right limit. Values from 0 to 1 are allowed.
• SatRange: (optional,table) Saturation range. Follows same table format as HueRange above.
• LumRange: (optional,table) Luminance range. Follows same table format as HueRange above.

2. isForMasking

( optional, boolean ). Set to true if targeting the point colors in masking.

Return value

( boolean, string ) - returns true if new swatch is successfully added. For failures, returns false and an error message. If given color swatch is already present but not selected, then the existing swatch would get selected and no error message is returned.

LrDevelopController.addToCurrentMask( maskType, maskSubtype )

Add to the current mask.

Must be called while the Develop module is active.

First supported in version 11.0 of the Lightroom SDK.

Parameters

1. maskType

(string) type of tool to be created, one of: "brush", "gradient", "radialGradient", "rangeMask", "aiSelection".

2. maskSubtype

(string) subtype of tool to be created, only used when maskType is "rangeMask" or "aiSelection", one of: "color", "luminance", "depth", "subject", "sky", "background", "objects", "people", "landscape".

LrDevelopController.countAllSpots()

Count all spots on an image.

Must be called while the Develop module is active.

First supported in version 14.1 of the Lightroom Classic SDK.

Return value

(number) - returns the count of all spots on the selected image.

LrDevelopController.createNewMask( maskType, maskSubtype )

Create a new mask.

Must be called while the Develop module is active.

First supported in version 11.0 of the Lightroom SDK.

Parameters

1. maskType

(string) type of tool to be created, one of: "brush", "gradient", "radialGradient", "rangeMask", "aiSelection".

2. maskSubtype

(string) subtype of tool to be created, only used when maskType is "rangeMask" or "aiSelection", one of: "color", "luminance", "depth", "subject", "sky", "background", "objects", "people", "landscape".

LrDevelopController.decrement( param, withClippingOn )

Increments the value of a Develop adjustment.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

2. withClippingOn

(optional, boolean) True to turn on Clipping Overlay, for example while changing Exposure

LrDevelopController.deleteMask( id, param )

Delete a mask.

Must be called while the Develop module is active and masking tool is open.

First supported in version 11.0 of the Lightroom SDK.

Parameters

1. id

2. param

(string) ID of the mask to be deleted.

LrDevelopController.deleteMaskTool( id, param )

Delete a mask tool from the current mask.

Must be called while the Develop module is active and masking tool is open.

First supported in version 11.0 of the Lightroom SDK.

Parameters

1. id

2. param

(string) ID of the mask tool to be deleted.

LrDevelopController.deletePointColorSwatch( deleteAll, deleteAtIndex, isForMasking )

Delete Point Color Swatch.

Must be called while the Develop module is active and current image is on Process Version 3 or above.

First supported in version 13.2 of Lightroom Classic SDK.

Parameters

1. deleteAll

( boolean ) - Delete all the color swatches

2. deleteAtIndex

( number ) - Delete the color swatch present at the index provided. "deleteAll" should be false if a single swatch needs to be deleted.

3. isForMasking

( boolean ) - Set to true when targeting the point colors in masking.

Return value

( boolean ) - true if deletion is successful. Returns false when the param 'deleteAtIndex' is out of bounds. i.e., no point color is present at the index provided.

LrDevelopController.deleteSelectedSpot()

Delete selected spot.

Must be called while the Develop module is active and Remove tool is opened.

First supported in version 14.1 of the Lightroom Classic SDK.

LrDevelopController.deleteSelectedVariation()

Delete selected variation.

Valid only if selected spot uses generative AI.

Must be called while the Develop module is active and Remove tool is opened.

First supported in version 14.1 of the Lightroom Classic SDK.

LrDevelopController.duplicateAndInvertMask( id, param )

Duplicate and invert a mask.

Must be called while the Develop module is active and masking tool is open.

First supported in version 11.4 of the Lightroom SDK.

Parameters

1. id

2. param

(string) ID of the mask to be duplicated and inverted.

Return value

(boolean) true if the mask was successfully duplicated and inverted.

LrDevelopController.editInPhotoshop()

Edit the current photo in Photoshop.

First supported in version 7.4 of the Lightroom SDK.

LrDevelopController.getActiveColorGradingView()

Get Active Color Grading View.

First supported in version 10.0 of Lightroom SDK.

Must be called while the Develop module is active and current image is on Process Version 3 or above.

LrDevelopController.getAllMasks()

Get all masks.

Must be called while the Develop module is active.

First supported in version 11.0 of the Lightroom SDK.

Return value

(table) A table of tables, one for each mask. Each mask entry is a table, one for each tool within that mask.

LrDevelopController.getAllSpots()

Get list of all spots on an image.

Must be called while the Develop module is active.

First supported in version 14.1 of the Lightroom Classic SDK.

Return value

(table) - returns list of all the spots on the selected image.

LrDevelopController.getProcessVersion()

Returns the process version of the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

LrDevelopController.getRange( param )

Gets the min and max value of a Develop adjustment.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

Return value

(number, number) the min and max value for the given parameter.

LrDevelopController.getRemovePanelPreferences()

Get Remove panel UI preferences.

First supported in version 14.1 of the Lightroom Classic SDK.

Return value

(table) returns a table with following fields -

• newSpotType: (string) Spot type used for creating new spots. Possible values: "heal_patchmatch", "heal", "clone".
• brushSize: (number) Brush size. Values from 1 to 100 are possible.
• brushFeather: (number) Brush feather. Values from 0 to 100 are possible.
• useGenerativeAI: (bool) Value of "use generatve AI" checkbox.
• detectObjects: (bool) Value of "detect objects" checkbox.
• toolOverlay: (string) Tool overlay mode. Possble values: "always", "auto", "selected", "never".
• visualizeSpots: (bool) Value of "visualize Spots" checkbox.
• visualizationThreshold: (number) Slider value of "visualize spots". Values from 0 to 100 are possible.

LrDevelopController.getSelectedLensBlurBokeh()

Get the selected Lens Blur Bokeh.

First supported in version 13.3 of the Lightroom Classic SDK.

Must be called while the Develop module is active and current image is on Process Version 3 or above.

Return value

(string) Name of the Bokeh, one of: "Circle", "SoapBubble", "Blade", "Ring", or "Anamorphic".

LrDevelopController.getSelectedMask()

Get selected mask.

Must be called while the Develop module is active and masking tool is open.

First supported in version 11.0 of the Lightroom SDK.

Return value

(string) ID of the selected mask.

LrDevelopController.getSelectedMaskTool()

Get selected mask tool.

Must be called while the Develop module is active and masking tool is open.

First supported in version 11.0 of the Lightroom SDK.

Return value

(boolean) ID of the selected mask tool.

LrDevelopController.getSelectedPointColorSwatchIndex( isForMasking )

Get selected Point Color Swatch Index.

Must be called while the Develop module is active and current image is on Process Version 3 or above.

First supported in version 13.2 of Lightroom Classic SDK.

Parameters

1. isForMasking

( boolean ) - For local point colors, set this to true and also make sure to have the masking panel open.

Return value

(number) - returns index of the select swatch/point-color.

LrDevelopController.getSelectedSpotIndex()

Get selected spot index in Remove tool.

Must be called while the Develop module is active and Remove tool is opened.

First supported in version 14.1 of the Lightroom Classic SDK.

Return value

(number) - returns index of selected spot in the list of all spots. Returns nil if no spot is selected.

LrDevelopController.getSelectedSpotParams()

Get selected spot params in Remove tool.

Must be called while the Develop module is active and Remove tool is opened.

First supported in version 14.1 of the Lightroom Classic SDK.

Return value

(table) returns spot params table.

LrDevelopController.getSelectedSpotType()

Get selected spot type in Remove tool.

Must be called while the Develop module is active and Remove tool is opened.

First supported in version 14.1 of the Lightroom Classic SDK.

Return value

(string,bool) returns spotType ( "heal_patchmatch" / "heal" / "clone" ) and boolean value on whether the spot uses generative AI ( valid only for "heal_patchmatch" spot type ).

LrDevelopController.getSelectedTool()

Reports which tool mode is active in Develop.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Return value

(string) current tool mode, one of: "loupe", "crop", "dust", "redeye", "masking", "point_color", "local_point_color", "depth_refinement".

LrDevelopController.getValue( param )

Gets the value of a Develop adjustment for the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

LrDevelopController.goToDevelopGraduatedFilter()

Opens Graduated Filter for the current photo.

First supported in version 7.4 of the Lightroom SDK.

Deprecated API - included for avoiding breakage of plugins

LrDevelopController.goToDevelopRadialFilter()

Open Radial Filter for the current photo.

First supported in version 7.4 of the Lightroom SDK.

Deprecated API - included for avoiding breakage of plugins

LrDevelopController.goToEyeCorrection( eyeCorrectionType )

Open Eye Correction tool for the current photo.

First supported in version 14.1 of the Lightroom Classic SDK.

Parameters

1. eyeCorrectionType

(optional, string). Eye correction type that is to be displayed upon opening the tool. Allowed values: "red_eye", "pet_eye". When no value is passed, last used type is displayed.

LrDevelopController.goToHealing()

Open Healing for the current photo.

First supported in version 12.0 of the Lightroom SDK.

Deprecated API - included for avoiding breakage of plugins. New API : goToRemove.

LrDevelopController.goToMasking()

Open Masking for the current photo.

First supported in version 11.0 of the Lightroom SDK.

LrDevelopController.goToRemove( spotType )

Open Remove tool for the current photo.

First supported in version 14.1 of the Lightroom Classic SDK.

Parameters

1. spotType

(optional, string). Spot type that is to be displayed upon opening the tool. Allowed values: "heal_patchmatch", "heal", "clone". When no value is passed, last used type is displayed. Note: setRemovePanelPreferences API can also be used to change the spot type.

LrDevelopController.goToSpotRemoval()

Open Spot Removal for the current photo.

First supported in version 7.4 of the Lightroom SDK.

Deprecated API - included for avoiding breakage of plugins

LrDevelopController.gotoNextVariation()

Go to next variation.

Valid only if selected spot uses generative AI.

Must be called while the Develop module is active and Remove tool is opened.

First supported in version 14.1 of the Lightroom Classic SDK.

LrDevelopController.gotoPreviousVariation()

Go to previous variation.

Valid only if selected spot uses generative AI.

Must be called while the Develop module is active and Remove tool is opened.

First supported in version 14.1 of the Lightroom Classic SDK.

LrDevelopController.increment( param, withClippingOn )

Increments the value of a Develop adjustment.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

2. withClippingOn

(optional, boolean) True to turn on Clipping Overlay, for example while changing Exposure

LrDevelopController.intersectWithCurrentMask( maskType, maskSubtype )

Intersect with the current mask.

Must be called while the Develop module is active.

First supported in version 11.0 of the Lightroom SDK.

Parameters

1. maskType

(string) type of tool to be created, one of: "brush", "gradient", "radialGradient", "rangeMask", "aiSelection".

2. maskSubtype

(string) subtype of tool to be created, only used when maskType is "rangeMask" or "aiSelection", one of: "color", "luminance", "depth", "subject", "sky", "background", "objects", "people", "landscape".

LrDevelopController.invertMask( id, param )

Invert a mask.

Must be called while the Develop module is active and masking tool is open.

First supported in version 11.4 of the Lightroom SDK.

Parameters

1. id

2. param

(string) ID of the mask to be inverted.

Return value

(boolean) true if the mask was successfully inverted.

LrDevelopController.moveSelectedSpot( leftOrRight, upOrDown, horizontalUnits, verticalUnits, shouldMoveSourceArea )

Move selected spot.

Must be called while the Develop module is active and Remove tool is opened.

First supported in version 14.1 of the Lightroom Classic SDK.

Parameters

1. leftOrRight

(optional,string) pass "left" to move left, "right" to move right. empty/nil value implies no horizontal movement is desired.

2. upOrDown

(optional,string) pass "up" to move up, "down" to move down. empty/nil value implies no vertical movement is desired.

3. horizontalUnits

(optional, number) no. of units to move horizontally. Valid only when 'leftOrRight' param is set appropriately. Default: 1

4. verticalUnits

(optional, number) no. of units to move vertically. Valid only when 'upOrDown' param is set appropriately. Default: 1

5. shouldMoveSourceArea

(optional, bool) if true, move operation would be done on source area. Valid only if selected spot type is "heal" or "clone". Default: false

LrDevelopController.refreshSelectedSpot()

Refresh selected spot.

Must be called while the Develop module is active and Remove tool is opened.

First supported in version 14.1 of the Lightroom Classic SDK.

LrDevelopController.resetAllDevelopAdjustments()

Resets all Develop adjustments for the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

LrDevelopController.resetBrushing()

Clears all localized adjustment brushing from the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Deprecated API - included for avoiding breakage of plugins

LrDevelopController.resetCircularGradient()

Clears all radial filter adjustments from the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Deprecated API - included for avoiding breakage of plugins

LrDevelopController.resetCrop()

Resets the crop angle and frame for the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

LrDevelopController.resetGradient()

Clears all graduated filter adjustments from the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Deprecated API - included for avoiding breakage of plugins

LrDevelopController.resetHealing()

Clears all healing adjustments from the current photo.

Must be called while the Develop module is active.

First supported in version 12.0 of the Lightroom SDK.

LrDevelopController.resetMasking()

Clears all masks from the current photo.

Must be called while the Develop module is active.

First supported in version 11.0 of the Lightroom SDK.

LrDevelopController.resetRedeye()

Clears all redeye removal adjustments from the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

LrDevelopController.resetSpotRemoval()

Clears all spot removal adjustments from the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Deprecated API - included for avoiding breakage of plugins

LrDevelopController.resetToDefault( param )

Resets a single Develop adjustment for the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

LrDevelopController.resetTransforms()

Clears all transforms from the current photo.

Must be called while the Develop module is active.

First supported in version 6.6 of the Lightroom SDK.

LrDevelopController.revealAdjustedControls( reveal )

Enables a mode where adjusting a parameter causes that panel to be automatically revealed in the panel track.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. reveal

(bool) true to enable reveal behavior, false to disable it (the default mode)

LrDevelopController.revealPanel( paramOrPanelID, subPanelID )

Expands and scrolls into view the panel with the given ID.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. paramOrPanelID

(string) either a Develop parameter or a panel ID (adjustPanel, tonePanel, mixerPanel, colorGradingPanel, detailPanel, lensCorrectionsPanel, effectsPanel, calibratePanel, or lensBlurPanel)

2. subPanelID

(optional,string) sub-panel id. For mixer panel, subPanelIDs allowed are (hslColorPanel, pointColorPanel). Introduced in version 13.2 of the Lightroom Classic SDK.

LrDevelopController.revealPanelIfVisible( paramOrPanelID, subPanelID )

Expands and scrolls into view the panel with the given ID only if the right panel is visible.

Must be called while the Develop module is active.

First supported in version 8.1 of the Lightroom SDK.

Parameters

1. paramOrPanelID

(string) either a Develop parameter or a panel ID (adjustPanel, tonePanel, mixerPanel, colorGradingPanel, detailPanel, lensCorrectionsPanel, effectsPanel, calibratePanel, or lensBlurPanel)

2. subPanelID

(optional,string) sub-panel id. For mixer panel, subPanelIDs allowed are (hslColorPanel, pointColorPanel). Introduced in version 13.2 of the Lightroom Classic SDK.

LrDevelopController.selectMask( id, param )

Select a mask.

Must be called while the Develop module is active and masking tool is open.

First supported in version 11.0 of the Lightroom SDK.

Parameters

1. id

2. param

(string) ID of the mask to be selected.

LrDevelopController.selectMaskTool( id, param )

Select a mask tool in current Mask.

Must be called while the Develop module is active and masking tool is open.

First supported in version 11.0 of the Lightroom SDK.

Parameters

1. id

2. param

(string) ID of the mask tool to be selected.

LrDevelopController.selectPointColorSwatch( value, isForMasking )

Select Point Color Swatch for making HSL shifts.

Must be called while the Develop module is active and current image is on Process Version 3 or above.

First supported in version 13.2 of Lightroom Classic SDK.

Parameters

1. value

(number) - Swatch index to be selected. Integer values from 1 to 8 are allowed.

2. isForMasking

( boolean ) - this value should be set to true for local point colors and masking view needs to be active.

LrDevelopController.selectTool( tool )

Select a tool mode in Develop.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. tool

(string) new tool mode, one of: "loupe", "crop", "dust", "redeye", "masking", "upright", "point_color", "local_point_color", "depth_refinement".

LrDevelopController.setActiveColorGradingView( value )

Set Active Color Grading View.

First supported in version 10.0 of Lightroom SDK.

Must be called while the Develop module is active and current image is on Process Version 3 or above.

Parameters

1. value

(string) the view to activate, one of: "3-way", "shadow", "midtone", "highlight", or "global".

LrDevelopController.setAutoTone()

Sets Auto Tone for the current photo.

First supported in version 7.4 of the Lightroom SDK.

LrDevelopController.setAutoWhiteBalance()

Sets Auto White Balance for the current photo.

First supported in version 7.4 of the Lightroom SDK.

LrDevelopController.setLensBlurBokeh( bokeh )

Set the Lens Blur Bokeh.

First supported in version 13.3 of the Lightroom Classic SDK.

Must be called while the Develop module is active and current image is on Process Version 3 or above.

Parameters

1. bokeh

(string) Name of the Bokeh to be set, one of: "Circle", "SoapBubble", "Blade", "Ring", or "Anamorphic".

LrDevelopController.setMultipleAdjustmentThreshold( seconds )

Sets the time threshold that determines when adjustments to different parameters will be grouped together into a single history state versus recorded separately. If multiple different parameters are changed within a window of time that is less than this threshold, they will be grouped together into a single "Multiple Settings" history state. If they occur farther apart than this threshold, each will get its own history state. Recording many separate history states in rapid succession can degrade Lightroom's performance, so this threshold is very important if simultaneous adjustments by the user are a possibility. The default is 0.5 seconds. Has no effect if set to a value that is higher than the tracking delay.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. seconds

(number) time threshold under which multiple adjustments will be grouped together

LrDevelopController.setProcessVersion( value )

Sets the process version of the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. value

(string) the new process version, one of: "Version 1", "Version 2", "Version 3", "Version 4", "Version 5", or "Version 6".

LrDevelopController.setRemovePanelPreferences( preferencesTable )

Set UI Preferences in Remove panel.

First supported in version 14.1 of the Lightroom Classic SDK.

Parameters

1. preferencesTable

(table). A table that includes any of the following fields can be passed :-

• newSpotType: (optional,string) Spot type used for creating new spots. Allowed values: "heal_patchmatch", "heal", "clone".
• brushSize: (optional,number) Brush size. Values from 1 to 100 are allowed.
• brushFeather: (optional,number) Brush feather. Values from 0 to 100 are allowed.
• useGenerativeAI: (optional,bool) Value of "use generatve AI" checkbox.
• detectObjects: (optional,bool) Value of "detect objects" checkbox.
• toolOverlay: (optional,string) Tool overlay mode. Allowed values: "always", "auto", "selected", "never".
• visualizeSpots: (optional,bool) Value of "visualize Spots" checkbox.
• visualizationThreshold: (optional,number) Slider value of "visualize spots". Values from 0 to 100 are allowed.

Return value

( boolean, string ) - returns true for success. For failures, returns false and an error message.

LrDevelopController.setSelectedSpotIndex( spotIndex )

Set selected spot index in Remove tool.

Must be called while the Develop module is active and Remove tool is opened.

First supported in version 14.1 of the Lightroom Classic SDK.

Parameters

1. spotIndex

(number) index of spot that should be selected.

Return value

( boolean, string ) - returns true for success. For failures, returns false and an error message.

LrDevelopController.setSelectedSpotParams( spotParams )

Set selected spot params in Remove tool.

Must be called while the Develop module is active and Remove tool is opened.

First supported in version 14.1 of the Lightroom Classic SDK.

Parameters

1. spotParams

LrDevelopController.setSelectedSpotType( spotType, useGenAI )

Set selected spot type.

Must be called while the Develop module is active and Remove tool is opened.

First supported in version 14.1 of the Lightroom Classic SDK.

Parameters

1. spotType

(string) desired spot type. Allowed values: "heal_patchmatch", "heal", "clone".

2. useGenAI

(bool) when desired spot type is "heal_patchmatch", generative AI can be enabled using this parameter.

LrDevelopController.setTrackingDelay( seconds )

Sets the number of seconds that tracking remains enabled after each adjustment is made. The default is 2 seconds.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. seconds

(number) number of seconds to wait before turning off tracking.

LrDevelopController.setValue( param, value, withClippingOn )

Sets the value of a Develop adjustment for the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Temperature adjustment is logarithmic for RAW and DNG images, rest all are linear.

Texture is disabled for Process Versions 1 and 2. 3 and 4 will get auto updated to Current Process Version on changing.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

2. value

(number) the new value for the parameter

3. withClippingOn

(optional, boolean) True to turn on Clipping Overlay, for example while changing Exposure

LrDevelopController.showClipping()

Shows the clipping.

Must be called while the Develop module is active.

First supported in version 7.4 of the Lightroom SDK.

LrDevelopController.startTracking( param )

Temporarily puts the Develop module into its tracking state, causing faster, lower-quailty redraw and preventing history states from being generated. Tracking will automatically be turned back off as soon as a diferent parameter is adjusted, or two seconds after the last adjustment is made.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

LrDevelopController.stopTracking( isLocalParam )

Causes Develop module to exit its tracking state immediately, creating a single history state for all changes that were made to the parameter that was being tracked.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. isLocalParam

LrDevelopController.subtractFromCurrentMask( maskType, maskSubtype )

Subtract from the current mask.

Must be called while the Develop module is active.

First supported in version 11.0 of the Lightroom SDK.

Parameters

1. maskType

(string) type of tool to be created, one of: "brush", "gradient", "radialGradient", "rangeMask", "aiSelection".

2. maskSubtype

(string) subtype of tool to be created, only used when maskType is "rangeMask" or "aiSelection", one of: "color", "luminance", "depth", "subject", "sky", "background", "objects", "people", "landscape".

LrDevelopController.toggleHideMask( id, param )

Hide/unhide a mask.

Must be called while the Develop module is active and masking tool is open.

First supported in version 11.0 of the Lightroom SDK.

Parameters

1. id

2. param

(string) ID of the mask which is to be hidden/unhidden.

LrDevelopController.toggleHideMaskTool( id, param )

Hide/unhide a mask tool in the current mask.

Must be called while the Develop module is active and masking tool is open.

First supported in version 11.0 of the Lightroom SDK.

Parameters

1. id

2. param

(string) ID of the mask tool which is to be hidden/unhidden.

LrDevelopController.toggleInvertMaskTool( id, param )

Toggle the invert state of a mask tool in the current mask.

Must be called while the Develop module is active and masking tool is open.

First supported in version 11.0 of the Lightroom SDK.

Parameters

1. id

2. param

(string) ID of the mask tool whose invert state is to be toggled.

LrDevelopController.toggleLensBlurDepthVisualization()

Toggles the Visualize Depth checkbox present in the Lens Blur panel.

First supported in version 13.3 of the Lightroom Classic SDK.

Must be called while the Develop module is active and current image is on Process Version 3 or above.

LrDevelopController.toggleOverlay()

Toggles the mask overlay.

Must be called when masking is active.

First supported in version 7.4 of the Lightroom SDK.

LrDevelopController.togglePointColorRangeVisualization( isForMasking )

Toggles the visualize range checkbox present in the Point Color panel.

First supported in version 13.2 of the Lightroom Classic SDK.

Parameters

1. isForMasking

(optional, boolean). Set to true when targeting the point colors in masking.

LrDevelopController.updateSelectedPointColorSwatch( colorSwatchTable, isForMasking )

Update selected Point Color Swatch.

Must be called while the Develop module is active and current image is on Process Version 3 or above.

First supported in version 13.2 of Lightroom Classic SDK.

Using this API, you can update the selected point color swatch.
To do that, one would need the selected color-swatch table that can be retrieved using the steps mentioned below.
Contents of the retrieved color-swatch table can be modified and then passed to this API for committing the change.

• Fetch the Point Color list using "LrDevelopController.getValue( pointColorKey )" where pointColorKey is "PointColors" for global point color and "local_PointColors" for local point color.
• Get the selected swatch/point-color index using "LrDevelopController.getSelectedPointColorSwatchIndex".
• Subscript the point color list using the selected swatch index to get the required color-swatch table. i.e., colorSwatchTable = pointColorList[ selectedSwatchIndex ]

Parameters

1. colorSwatchTable

(table). a table representing the color swatch. It should have the following fields.

• SrcHue: (number) Source color's hue value. Values from 0 to 6 are allowed.
• SrcSat: (number) Source color's saturation value. Values from 0 to 1 are allowed.
• SrcLum: (number) Source color's luminance value. Values from 0 to 1 are allowed.
• HueShift: (number) Hue shift. Values from -1 to 1 are allowed.
• SatScale: (number) Saturation shift. Values from -1 to 1 are allowed.
• LumScale: (number) Luminance shift. Values from -1 to 1 are allowed.
• RangeAmount: (number) Range amount. Values from 0 to 1 are allowed.
• HueRange: (table) Hue range.
• LowerNone: (number) outer left limit. Values from 0 to 1 are allowed.
• LowerFull: (number) inner left limit. Values from 0 to 1 are allowed.
• UpperFull: (number) inner right limit. Values from 0 to 1 are allowed.
• UpperNone: (number) outer right limit. Values from 0 to 1 are allowed.
• SatRange: (table) Saturation range. Follows same table format as HueRange above.
• LumRange: (table) Luminance range. Follows same table format as HueRange above.

2. isForMasking

( optional, boolean ). Set to true when targeting the point colors in masking.

Return value

( boolean, string ) - returns true if swatch is updated successfully. For failures, returns false and an error message.