Namespace LrSystemInfo
This namespace allows you to gather information about the user's computer and operating system.
Access the functions directly from the imported namespace.
Summary
Reports the size of the main Lightroom application window.
Reports the CPU architecture of the host computer.
Reports information about the displays available to the system.
Retrieves the IP address of the system running Lightroom.
Reports whether the host is running a 64-bit operating system.
Reports whether GC Optimization is enabled or not.
Reports whether Sync is enabeld or not.
Reports the amount of physical RAM installed on the host computer.
Reports the number of CPUs on the host computer system.
Reports the version of the current operating system.
Returns a summary of system information.
Functions
- LrSystemInfo.appWindowSize()
-
Reports the size of the main Lightroom application window.
Return values
- (number) Width of Lightroom's main application window, in pixels
- (number) Height of Lightroom's main application window, in pixels
- LrSystemInfo.architecture()
-
Reports the CPU architecture of the host computer.
Return value
(string) System architecture, one of 'x86', 'x64', 'ppc', or 'ppc64'. - LrSystemInfo.displayInfo()
-
Reports information about the displays available to the system.
Return value
(table) An array of tables, one per display, each with these entries:- width (number) Width of the display in pixels.
- height (number) Height of the display in pixels.
- isMain (Boolean) True if the display is the main system display.
- hasAppMain (Boolean) True if the main Lightroom window is currently hosted on the display.
- LrSystemInfo.ipAddress()
-
Retrieves the IP address of the system running Lightroom.
First supported in version 6.0 of the Lightroom SDK.
Return value
(string) The IP address. - LrSystemInfo.is64Bit()
-
Reports whether the host is running a 64-bit operating system.
Return value
(Boolean) True if on 64-bit OS; false otherwise - LrSystemInfo.isGCOptimizationEnabled()
-
Reports whether GC Optimization is enabled or not.
Return value
(Boolean) True if GC Optimization is enabled; false if GC Optimization is disabled. - LrSystemInfo.isSyncEnabled()
-
Reports whether Sync is enabeld or not.
Return value
(Boolean) True if sync is enabled; false if sync is disabled or paused. - LrSystemInfo.memSize()
-
Reports the amount of physical RAM installed on the host computer.
Return value
(number) Size of physical memory in bytes. - LrSystemInfo.numCPUs()
-
Reports the number of CPUs on the host computer system. Typically counts each core on a multi-core system.
Return value
(number) Number of CPUs or CPU cores. - LrSystemInfo.osVersion()
-
Reports the version of the current operating system. Use only for reporting purposes. Do not attempt to parse this string.
Return value
(string) A string description of the OS version, such as "Microsoft Windows XP Professional Service Pack 3 (Build 2600)". - LrSystemInfo.summaryString()
-
Returns a summary of system information. Use only for reporting purposes. Do not attempt to parse this string.
Return value
(string) A string description of the system information, such as "Microsoft Windows XP Professional Service Pack 3 (Build 2600) (x86)".
