Introduction
Transformations describe how files (formally: original representations) are transformed into a preview file (formally: access representation) by specifying properties such as width, height, bit rates, etc. Formats are linked with one or more transformations, and for each transformation, an access representation is generated. See Ingest 2.0 Configuration for additional information.
Properties
Property | Description |
Name | The name of the transformation. |
FormatPronomId | The target pronom for this transformation. |
ClusterGroups | The name of the cluster groups on which this transformation will be stored. |
Encoding.Width | The width of the transformation ( -1 to scale image based on height, keeping aspect ratio). |
Encoding.Height | The height of the transformation ( -1 to scale image based on width, keeping aspect ratio). |
Encoding.Container | Advanced option to configure the target file type. |
Encoding.Transformer | Advanced option to configure the specific converter used. |
Encoding.VideoBitrate | The video bitrate of the transformation. (Bit/s) |
Encoding.AudioBitrate | The audio bitrate of the transformation. (Bit/s) |
Encoding.AudioSamplerate | The audio sample rate of the transformation. (Hz) |
Encoding.AudioChannels | The audio channels of the transformation. |
Encoding.Cropping.Top | The top value of the cropping feature. |
Encoding.Cropping.Bottom | The bottom value of the cropping feature. |
Encoding.Cropping.Left | The left value of the cropping feature. |
Encoding.Cropping.Right | The right value of the cropping feature. |
Encoding.Watermark.Source | The source of the watermark applied by the transformation. |
Encoding.Watermark.Scale | The scale of the watermark on the image. |
Encoding.Watermark.Opacity | The opacity of the watermark on the image. |
Encoding.Watermark.Position | The position of the watermark on the image. |
Encoding.Keyframe.ThumbWidth | The width of the generated keyframe ( -1 to scale image based on height, keeping aspect ratio). |
Encoding.Keyframe.ThumbHeight | The height of the generated keyframe ( -1 to scale image based on width, keeping aspect ratio). |
Encoding.Rotate | the value for the tilt of the image after transformation (max 359). |
Encoding.Flip | How the image will be flipped by the transformation. |
Encoding.ColorSpace | The color space of the transformation. |
Encoding.KeepColorSpace | Whether the transformed file keeps the color space of the original. |
Custom transformations 24.4+
From version 24.4 it will be possible to request (additional) custom transformations for Data Objects using the REST API endpoint records/:recordId/browses → Link.
You will have to provide it with an encoding and the format pronom ID for example
{
"Encoding": {
"Width": 3000,
"Height": 3000,
"Keyframe": {
"ThumbWidth": 500,
"ThumbHeight": 500
}
},
"PronomId": "fmt/43"
}