Class LightroomSdk

constructor

• new LightroomSdk(args?: { client?: Client; key?: string }): LightroomSdk

  Parameters

  • Optionalargs: { client?: Client; key?: string }

  Returns LightroomSdk

Static Readonly__registry

applyAutoTone

• applyAutoTone<ThrowOnError extends boolean = false>(
      options: Options<ApplyAutoToneData, ThrowOnError>,
  ): RequestResult<
      ApplyAutoToneResponses,
      ApplyAutoToneErrors,
      ThrowOnError,
      "fields",
  >

  Auto-tone

  Automatically correct exposure, contrast, sharpness, and saturation on an image.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ApplyAutoToneData, ThrowOnError>

  Returns RequestResult<
      ApplyAutoToneResponses,
      ApplyAutoToneErrors,
      ThrowOnError,
      "fields",
  >

applyEdits

• applyEdits<ThrowOnError extends boolean = false>(
      options: Options<ApplyEditsData, ThrowOnError>,
  ): RequestResult<
      ApplyEditsResponses,
      ApplyEditsErrors,
      ThrowOnError,
      "fields",
  >

  Apply Lightroom edits

  Apply one or more Lightroom edits (exposure, contrast, sharpness, saturation) to an image.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ApplyEditsData, ThrowOnError>

  Returns RequestResult<ApplyEditsResponses, ApplyEditsErrors, ThrowOnError, "fields">

applyPreset

• applyPreset<ThrowOnError extends boolean = false>(
      options: Options<ApplyPresetData, ThrowOnError>,
  ): RequestResult<
      ApplyPresetResponses,
      ApplyPresetErrors,
      ThrowOnError,
      "fields",
  >

  Apply Lightroom presets

  Apply one or more XMP Lightroom presets to the given image, by using the given preset XMP file(s).

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ApplyPresetData, ThrowOnError>

  Returns RequestResult<ApplyPresetResponses, ApplyPresetErrors, ThrowOnError, "fields">

applyPresetFromXmpContent

• applyPresetFromXmpContent<ThrowOnError extends boolean = false>(
      options: Options<ApplyPresetFromXmpContentData, ThrowOnError>,
  ): RequestResult<
      ApplyPresetFromXmpContentResponses,
      ApplyPresetFromXmpContentErrors,
      ThrowOnError,
      "fields",
  >

  Add XMP to image

  Apply XMP-based Lightroom preset to an image. XMP content is passed inline to the API.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ApplyPresetFromXmpContentData, ThrowOnError>

  Returns RequestResult<
      ApplyPresetFromXmpContentResponses,
      ApplyPresetFromXmpContentErrors,
      ThrowOnError,
      "fields",
  >

autoStraightenImage

• autoStraightenImage<ThrowOnError extends boolean = false>(
      options: Options<AutoStraightenImageData, ThrowOnError>,
  ): RequestResult<
      AutoStraightenImageResponses,
      AutoStraightenImageErrors,
      ThrowOnError,
      "fields",
  >

  Auto-straighten

  Auto-straighten an image by applying the Auto Upright transformation.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<AutoStraightenImageData, ThrowOnError>

  Returns RequestResult<
      AutoStraightenImageResponses,
      AutoStraightenImageErrors,
      ThrowOnError,
      "fields",
  >

lrJobStatus

• lrJobStatus<ThrowOnError extends boolean = false>(
      options: Options<LrJobStatusData, ThrowOnError>,
  ): RequestResult<LrJobStatusResponses, unknown, ThrowOnError, "fields">

  Get status

  Get job status of a Lightroom job.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<LrJobStatusData, ThrowOnError>

  Returns RequestResult<LrJobStatusResponses, unknown, ThrowOnError, "fields">