Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 2.7 KB

InputSettingsOverlaySettings.md

File metadata and controls

39 lines (24 loc) · 2.7 KB
Raw

InputSettingsOverlaySettings

An object that describes how the image file referenced in URL should be placed over the video (i.e. watermarking). Ensure that the URL is active and persists the entire lifespan of the video object.

Properties

Name Type Description Notes
verticalAlign VerticalAlignEnum Where the vertical positioning of the overlay/watermark should begin from. Defaults to `"top"` [optional]
verticalMargin String The distance from the vertical_align starting point and the image's closest edge. Can be expressed as a percent ("10%") or as a pixel value ("100px"). Negative values will move the overlay offscreen. In the case of 'middle', a positive value will shift the overlay towards the bottom and and a negative value will shift it towards the top. [optional]
horizontalAlign HorizontalAlignEnum Where the horizontal positioning of the overlay/watermark should begin from. [optional]
horizontalMargin String The distance from the horizontal_align starting point and the image's closest edge. Can be expressed as a percent ("10%") or as a pixel value ("100px"). Negative values will move the overlay offscreen. In the case of 'center', a positive value will shift the image towards the right and and a negative value will shift it towards the left. [optional]
width String How wide the overlay should appear. Can be expressed as a percent ("10%") or as a pixel value ("100px"). If both width and height are left blank the width will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If height is supplied with no width, the width will scale proportionally to the height. [optional]
height String How tall the overlay should appear. Can be expressed as a percent ("10%") or as a pixel value ("100px"). If both width and height are left blank the height will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If width is supplied with no height, the height will scale proportionally to the width. [optional]
opacity String How opaque the overlay should appear, expressed as a percent. (Default 100%) [optional]

Enum: VerticalAlignEnum

Name Value
TOP "top"
MIDDLE "middle"
BOTTOM "bottom"

Enum: HorizontalAlignEnum

Name Value
LEFT "left"
CENTER "center"
RIGHT "right"