Introduction
TBC
Business Logic
...
General information
Property | Description | Engine Validation | Frontend validation | ||
|---|---|---|---|---|---|
Id | / | / | Not editable | ||
Name | / | / | / | ||
Unique folder | Whether each export to this location creates a unique subfolder for the export | Default true | Always disabled | ||
Http URL | The (internal) url on which the export will be accessible | Is a valid url | Error toast after save if invalid | ||
Export downloadable | Whether the result of the export can be downloaded If true, the export location will show up in MediaHaven under the download action. If false, the export locatino will show up in MediaHaven under the 'export to location' action | Readonly | Always disabled | ||
Export reasons required | Whether an export reason is required to initiate an export | / | / | ||
Custom export reason allowed | Whether a custom (free-text) reason is allowed in addition to the supplied list | Readonly | Always disabled | ||
Default export location | Whether the export location is the default export location | / | Always disabled since changing this can cause a lot of issues. If you really want to change it, you can still do so through the API | ||
Priority | / | Number between 1-4 | Number between 1-4 | ||
Storage Type | The type of storage. This is a Frontend only construct | / | Dropdown Cannot be changed after creation. | ||
Storage pool id | The id of the storage pool. | Required if server is not filled in. | Can only be filled in and is required if Storage Type: Storage Pool is selected Error toast on save if invalid id is provided. | ||
Server address | The server address | Required if storage pool id not filled in. Should be a valid url. | Can only be filled in and is required if Storage Type: Server is selected Error toast on save if invalid url is provided. | ||
Protocol | The server protocol. | Required if storage pool id not filled in. | Can only be selected and is required if Storage Type: Server is selected | ||
Port | The port of the server | > 0 | Can only be filled in if Storage Type: Server is selected | ||
Path | The server path | / | Can only be filled in if Storage Type: Server is selected | ||
Username | The server username. Filling it in will overwrite the existing value. | / | Can only be filled in if Storage Type: Server is selected | ||
Password | The server password. Filling it in will overwrite the existing value. | Required if username is filled in | Can only be filled in and is required if username is filled in | ||
Filename expression | Expression that will provide the filename of the export. You can make this very complex, but generally will be of the form:
Apostrophes included. | Should be a valid SpEL expression. | Error toast on save if an invalid expression is provided. | ||
Temporary path | The temporary location path. | / | / | ||
Temporary filename | The temporary filename + extension. | / | / |
Export image options
Property | Description | Engine Validation | Frontend validation |
|---|---|---|---|
Height | The height in pixels an exported image will have. If not defined, the original height will be used. | >=0 | 0 <= height <= 2147483647 |
Width | The width in pixels an exported image will have. If not defined, the original width will be used. | >=0 | 0 <= width<= 2147483647 |
Container | The export container format, defaults to JPG when transforming and not explicitly set. | / | Dropdown |
Color space | The color space of the export, defaults to sRGB when transforming and not explicitly set. | Dropdown | |
Rotation | The rotation of the image, in degrees | 0 <= rotation <= 360 | 0 <= rotation <= 360 |
Flip | Flip the image horizontal / vertical | / | Dropdown |
Cropping (top, bottom, left, right) | The offset to crop the image. | >= 0 | 0 <= offset<= 2147483647 |
Watermark source | The source of the watermark applied by the transformation. | Required if watermark is defined | Determines if watermark is defined |
Watermark scale | The scale of the watermark. | 0 <= scale <= 100 | Disabled unless source is filled in 0 <= scale <= 100 |
Watermark opacity | The opacity of the watermark. | 0 <= opacity <= 100 | Disabled unless source is filled in 0 <= opacity <= 100 |
Watermark position | The position of the watermark. | / | Disabled unless source is filled in Dropdown |
Export video options
Same as image, without colour space, rotation, flip and cropping and including:
Property | Description | Engine Validation | Frontend validation |
|---|---|---|---|
Height | The height in pixels an exported videowill have. If not defined, the original height will be used. | >=0 | 0 <= height <= 2147483647 |
Width | The width in pixels an exported video will have. If not defined, the original width will be used. | >=0 | 0 <= width<= 2147483647 |
Bitrate | The bitrate in bits per second an exported video will have. If not defined, the original bitrate will be used. | >= 0 | 0 <= bitrate<= 2147483647 |
Container | The export container format. If not defined, the original format will be used. | / | Dropdown |
Channels | The number of audio channels. | >= 0 | 0 <= channels<= 2147483647 |
Watermark source | The source of the watermark applied by the transformation. | Required if watermark is defined | Determines if watermark is defined |
Watermark scale | The scale of the watermark. | 0 <= scale <= 100 | Disabled unless source is filled in 0 <= scale <= 100 |
Watermark opacity | The opacity of the watermark. | 0 <= opacity <= 100 | Disabled unless source is filled in 0 <= opacity <= 100 |
Watermark position | The position of the watermark. | / | Disabled unless source is filled in Dropdown |
Export audio options
Property | Description | Engine Validation | Frontend validation |
|---|---|---|---|
Sample rate | The sample rate in hertz an exported audio file will have. If not defined, the original sample rate will be used. | >=0 | 0 <= rate<= 2147483647 |
Bitrate | The bitrate in bits per second an exported audio will have. If not defined, the original bitrate will be used. | >= 0 | 0 <= bitrate<= 2147483647 |
Container | The file format an exported audio-only file will have. Not applicable if file contains video as well. If not defined, the original format will be used. | / | Dropdown |
Export document options
Property | Description | Engine Validation | Frontend validation |
|---|---|---|---|
Height | The height in pixels an exported document will have. If not defined, the original height will be used. | >=0 | 0 <= height <= 2147483647 |
Width | The width in pixels an exported document will have. If not defined, the original width will be used. | >=0 | 0 <= width<= 2147483647 |
Container | The export container format, defaults to JPG when transforming and not explicitly set. | / | Dropdown |
Color space | The color space of the export, defaults to sRGB when transforming and not explicitly set. | Dropdown | |
Watermark source | The source of the watermark applied by the transformation. | Required if watermark is defined | Determines if watermark is defined |
Watermark scale | The scale of the watermark. | 0 <= scale <= 100 | Disabled unless source is filled in 0 <= scale <= 100 |
Watermark opacity | The opacity of the watermark. | 0 <= opacity <= 100 | Disabled unless source is filled in 0 <= opacity <= 100 |
Watermark position | The position of the watermark. | / | Disabled unless source is filled in Dropdown |
Export metadata options
Property | Description | Engine Validation | Frontend validation |
|---|---|---|---|
Type | If set, defines how record metadata is exported. | Dropdown | |
Format | The sidecar format | Only allowed and required when type: Sidecar | Hidden unless Type: Sidecar |
Only metadata | If true, only metadata will be exported. | Only allowed when type: Sidecar | Hidden unless Type: Sidecar |
Metadata translation id | The id of a metadata translation | Only allowed and required when type: Burn Must be a valid id | Hidden unless Type: Burn Error toast on save when invalid id is provided. |
User options
Property | Description | Engine Validation | Frontend validation |
|---|---|---|---|
Allowed for all users | Whether the export location is allowed for all users of own organisation. | / | |
Allowed for all organisations | Whether the export location is allowed for all users of own organisation. | / | / |
Explicitly assigned users | Users that have received explicit access to the export location. | / | Disabled if one of the above options is set |