Namespace LrTether

This namespace provides control over tethered shooting.

Access the functions directly from the imported namespace.

Summary

Returns boolean indicating whether or not each new tethered capture photo is selected.
Returns boolean indicating if a tethered capture session is running.
Returns the number of photos currently being downloaded from the tethered camera.
Sets the preference controlling whether or not each new tethered capture photo is selected.
Starts a tethered capture session.
Stops a tethered capture session.
Triggers a tethered capture.
Triggers a tethered capture, blocking until finished.

Functions

LrTether.getAdvanceSelectionOnTetheredCapture()
Returns boolean indicating whether or not each new tethered capture photo is selected.

First supported in version 6.0 of the Lightroom SDK.

Return value

(boolean) The advance selection preference.
LrTether.isTetherActive()
Returns boolean indicating if a tethered capture session is running.

First supported in version 6.0 of the Lightroom SDK.

Return value

(boolean) True if tethered capture is active.
LrTether.numDownloadsPending()
Returns the number of photos currently being downloaded from the tethered camera.

First supported in version 6.0 of the Lightroom SDK.

Return value

(number) The number of photos currently being downloaded from a tethered capture.
LrTether.setAdvanceSelectionOnTetheredCapture( advance )
Sets the preference controlling whether or not each new tethered capture photo is selected.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. advance
(boolean) New value for the advance selection preference.
LrTether.startTether()
Starts a tethered capture session.

First supported in version 6.0 of the Lightroom SDK.

LrTether.stopTether()
Stops a tethered capture session.

First supported in version 6.1 of the Lightroom SDK.

LrTether.triggerCapture()
Triggers a tethered capture. Does nothing if a tether session is not active.

First supported in version 6.0 of the Lightroom SDK.

LrTether.triggerCaptureBlocking()
Triggers a tethered capture, blocking until finished.

This function must be called from within an asynchronous task started using LrTasks.

First supported in version 6.0 of the Lightroom SDK.

Return value

(boolean) True if capture was successful, false if a problem occurred.