Transformations
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. https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4340187164 are linked with one or more transformations, and for each transformation, an access representation is generated. See https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4010967327 for additional information.
Generated files
Kind | Usage | Cardinality | Metadata field | Example |
|---|---|---|---|---|
Access representations | Single file in an accessible common format such as JPG or PDF, that is natively supported by web browsers. | 1 for each transformation |
| |
Keyframes | High-resolution JPEG still images are used on the detail page in the application. | Per transformation; Multiple keyframes are present when the media type is a video, a document, or a multilayer image. |
| |
Thumbnails | Low-resolution JPEG still images are used on grid/list views in the application. | Per transformation; Multiple thumbnails are present when the media type is a video, a document, or a multilayer image. |
| |
Peak files | When audio is present there is for each stream/track a peak file representing the audio waveform. Conforms to the BBC audio waveform specification. | Per transformation; The number peak files equal the number of audio tracks/streams. | Not exposed as a metadata field but located in the same folder as the preview |
Properties
Property | Description | Since |
Name | The name of the transformation. |
|
ParentTransformationId | Used by https://mediahaven.atlassian.net/wiki/spaces/CS/pages/5313888282 to override this parent transformation by providing alternative properties. |
|
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 transformation will flip the image. |
|
Encoding.ColorSpace | The colour space of the transformation. |
|
Encoding.KeepColorSpace | Whether the transformed file keeps the colour space of the original. |
|
Encoding.Peak.BitRate | Advanced property; The quality of the waveform. Allowed values: 8 or 16, with 8 as default. |
|
Encoding.Peak.SampleRate | Advanced property; The number of bars per second to draw, typically 10. |
|
Custom transformations 24.4+
From version 24.4 it will be possible to request (additional) custom transformations for https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4064772158 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,
"Container": "jpg",
"Keyframe": {
"ThumbWidth": 500,
"ThumbHeight": 500
}
},
"PronomId": "fmt/43"
}Limits 25.2
For advanced installations, these limitations can have different (higher) values
The following limitations apply
Limit | Effect | Default Value |
|---|---|---|
Filesize | Missing access representation | 1 GB |
NumberOfPages | Missing access representation. Only applies to documents. | 1000 |