Common Output Format Settings
The following output format settings are available for all file types.Â
Property | Description |
sourceOutputFormats | Which output format should be used as a source for rendering. This allows you to render small thumbnails from formats other than the original to save rendering power and time. See Rendering Chain for details. |
format | This is information about the technical format for the output e.g. JPEG, AAC, or video still. |
names | The language-specific names that Picturepark displays in the format selection dialogue. |
retentionTime | A setting used for dynamic formats, which defines how long the dynamic outputs created from this format are kept. |
downloadFileNamePatterns | The optional patterns (liquid syntax) that produce the filename for an item of this output format. If set, the customer's default language is required. |
viewForAll | This permission indicates if outputs derived from the original output format should be accessible also for users not having AccessOriginal permission on the content, without this permission output formats derived from the Original will require access to the Original. |
enableXmpWriteback | This will allow us to write metadata values from Picturepark into the XMP header of outputs where applicable and configured. To enable writeback for the original, you have to use copyFormat to create a copy of the original and then writeback to this copy. |
id | Output format ID, which must be unique among output formats. Supported are alphanumeric, uppercase, and lowercase, and dash. It is recommended to use something similar to the name and does not start with numbers. For creation ID must be set, for update it cannot be changed. |
system | Marks if this is a system output format, which is required for Picturepark e.g. thumbnails. This is a read-only property. |
dynamic | A dynamic output format is not rendered automatically, but only on demand and only available in a single download. Dynamic formats are not backed up. |
dataExtraction | Specifies the output format used to create transfer thumbnails, only for not imported items. This is a read-only property. |
temporary | Temporary outputs will not be backed up and are mainly used in the Rendering chain. See Rendering Chain for details. Temporary formats are not available for download in Frontend or accessible via API. |