Class LrExportRendition

Summary

Functions

exportRendition:recordPublishedPhotoId( publishedId )

Records the unique identifier assigned to a photo published via this service. Use only when publishing. A publish service must make this call to inform Lightroom that the photo has been successfully published. The call moves the photo from "New photos to publish" or "Modified photos to re-publish" to the "Published photos" section of the Library grid, assuming no further changes to the photo have been made by the user since the publish operation was initiated.

First supported in version 3.0 of the Lightroom SDK.

Parameters

1. publishedId

(string or number) The unique ID for the photo. assigned by the service.

exportRendition:recordPublishedPhotoUrl( publishedUrl )

Records the URL assigned to photo published via this service. Use only when publishing. A publish services can make this call to inform Lightroom where the photo can be found online. The call does not affect whether the photo is flagged to be published. This call must follow the first call to recordPublishedPhotoId().

First supported in version 3.0 of the Lightroom SDK.

Parameters

1. publishedUrl

(string) The URL for the photo, assigned by the service

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) An informative message suitable for display if the operation was not successful.

exportRendition:skipRender()

Causes the export task to skip this rendition. The rendition still appears in the exportSession:renditions() loop, but the file is not rendered. Check exportRendition.wasSkipped to determine if the rendition was skipped.

Must be called before the export session starts its rendering loop.

First supported in version 3.0 of the Lightrooom SDK.

exportRendition:type()

Reports the type of this object.

First supported in version 4.1 of the Lightroom SDK.

Return value

(string) 'LrExportRendition'.

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. Exception: if you previously called skipRender() for this render, this call will return immediately with true, but the file will not be present.

First supported in version 1.3 of the Lightroom SDK.

Return values

1. (Boolean) True if rendering was successful.
2. (string) The path to the photo if successful, or an informative message suitable for display if the operation was not successful.

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

exportRendition.publishedPhotoId : (Read-Only)

(string or number) If this export session is for publishing and this photo has been previously published, returns the unique identifier that was provided by the published service.

First supported in version 3.0 of the Lightroom SDK.

exportRendition.wasSkipped : (Read-Only)

(Boolean) True if this rendition was skipped.

First supported in version 3.0 of the Lightrooom SDK.