Class LrExportRendition
An object of this class represents a single rendition operation, undertaken during an export operation. The end result of a rendition operation is a rendered photo; that is, the image data written in the format and with the settings specified for the export session
Rendition objects are created by the LrExportSession object; you cannot create them. Use the function exportSession:renditions() to access these objects.
Summary
exportRendition:renditionIsDone( success, message )
Notifies Lightroom that an export filter provider has completed the filtered rendering.
exportRendition:uploadFailed( message )
Signals an upload failure for this rendition.
Causes the export task to yield time to other tasks until this rendition has been fully generated.
(string) The absolute path to the rendered photo.
(
LrPhoto) The photo to be rendered in this operation.Functions
- exportRendition:renditionIsDone( success, message )
-
Notifies Lightroom that an export filter provider has completed the filtered rendering.
First supported in version 2.0 of the Lightroom SDK.
Parameters
- 1. success
- (Boolean) true if rendering was successful
- 2. message
- (string) message to display if not successful (should be a localized string)
- exportRendition:uploadFailed( message )
-
Signals an upload failure for this rendition.
First supported in version 2.0 of the Lightroom SDK.
Parameters
- 1. message
- (string) The failure message.
- exportRendition:waitForRender()
-
Causes the export task to yield time to other tasks until this rendition has been fully generated. This function does not return until the rendition operation is finished and a file has been written to the destination path. During this time, other parts of Lightroom can proceed.
First supported in version 1.3 of the Lightroom SDK.
Properties
- exportRendition.destinationPath : (Read-Only)
-
(string) The absolute path to the rendered photo. The file may not yet exist at this path if the render operation has not yet completed.
First supported in version 1.3 of the Lightroom SDK.
- exportRendition.photo : (Read-Only)
-
(
LrPhoto) The photo to be rendered in this operation.First supported in version 1.3 of the Lightroom SDK.
See also: LrPhoto