Lightroom Classic SDK

https://lrc.mcor.dev
Admin
The Lightroom Classic SDK provides an application programming interface (API) for developers to...
Tokens:343,204
Snippets:3,050
Trust Score:4
Update:3 days ago
Show doc for...
Tokens:
Raw
### catalog:withWriteAccessDo usage example

Source: https://lrc.mcor.dev/modules/LrCatalog.html

A basic example showing how to call withWriteAccessDo to perform catalog operations.

```lua
 catalog:withWriteAccessDo( function( context )   
     -- do something that reads or writes catalog   
 end ) 
```

--------------------------------

### catalog:findPhotos simple example

Source: https://lrc.mcor.dev/modules/LrCatalog.html

A basic example of using catalog:findPhotos to search for photos with a specific rating.

```lua
 local foundPhotos = catalog:findPhotos {  
 		searchDesc = {  
 			criteria = "rating",  
 			operation = "==",  
 			value = 2,  
 		}  
 } 
```

--------------------------------

### LrTether.startTether()

Source: https://lrc.mcor.dev/modules/LrTether.html

Starts a tethered capture session. First supported in version 6.0 of the Lightroom SDK.

```APIDOC
## LrTether.startTether()

### Description
Starts a tethered capture session.

### Method
Function

### Signature
LrTether.startTether()

### Parameters
None

### Return Value
None

### Supported Since
Version 6.0 of the Lightroom SDK.
```

--------------------------------

### LrFileUtils.chooseUniqueFileName usage example

Source: https://lrc.mcor.dev/modules/LrFileUtils.html

Example of generating a unique filename to avoid overwriting existing files.

```lua
LrFileUtils.chooseUniqueFileName( "/MyDir/MyFile.jpg" )
```

--------------------------------

### catalog:findPhotos complex example

Source: https://lrc.mcor.dev/modules/LrCatalog.html

A complex example demonstrating the use of the combine parameter to search for photos based on multiple criteria, such as rating and capture time.

```lua
 local foundPhotos = catalog:findPhotos {  
 		sort = "captureTime",  
 		ascending = true,  
 		searchDesc = {  
 			{  
 				criteria = "rating",  
 				operation = ">=",  
 				value = 3,  
 			},  
 			{  
 				criteria = "captureTime",  
 				operation = "inLast",  
 				value = 90,  
 				value2 = 1,  
 				value_units = "days",  
 			},  
 			combine = "union",  
 		}  
 }  
```

--------------------------------

### LrSystemInfo.memSize()

Source: https://lrc.mcor.dev/modules/LrSystemInfo.html

Reports the amount of physical RAM installed on the host computer. Returns the size in bytes.

```APIDOC
## LrSystemInfo.memSize()

### Description
Reports the amount of physical RAM installed on the host computer.

### Method
Function call

### Endpoint
LrSystemInfo.memSize()

### Parameters
None

### Return Value
- (number) Size of physical memory in bytes.
```

--------------------------------

### photo:buildSmartPreview

Source: https://lrc.mcor.dev/modules/LrPhoto.html

Creates a smart preview for the photo. Does nothing for video. Must be called from within an asynchronous task started using LrTasks.

```APIDOC
## photo:buildSmartPreview()

### Description
Creates a smart preview for the photo. Does nothing for video. This function must be called from within an asynchronous task started using `LrTasks`. First supported in version 5.0 of the Lightroom SDK.

### Return value
(string) A string indicating the result: 'created' if a smart preview was built, 'existed' if a smart preview already existed, 'failed' if smart preview creation failed, e.g. when invoked on a video object.

```

--------------------------------

### LrTasks.startAsyncTask(func, optName)

Source: https://lrc.mcor.dev/modules/LrTasks.html

Starts a function as a cooperative task on Lightroom's main thread. If an error occurs, a standard error dialog is shown.

```APIDOC
## LrTasks.startAsyncTask(func, optName)

### Description
Start a function that will run as a cooperative task on Lightroom's main thread. If an error is thrown while this task is executing, shows a standard error dialog.

### Method
Function call

### Endpoint
LrTasks.startAsyncTask(func, optName)

### Parameters
- **func** (function) - Required - The function to start.
- **optName** (string, optional) - A name to assign to the task, for debugging only.

### Return Value
None

### Example
```lua
LrTasks.startAsyncTask(function() LrTasks.sleep(1) end, "MyTask")
```
```

--------------------------------

### catalog:getChildCollectionSets

Source: https://lrc.mcor.dev/modules/LrCatalog.html

Retrieves the top-level collection sets in this catalog. Does not get nested sets. Must be called from within an asynchronous task started using LrTasks. First supported in version 3.0 of the Lightroom SDK.

```APIDOC
## catalog:getChildCollectionSets()

### Description
Retrieves the top-level collection sets in this catalog. Does not get nested sets. This function must be called from within an asynchronous task started using LrTasks. First supported in version 3.0 of the Lightroom SDK.

### Return Value
(array of LrCollectionSet) The collection set objects.
```

--------------------------------

### Initialize and use LrSocket

Source: https://lrc.mcor.dev/modules/LrSocket.html

Demonstrates how to bind a socket in 'send' mode, handle connection events, send a message, and close the connection within an asynchronous task.

```lua
 local LrSocket = import "LrSocket"  
 local LrTasks = import "LrTasks"  
 import "LrTasks".startAsyncTask( function()  
 	 LrFunctionContext.callWithContext( 'socket_remote', function( context )  
 		 local running = true  
 		 local sender = LrSocket.bind {  
 			 functionContext = context,  
 			 port = 0, -- (let the OS assign the port)  
 			 mode = "send",  
 			 onConnecting = function( socket, port )  
 				 -- TODO  
 			 end,  
 			 onConnected = function( socket, port )  
 				 -- TODO  
 			 end,  
 			 onMessage = function( socket, message )  
 				 -- nothing, we don't expect to get any messages back from a send port  
 			 end,  
 			 onClosed = function( socket )  
 				 running = false  
 			 end,  
 			 onError = function( socket, err )  
 				 if err == "timeout" then  
 					 socket:reconnect()  
 				 end  
 			 end,  
 			 }  
 		 sender:send( "Hello world" )  
 		 while running do  
 			 LrTasks.sleep( 1/2 ) -- seconds  
 		 end  
 		 sender:close()  
 	 end )  
 end )
```

--------------------------------

### LrApplication.developPresetFolders()

Source: https://lrc.mcor.dev/modules/LrApplication.html

Retrieves all defined develop preset folders.

```APIDOC
## LrApplication.developPresetFolders()

### Description
Retrieves all defined develop preset folders.

### Method
Function

### Signature
LrApplication.developPresetFolders()

### Returns
- **Array of LrDevelopPresetFolder** - The list of preset folders.
```

--------------------------------

### LrDevelopController.startTracking

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Temporarily puts the Develop module into its tracking state.

```APIDOC
## LrDevelopController.startTracking( param )

### Description
Temporarily puts the Develop module into its tracking state, causing faster, lower-quality redraw and preventing history states from being generated.

### Parameters
- **param** (type not specified) - Required - The parameter to track.

### Returns
No return value documented.
```

--------------------------------

### LrPhoto:getMetadata

Source: https://lrc.mcor.dev/modules/LrPhoto.html

Retrieves a metadata item from a photo. Pass a key to get a specific field, or nil to get all available metadata fields.

```APIDOC
## LrPhoto:getMetadata

### Description
Retrieves a metadata item from a photo. Pass a key to get a specific field, or nil to get all available metadata fields.

### Parameters
- **key** (string) - Required - The metadata item to retrieve, or nil to get all available metadata fields.

### Return Values
- **fileSize** (number) - The size of the file in bytes, or, if the file is offline, but there is a smart preview, the size of the smart preview in bytes.
- **rating** (number) - The user rating of the file (either nil or number of stars).
- **dimensions** (table) - The original dimensions of file (for example, { width = 2304, height = 3072 } ).
- **croppedDimensions** (table) - The cropped dimensions of file (for example, { width = 2304, height = 3072 } ).
- **shutterSpeed** (number) - The shutter speed, in seconds (for example, 1/60 sec = 0.016666).
- **aperture** (number) - The denominator of the aperture (for example, 2.8).
- **exposureBias** (number) - The exposure bias/compensation (for example, -0.666666).
- **flash** (Boolean) - Whether flash fired or not (true = flash fired; false = flash did not fire; nil = unknown).
- **isoSpeedRating** (number) - The ISO speed rating (for example, 200).
- **focalLength** (number) - The focal length of lens as shot, in millimeters (for example, 132).
- **focalLength35mm** (number) - The focal length as 35mm equivalent, in millimeters (for example, 211.2).
- **dateTimeOriginal** (number) - The date and time of capture (seconds since midnight GMT January 1, 2001).
- **dateTimeDigitized** (number) - The date and time of scanning (seconds since midnight GMT January 1, 2001).
- **dateTime** (number) - The adjusted date and time (seconds since midnight GMT January 1, 2001).
- **gps** (table) - The location of this photo (for example, { latitude = 37.9362, longitude = 27.3451 } ).
- **gpsAltitude** (number) - The GPS altitude for this photo, in meters (for example, 82.317).
- **countVirtualCopies** (number) - The number of virtual copies of this photo. Zero if this photo is itself a virtual copy.
- **virtualCopies** (array of LrPhoto) - All virtual copies of this photo.
- **masterPhoto** (LrPhoto) - The master photo from which this virtual copy is derived.
- **isVirtualCopy** (Boolean) - True if this photo is a virtual copy of another photo.
- **countStackInFolderMembers** (number) - The number of the members of the stack that this photo is in.
- **stackInFolderMembers** (array of LrPhoto) - All members of the stack that this photo is in.
- **isInStackInFolder** (Boolean) - True if the photo is in a stack.
- **stackInFolderIsCollapsed** (Boolean) - True if the stack containing this photo is collapsed.
- **stackPositionInFolder** (number) - The position of this photo in the stack. The top of the stack is at position 1; other photos are numbered sequentially starting from 2.
- **topOfStackInFolderContainingPhoto** (LrPhoto) - The parent photo of the stack containing this photo.
- **colorNameForLabel** (string) - The color name corresponding to the color label associated with this photo. One of 'red', 'yellow', 'green', 'blue', 'purple', 'none'.

### Version 2.0 Fields
- **fileFormat** (string) - The format of the file. One of 'RAW', 'DNG', 'JPG', 'PSD', 'TIFF', or 'VIDEO'.
- **width** (number) - The width of the original source photo in pixels.
- **height** (number) - The height of the original source photo in pixels.
- **aspectRatio** (number) - The aspect ratio of the photo (defined as width / height). (For example, a standard 35mm photo in landscape mode returns 1.5.).
- **isCropped** (Boolean) - True if the photo has been cropped in Lightroom from its original dimensions.
- **dateTimeOriginalISO8601** (string) - The date and time of capture (ISO 8601 string format).
- **dateTimeDigitizedISO8601** (string) - The date and time of scanning (ISO 8601 string format).
- **dateTimeISO8601** (string) - The adjusted date and time (ISO 8601 string format).
- **lastEditTime** (number) - The date and time of the last edit to this photo (seconds since midnight GMT January 1, 2001).
- **editCount** (number) - Counter for edits on this photo. (Warning: This is not an absolute counter. Consecutive changes within a few seconds are counted as a single edit.)
- **copyrightState** (string) - The copyright state for this image. One of 'unknown', 'copyrighted', or 'public domain'.
```

--------------------------------

### LrFunctionContext.pcallWithEmptyEnvironment

Source: https://lrc.mcor.dev/modules/LrFunctionContext.html

Runs the main function in a known-safe function environment, catching any exceptions that occur.

```APIDOC
## LrFunctionContext.pcallWithEmptyEnvironment( func, ... )

### Description
Runs the main function in a known-safe function environment, catching any exceptions that occur.

### Parameters
- **func** (function) - Required - The main function to call.
- **...** (any) - Optional - Additional arguments passed to the main function.

### Returns
Returns a boolean indicating success and the result or error message.
```

--------------------------------

### LrFunctionContext.pcallWithEmptyEnvironment

Source: https://lrc.mcor.dev/modules/LrFunctionContext.html

Runs the main function in a known-safe function environment, catching any exceptions. Equivalent to setfenv(func, {}); return pcall(func, ...).

```APIDOC
## LrFunctionContext.pcallWithEmptyEnvironment

### Description
Runs the main function in a known-safe function environment, catching any exceptions that occur. Equivalent to `setfenv( func, {} ); return pcall( func, ... )`. The passed-in function is subjected to string.dump for safety reasons, so any variables declared in the scope of the calling function are not automatically passed through to the inner function. In particular, imported namespaces and classes do not carry through.

### Method
Function call

### Parameters
- **func** (function) - Required - The main function to call, with an empty environment.
- **...** (any) - Optional - Further arguments are passed through to the function.

### Return Values
1. (Boolean) True if the call succeeded, false if an error occurred.
2. (any) The call results; that is, whatever is returned from the main function.

### Notes
First supported in version 3.0 of the Lightroom SDK.
```

--------------------------------

### LrDevelopController.getAllMasks

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Get all masks.

```APIDOC
## LrDevelopController.getAllMasks()

### Description
Get all masks.

### Returns
- **unknown** - A list of all masks.
```

--------------------------------

### LrDevelopController.getSelectedMask

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Get selected mask.

```APIDOC
## LrDevelopController.getSelectedMask()

### Description
Get selected mask.

### Returns
- **unknown** - The selected mask.
```

--------------------------------

### photo:buildSmartPreview()

Source: https://lrc.mcor.dev/modules/LrPhoto.html

Creates a smart preview for the photo.

```APIDOC
## photo:buildSmartPreview()

### Description
Creates a smart preview for the photo.

### Method
buildSmartPreview

```

--------------------------------

### photo:getDevelopSnapshots()

Source: https://lrc.mcor.dev/modules/LrPhoto.html

Gets all the snapshots of the photo.

```APIDOC
## photo:getDevelopSnapshots()

### Description
Gets all the snapshots of the photo.

### Method
getDevelopSnapshots

```

--------------------------------

### photo:quickDevelopSetWhiteBalacne( value )

Source: https://lrc.mcor.dev/modules/LrPhoto.html

Sets the White Balance for the current photo. (Note: This method name appears to be a typo; see also quickDevelopSetWhiteBalance.)

```APIDOC
## photo:quickDevelopSetWhiteBalacne( value )

### Description
Sets the White Balance for the current photo. (Note: This method name appears to be a typo; see also quickDevelopSetWhiteBalance.)

### Method
quickDevelopSetWhiteBalacne

### Parameters
- **value** (type not specified) - Required - The white balance value to set.

```

--------------------------------

### LrDevelopController.getSelectedMaskTool

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Get selected mask tool.

```APIDOC
## LrDevelopController.getSelectedMaskTool()

### Description
Get selected mask tool.

### Returns
- **unknown** - The selected mask tool.
```

--------------------------------

### LrApplication.purchaseSource()

Source: https://lrc.mcor.dev/modules/LrApplication.html

Returns a string identifying the manner in which the Lightroom instance was obtained.

```APIDOC
## LrApplication.purchaseSource()

### Description
Returns a string identifying the manner in which the Lightroom instance was obtained.

### Method
Function

### Signature
LrApplication.purchaseSource()

### Returns
- **String** - The purchase source.
```

--------------------------------

### LrDevelopController.getAllSpots

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Get list of all spots on an image.

```APIDOC
## LrDevelopController.getAllSpots()

### Description
Get list of all spots on an image.

### Returns
- **unknown** - A list of all spots.
```

--------------------------------

### Accessing plug-in preferences with LrPrefs.prefsForPlugin

Source: https://lrc.mcor.dev/modules/LrPrefs.html

Shows how to import LrPrefs and set a preference value. Each plug-in has its own preferences namespace, so names do not conflict with other plug-ins.

```Lua
local prefs = import 'LrPrefs'.prefsForPlugin()   
prefs.userName = 'John Smith'
```

--------------------------------

### LrDevelopController.getSelectedLensBlurBokeh

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Get the selected Lens Blur Bokeh.

```APIDOC
## LrDevelopController.getSelectedLensBlurBokeh()

### Description
Get the selected Lens Blur Bokeh.

### Returns
- **unknown** - The selected Lens Blur Bokeh.
```

--------------------------------

### LrFunctionContext.pcallWithEnvironment

Source: https://lrc.mcor.dev/modules/LrFunctionContext.html

Runs the main function in a caller-provided function environment, catching any exceptions that occur.

```APIDOC
## LrFunctionContext.pcallWithEnvironment( func, env, ... )

### Description
Runs the main function in a caller-provided function environment, catching any exceptions that occur.

### Parameters
- **func** (function) - Required - The main function to call.
- **env** (table) - Required - The function environment to use.
- **...** (any) - Optional - Additional arguments passed to the main function.

### Returns
Returns a boolean indicating success and the result or error message.
```

--------------------------------

### LrDevelopController.getRemovePanelPreferences

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Get Remove panel UI preferences.

```APIDOC
## LrDevelopController.getRemovePanelPreferences()

### Description
Get Remove panel UI preferences.

### Returns
- **unknown** - The Remove panel UI preferences.
```

--------------------------------

### LrDevelopController.getActiveColorGradingView

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Get Active Color Grading View.

```APIDOC
## LrDevelopController.getActiveColorGradingView()

### Description
Get Active Color Grading View.

### Returns
- **unknown** - The active color grading view.
```

--------------------------------

### LrDevelopController.getValue

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

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

```APIDOC
## LrDevelopController.getValue( param )

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

### Parameters
- **param** (unknown) - Required - The parameter to get the value for.

### Returns
- **unknown** - The value of the adjustment.
```

--------------------------------

### photo:applyDevelopSettings( settings, optHistoryName, optFlattenAutoNow )

Source: https://lrc.mcor.dev/modules/LrPhoto.html

Applies develop settings to an image.

```APIDOC
## photo:applyDevelopSettings( settings, optHistoryName, optFlattenAutoNow )

### Description
Applies develop settings to an image.

### Method
applyDevelopSettings

### Parameters
- **settings** (type not specified) - Required - The develop settings to apply.
- **optHistoryName** (type not specified) - Optional - The history name for the operation.
- **optFlattenAutoNow** (type not specified) - Optional - Whether to flatten auto now.

```

--------------------------------

### LrDevelopController.getSelectedSpotType

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Get selected spot type in Remove tool.

```APIDOC
## LrDevelopController.getSelectedSpotType()

### Description
Get selected spot type in Remove tool.

### Returns
- **unknown** - The selected spot type.
```

--------------------------------

### logger:quickf( ... )

Source: https://lrc.mcor.dev/modules/LrLogger.html

Creates optimized versions of specified log functions for use in tight loops. Unlike logger:quick, these functions take string.format instructions.

```APIDOC
## logger:quickf( ... )

### Description
Creates optimized versions of specified log functions for use in tight loops. This version avoids the overhead of the method lookup, and is reduced to a no-op function when logging is disabled. Unlike the functions returned by logger:quick, these functions take string.format instructions.

### Method
logger:quickf

### Parameters
#### Arguments
- **...** (one or more strings) - Required - The names of log functions to optimize.

### Return Value
(one or more functions) The optimized functions.

### Supported Since
Version 2.0 of the Lightroom SDK.
```

--------------------------------

### LrDevelopController.getSelectedSpotParams

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Get selected spot params in Remove tool.

```APIDOC
## LrDevelopController.getSelectedSpotParams()

### Description
Get selected spot params in Remove tool.

### Returns
- **unknown** - The selected spot parameters.
```

--------------------------------

### LrDevelopController.getSelectedSpotIndex

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Get selected spot index in Remove tool.

```APIDOC
## LrDevelopController.getSelectedSpotIndex()

### Description
Get selected spot index in Remove tool.

### Returns
- **number** - The selected spot index.
```

--------------------------------

### LrFileUtils.createAllDirectories( path )

Source: https://lrc.mcor.dev/modules/LrFileUtils.html

Creates a directory at a given path, recursively creating any parent directories that do not already exist.

```APIDOC
## LrFileUtils.createAllDirectories( path )

### Description
Creates a directory at a given path, recursively creating any parent directories that do not already exist.

### Method
Function

### Signature
LrFileUtils.createAllDirectories( path )

### Parameters
- **path** (string) - Required - The path of the directory to create.
```

--------------------------------

### LrFileUtils.createAllDirectories(path)

Source: https://lrc.mcor.dev/modules/LrFileUtils.html

Creates a directory at a given path, recursively creating any parent directories that do not already exist.

```APIDOC
## LrFileUtils.createAllDirectories(path)

### Description
Creates a directory at a given path, recursively creating any parent directories that do not already exist.

### Parameters
- **path** (string) - Required - The path of the new directory.

### Return Values
1. (Boolean) True if there were no errors, false if there were errors creating directories in the path.
2. (string or Boolean) A string describing the error if there were errors creating directories; otherwise, true if one or more directories were created, or false if all the directories already existed.

### Supported Since
Version 1.3 of the Lightroom SDK.
```

--------------------------------

### LrDevelopController.getSelectedPointColorSwatchIndex

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Get selected Point Color Swatch Index.

```APIDOC
## LrDevelopController.getSelectedPointColorSwatchIndex( isForMasking )

### Description
Get selected Point Color Swatch Index.

### Parameters
- **isForMasking** (boolean) - Required - Indicates whether the swatch is for masking.

### Returns
- **number** - The selected swatch index.
```

--------------------------------

### Preference assignment examples

Source: https://lrc.mcor.dev/modules/LrPrefs.html

Illustrates different ways to assign preference values. Assigning a table directly is saved, but deep assignments may not be saved unless you reassign the table.

```Lua
prefs.mySetting = {}
```

```Lua
prefs.mySetting[ 44 ] = 'my value'
```

```Lua
prefs.mySetting = prefs.mySetting
```

--------------------------------

### LrDevelopController.getRange

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Gets the min and max value of a Develop adjustment.

```APIDOC
## LrDevelopController.getRange( param )

### Description
Gets the min and max value of a Develop adjustment.

### Parameters
- **param** (unknown) - Required - The parameter to get the range for.

### Returns
- **unknown** - The min and max values.
```

--------------------------------

### LrFunctionContext.pcallWithEnvironment

Source: https://lrc.mcor.dev/modules/LrFunctionContext.html

Runs the main function in a caller-provided function environment, catching any exceptions. Equivalent to setfenv(func, {}); return pcall(func, ...).

```APIDOC
## LrFunctionContext.pcallWithEnvironment

### Description
Runs the main function in a caller-provided function environment, catching any exceptions that occur. Equivalent to `setfenv( func, {} ); return pcall( func, ... )`. Variables declared in the scope of the calling function are NOT automatically passed through to the inner function. In particular, imported namespaces and classes do not carry through.

### Method
Function call

### Parameters
- **func** (function) - Required - The main function to call, with an empty environment.
- **env** (table) - Required - The function environment to use.
- **...** (any) - Optional - Further arguments are passed through to the function.

### Return Values
1. (Boolean) True if the call succeeded, false if an error occurred.
2. (any) The call results; that is, whatever is returned from the main function.

### Notes
First supported in version 3.0 of the Lightroom SDK.
```

--------------------------------

### exportContext:startRendering()

Source: https://lrc.mcor.dev/modules/LrExportContext.html

Starts the rendering process in a separate task.

```APIDOC
## exportContext:startRendering()

### Description
Starts the rendering process in a separate task.

### Parameters
None.

### Return value
None.
```

--------------------------------

### LrSystemInfo.summaryString()

Source: https://lrc.mcor.dev/modules/LrSystemInfo.html

Returns a summary of system information. Use only for reporting purposes; do not attempt to parse this string.

```APIDOC
## LrSystemInfo.summaryString()

### Description
Returns a summary of system information. Use only for reporting purposes. Do not attempt to parse this string.

### Method
Function call

### Endpoint
LrSystemInfo.summaryString()

### Parameters
None

### Return Value
- (string) A string description of the system information, such as "Microsoft Windows XP Professional Service Pack 3 (Build 2600) (x86)".
```

--------------------------------

### LrFileUtils.directoryEntries iteration

Source: https://lrc.mcor.dev/modules/LrFileUtils.html

Example of iterating through immediate children of a folder using a for loop.

```lua
for filePath in LrFileUtils.directoryEntries( pathToFolder ) do ... end
```

--------------------------------

### photo:quickDevelopAdjustWhiteBalance( settingName, amount )

Source: https://lrc.mcor.dev/modules/LrPhoto.html

Adjusts the White Balance parameters (Temperature or Tint) for the current photo.

```APIDOC
## photo:quickDevelopAdjustWhiteBalance( settingName, amount )

### Description
Adjusts the White Balance parameters (Temperature or Tint) for the current photo.

### Method
quickDevelopAdjustWhiteBalance

### Parameters
- **settingName** (type not specified) - Required - The name of the white balance setting (Temperature or Tint).
- **amount** (type not specified) - Required - The amount to adjust.

```

--------------------------------

### LrFileUtils.files iteration

Source: https://lrc.mcor.dev/modules/LrFileUtils.html

Example of iterating through files that are immediate children of a folder, skipping subdirectories.

```lua
for filePath in LrFileUtils.files( pathToFolder ) do ... end
```

--------------------------------

### logger:quickf usage

Source: https://lrc.mcor.dev/modules/LrLogger.html

Creates optimized log functions that support string.format instructions for formatted output in tight loops.

```lua
 local warnf, infof = logger:quickf( 'warn', 'info' )  
 warnf( 'something %s happened', 'bad' ) 
```

--------------------------------

### LrApplication.developPresetFolders()

Source: https://lrc.mcor.dev/modules/LrApplication.html

Retrieves all defined develop preset folders. First supported in version 3.0 of the Lightroom SDK.

```APIDOC
## LrApplication.developPresetFolders()

### Description
Retrieves all defined develop preset folders.

### Method
Function call

### Endpoint
LrApplication.developPresetFolders()

### Parameters
None

### Return Value
- **array of LrDevelopPresetFolder** - The preset folder objects.
```

--------------------------------

### LrHttp.get

Source: https://lrc.mcor.dev/modules/LrHttp.html

Retrieves data over the network using HTTP or HTTPS GET. Returns the response body and headers.

```APIDOC
## LrHttp.get

### Description
Retrieves data over the network using HTTP or HTTPS GET. First supported in version 1.3 of the Lightroom SDK.

### Method
GET

### Endpoint
Not applicable (SDK function)

### Parameters
- **url** (string) - Required - The URL to get.
- **headers** (table, optional) - A table of tables, one for each header. Each header table has a 'field' and a 'value' entry. Unless you specify a 'Content-Type' header, Lightroom will add such a header with a value of 'text/plain'. To force the omission of a 'Content-Type' header, specify a 'Content-Type' header with a value of 'skip'.
- **timeout** (number) - Required - The length of time (in seconds) to wait during each phase of the connection before canceling the request. This parameter will be ignored by Lightroom 1.3 and 1.4.

### Return Values
1. (string) The body of the HTTP response.
2. (table) A table of tables, one for each header. Each header table has a 'field' and a 'value' entry. The headers table contains the key "status" whose value is the HTTP status (an integer). Cookies are stored in a 'Set-Cookie' header; there can be multiple 'Set-Cookie' headers.

### See Also
LrHttp.parseCookie
```

--------------------------------

### LrDevelopController.getValue(param)

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Gets the value of a Develop adjustment for the current photo. Must be called while the Develop module is active.

```APIDOC
## LrDevelopController.getValue(param)

### Description
Gets the value of a Develop adjustment for the current photo. Must be called while the Develop module is active.

### Method
Function call

### Endpoint
LrDevelopController.getValue(param)

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

### Return Value
Not specified in the source.

### Supported Versions
First supported in version 6.0 of the Lightroom SDK.
```

--------------------------------

### LrApplicationView.fullscreenPreview()

Source: https://lrc.mcor.dev/modules/LrApplicationView.html

Changes the screen mode to Full Screen Preview.

```APIDOC
## LrApplicationView.fullscreenPreview()

### Description
Changes the screen mode to Full Screen Preview.

### Method
Function call

### Parameters
None

### Returns
None
```

--------------------------------

### LrDevelopController.getRemovePanelPreferences()

Source: https://lrc.mcor.dev/modules/LrDevelopController.html

Gets Remove panel UI preferences. First supported in version 14.1 of the Lightroom Classic SDK.

```APIDOC
## LrDevelopController.getRemovePanelPreferences()

### Description
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.
```

--------------------------------

### photo:quickDevelopSetWhiteBalance( value )

Source: https://lrc.mcor.dev/modules/LrPhoto.html

Sets the White Balance for the current photo.

```APIDOC
## photo:quickDevelopSetWhiteBalance( value )

### Description
Sets the White Balance for the current photo.

### Method
quickDevelopSetWhiteBalance

### Parameters
- **value** (type not specified) - Required - The white balance value to set.

```

--------------------------------

### photo:quickDevelopSetTreatment( value )

Source: https://lrc.mcor.dev/modules/LrPhoto.html

Sets the Treatment for the current photo.

```APIDOC
## photo:quickDevelopSetTreatment( value )

### Description
Sets the Treatment for the current photo.

### Method
quickDevelopSetTreatment

### Parameters
- **value** (type not specified) - Required - The treatment value to set.

```

--------------------------------

### photo:getRawMetadata

Source: https://lrc.mcor.dev/modules/LrPhoto.html

Retrieves unformatted metadata from this photo. Must be called from within a task started using LrTasks.

```APIDOC
## photo:getRawMetadata

### Description
Retrieves unformatted metadata from this photo. Must be called from within a task started using LrTasks.

### Method
Function call

### Endpoint
photo:getRawMetadata( key )

### Parameters
- key (string) - Required - The metadata key to retrieve.

### Return Value
(string or table) The formatted-string value of the specified metadata property, or nil if not applicable. If no key is specified, returns a table of all available metadata fields as key/value pairs.
```

--------------------------------

### keyword:getSynonyms()

Source: https://lrc.mcor.dev/modules/LrKeyword.html

Retrieves the synonyms for this keyword. Must be called from within an asynchronous task started using LrTasks.

```APIDOC
## keyword:getSynonyms()

### Description
Retrieves the synonyms for this keyword. Returns an array of strings.

### Method
Function

### Return Value
(array of string) The synonyms.

### Usage Requirements
Must be called from within an asynchronous task started using LrTasks.

### Supported Since
Lightroom SDK version 3.0
```

--------------------------------

### LrSystemInfo.appWindowSize()

Source: https://lrc.mcor.dev/modules/LrSystemInfo.html

Reports the size of the main Lightroom application window. Returns the width and height in pixels.

```APIDOC
## LrSystemInfo.appWindowSize()

### Description
Reports the size of the main Lightroom application window.

### Method
Function call

### Endpoint
LrSystemInfo.appWindowSize()

### Parameters
None

### Return Values
- (number) Width of Lightroom's main application window, in pixels
- (number) Height of Lightroom's main application window, in pixels
```

--------------------------------

### LrApplicationView.gridView()

Source: https://lrc.mcor.dev/modules/LrApplicationView.html

Opens Grid View.

```APIDOC
## LrApplicationView.gridView()

### Description
Opens Grid View.

### Method
Function call

### Parameters
None

### Returns
None
```

--------------------------------

### keyword:getPhotos()

Source: https://lrc.mcor.dev/modules/LrKeyword.html

Retrieves the photos that have this keyword. Must be called from within an asynchronous task started using LrTasks.

```APIDOC
## keyword:getPhotos()

### Description
Retrieves the photos that have this keyword. Returns an array of LrPhoto objects.

### Method
Function

### Return Value
(array of LrPhoto) The photo objects.

### Usage Requirements
Must be called from within an asynchronous task started using LrTasks.

### Supported Since
Lightroom SDK version 3.0
```

--------------------------------

### keyword:getParent()

Source: https://lrc.mcor.dev/modules/LrKeyword.html

Retrieves the parent of this keyword, if any. Must be called from within an asynchronous task started using LrTasks.

```APIDOC
## keyword:getParent()

### Description
Retrieves the parent of this keyword, if any. Returns the parent LrKeyword object, or nil if this is a top-level keyword.

### Method
Function

### Return Value
(LrKeyword) The parent keyword object, or nil if this is a top-level keyword.

### Usage Requirements
Must be called from within an asynchronous task started using LrTasks.

### Supported Since
Lightroom SDK version 3.0
```

--------------------------------

### LrApplication.filenamePresets()

Source: https://lrc.mcor.dev/modules/LrApplication.html

Reports available file-naming presets.

```APIDOC
## LrApplication.filenamePresets()

### Description
Reports available file-naming presets.

### Method
Function

### Signature
LrApplication.filenamePresets()

### Returns
- **Array** - The list of file-naming presets.
```

--------------------------------

### webViewFactory:panel_content( args )

Source: https://lrc.mcor.dev/modules/LrWebViewFactory.html

Creates a top-level Web-module panel.

```APIDOC
## webViewFactory:panel_content( args )

### Description
Creates a top-level Web-module panel.

### Method
Function

### Parameters
- **args** (table) - Required - Arguments for creating the panel.

### Returns
- **panel** (LrView) - The created panel.
```
Tokens:
Raw