Class LrFilterContext

Provides access to the choices a user has made in the Export dialog, and the list of photos to be exported.

An LrFilterContext object is passed to your plug-in as a parameter to your service script's postProcessRenderedPhotos function. You cannot import the namespace or access the properties and functions in any other way.

Summary

filterContext:renditions( params )
Alias for filterContext.sourceExportSession:renditionsForFilter.
filterContext.propertyTable
(table) The property table containing the Export settings defined for your plug-in, along with any built-in Lightroom Export settings that you have not excluded.
filterContext.renditionsToSatisfy
(table) The list of renditions that have been requested by the next filter in the stack (or the final destination plug-in).
filterContext.sourceExportSession
(table) The export session which should be used to as the source of photo renditions for this filter (i.e.

Functions

filterContext:renditions( params )
Alias for filterContext.sourceExportSession:renditionsForFilter. (The plugin and renditionsToSatisfyarguments are provided automatically by this version of the function.)

Creates an iterator with which to walk an export filter's renditions-to-satisfy list. The iterator generates a rendition from this export session (that is, before the application of this filter) and matches it with the corresponding rendition to be satisfied by the filter.

First supported in version 2.0 of the Lightroom SDK.

For example:

 for sourceRendition, renditionToSatisfy in exportSession:renditions( args ) do
     -- (do something with rendition)
 end

Parameters

1. params
(table, optional) Arguments in named argument syntax.
  • plugin (optional, _PLUGIN object)
  • renditionsToSatisfy (optional, array of LrExportRendition): The list of renditions that this filter must satisfy.
  • filterSettings (optional, function): If present, this function can alter the export settings of the rendition. It is called with two arguments: the individual rendition to be satisfied, and a copy of its export settings that can be modified in place. It can optionally return a string, which will be used as the new path to the file.

See also

LrExportRendition, LrProgressScope

Properties

filterContext.propertyTable : (Read-Only)
(table) The property table containing the Export settings defined for your plug-in, along with any built-in Lightroom Export settings that you have not excluded. The settings have the values chosen by the user in the Export dialog.

First supported in version 2.0 of the Lightroom SDK.

filterContext.renditionsToSatisfy : (Read-Only)
(table) The list of renditions that have been requested by the next filter in the stack (or the final destination plug-in).

First supported in version 2.0 of the Lightroom SDK.

See also: LrExportSession
filterContext.sourceExportSession : (Read-Only)
(table) The export session which should be used to as the source of photo renditions for this filter (i.e. the original renditions or the results of the previous filter).

First supported in version 2.0 of the Lightroom SDK.

See also: LrExportSession