Skip to main content

Image_overlay

NameTypeDescription
image_fileobjectDefines the location of the image file to be used.
xinteger
string
X position of the overlay. Can use expressions such as overlay_w-20 (overlay_w: width of the overlay). Default expression equals centered.
default: (video_w-overlay_w)/2
yinteger
string
Y position of the overlay. Can use expressions such as overlay_h-20 (overlay_h: height of the overlay).
default: 25
widthnumber
string
Width of the overlay. Can use expressions such as source_w (width of the image source).
heightnumber
string
Height of the overlay. Can use expressions such as source_h (height of the image source).
opacitynumber
Opacity of the overlay image. 0 = fully transparent, 1= fully opaque.
default: 1
start_secnumber
Start point (in seconds) of the overlay.
duration_secnumber
Duration (in seconds) of the overlay.
fadein_duration_secnumber
Fade-in time (in seconds) of the overlay.
fadeout_duration_secnumber
Fade-out time (in seconds) of the overlay.

Example image_overlay

{
"uid": "transcode_media",
"kind": "transcode",
"payload": {
"location": {
},
"targets": [
{
"file_pattern": "{source_basename}_converted.mp4",
"container": {
"kind": "mp4"
},
"video": {
"codec": "h264",
"filters": [
{
"kind": "image_overlay",
"payload": {
"image_file": {
"storage_provider": "s3",
"url": "s3://my_bucket/my_input_folder/my_file.png"
},
"x": "overlay_w - 20",
"y": 0,
"height": "source_h / 2",
"opacity": 0.75,
"start_sec": 5,
"fadein_duration_sec": 10,
"duration_sec": 30
}
}
]
},
"audio": [
{
}
]
}
]
}
}