Publish output format
The output format is an array of Poster objects each describing an individual poster:
[
{
"cropRectangle": {
"x": 727.8592,
"y": 93.74,
"top": 93.74,
"left": 727.8592,
"bottom": 607.0863999999999,
"right": 1933.7216,
"width": 1205.8624,
"height": 513.3463999999999,
"sourceWidth": 2048,
"sourceHeight": 872
},
"resolution": {
"width": 2048,
"height": 872
},
"frame": {
"frame": 15622,
"numerator": 24,
"denominator": 1
},
"metadata": [
{
"key": "label",
"value": ""
},
{
"key": "destination_format",
"value": "jpeg"
}
]
}
]
Poster
Key | Type | Description |
---|---|---|
cropRectangle | object | Crop Rectangle object containing crop information |
resolution | object | Resolution object containing the width and height of the poster |
frame | object | Frame object containing information about the time code of the poster |
metadata | array | Array of Metadata objects, describing additional form data |
imageBase64 | string | The preview poster image in base64 format This property is only included if endpoints.publish.includePreviewImageData is enabled in the Launch Template |
Crop Rectangle
This objects describes the cropping area of the source image.
The left
, top
, right
, bottom
, x
, y
, width
, and height
properties describe the position and size of the overall rectangle in pixels.
Properties other than width and height are relative to the top-left of the source image.
Key | Type | Description |
---|---|---|
x | number | The x coordinate of the crop rectangle's origin |
y | number | The y coordinate of the crop rectangle's origin |
top | number | The top coordinate value of the crop rectangle |
left | number | The left coordinate value of the crop rectangle |
bottom | number | The bottom coordinate value of the crop rectangle |
right | number | The right coordinate value of the crop rectangle |
width | number | The width of the crop rectangle |
height | number | The height of the crop rectangle |
sourceWidth | number | The width of the source image |
sourceHeight | number | The height of the source image |
Resolution
Key | Type | Description |
---|---|---|
width | number | The width of the poster in pixels |
height | number | The height of the poster in pixels |
Frame
Key | Type | Description |
---|---|---|
frame | number | The frame the poster was taken from |
numerator | number | The frame time base numerator |
denominator | number | The frame time base denominator |
Metadata
Key | Type | Description |
---|---|---|
key | string | the metadata key |
value | string | the value |
The possible metadata keys are:
Metadata Key | Description |
---|---|
label | The label of the poster |
destination_format | The destination image format |