Class LrVideoExportPreset

An object of this class represents a single video export preset. Use such instances to identify names of video export presets, as well as the string used to represent each video export preset in export settings (export_videoPreset property).

Objects of this type are returned by LrExportSettings.videoExportPresets

Summary

videoExportPreset:extension()
This function returns the target extension for the video format associated with this video export preset.
videoExportPreset:formatID()
This function returns the identifier of the format corresponding to this video export preset.
videoExportPreset:name()
This function returns the name of the video export preset.
videoExportPreset:presetPath()
For a preset provided by a plug-in, this function returns the path to the preset file associated with this video export preset.
videoExportPreset:targetInfo()
This function returns the string which appears in the 'Target' information of the Video section in the Export Dialog when this video export preset is selected.
videoExportPreset:type()
Reports the type of this object.

Functions

videoExportPreset:extension()
This function returns the target extension for the video format associated with this video export preset.

First supported in version 4.0 of the Lightroom SDK.

Return value

(string) The extension.
videoExportPreset:formatID()
This function returns the identifier of the format corresponding to this video export preset.

First supported in version 4.0 of the Lightroom SDK.

Return value

(string) The identifier of the video format this video export preset represents.
videoExportPreset:name()
This function returns the name of the video export preset.

First supported in version 4.0 of the Lightroom SDK.

Return value

(string) The name of the video export preset.
videoExportPreset:presetPath()
For a preset provided by a plug-in, this function returns the path to the preset file associated with this video export preset. For any of the default presets, this function will return nil.

First supported in version 4.0 of the Lightroom SDK.

Return value

(string) The preset path.
videoExportPreset:targetInfo()
This function returns the string which appears in the 'Target' information of the Video section in the Export Dialog when this video export preset is selected. In the case of custom video export preset, this is the string supplied for 'targetInfo' when the preset was added via the LrExportSettings.addVideoExportPresets API. Note that for some of the default (built-in) presets, the target info is generated dynamically based on certain properties of the source video. For such presets, this function returns nil.

First supported in version 4.0 of the Lightroom SDK.

Return value

(string) The target information for this preset.
videoExportPreset:type()
Reports the type of this object.

First supported in version 4.1 of the Lightroom SDK.

Return value

(string) 'LrVideoExportPreset'.