20 December 2012
about 12 years ago by Encoding.com Product Team
Text Overlay
<?xml version="1.0"?>
<query>
<userid><<id>></userid> <!-- required-->
<userkey><<key>></userkey> <!-- required-->
<action>[Action]</action> <!-- required-->
<format>
<!-- Format fields -->
<text_overlay>
<text>[Font1Source]</text>
<font_source>[Font1Source]</font_source>
<font_size>[Font1Size]</font_size>
<font_rotate>[Font1Rotate]</font_rotate>
<font_color>[Font1Color]</font_color>
<align_center>[0|1]</align_center>
<overlay_x>[TextOverlay1PositionX]</overlay_x>
<overlay_y>[TextOverlay1PositionY]</overlay_y>
<size>[TextOverlay1Size]</size>
<overlay_start>[TextOverlay1StartInSeconds]</overlay_start>
<overlay_duration>[TextOverlay1DurationInSeconds]</overlay_duration>
</text_overlay>
<!-- ... -->
<text_overlay>
<text>[FontNSource]</text>
<font_source>[FontNSource]</font_source>
<font_size>[FontNSize]</font_size>
<font_rotate>[FontNRotate]</font_rotate>
<font_color>[FontNColor]</font_color>
<align_center>[0|1]</align_center>
<overlay_x>[TextOverlayNPositionX]</overlay_x>
<overlay_y>[TextOverlayNPositionY]</overlay_y>
<size>[TextOverlayNSize]</size>
<overlay_start>[TextOverlayNStartInSeconds]</overlay_start>
<overlay_duration>[TextOverlayNDurationInSeconds]</overlay_duration>
</text_overlay>
</format>
</query>
{
"query": {
"userid": "<<id>>",
"userkey": "<<key>>",
"action": "[Action]",
"format": {
"text_overlay": [
{
"text": "[Font1Source]",
"font_source": "[Font1Source]",
"font_size": "[Font1Size]",
"font_rotate": "[Font1Rotate]",
"font_color": "[Font1Color]",
"align_center": "[0|1]",
"overlay_x": "[TextOverlay1PositionX]",
"overlay_y": "[TextOverlay1PositionY]",
"size": "[TextOverlay1Size]",
"overlay_start": "[TextOverlay1StartInSeconds]",
"overlay_duration": "[TextOverlay1DurationInSeconds]"
},
{
"text": "[FontNSource]",
"font_source": "[FontNSource]",
"font_size": "[FontNSize]",
"font_rotate": "[FontNRotate]",
"font_color": "[FontNColor]",
"align_center": "[0|1]",
"overlay_x": "[TextOverlayNPositionX]",
"overlay_y": "[TextOverlayNPositionY]",
"size": "[TextOverlayNSize]",
"overlay_start": "[TextOverlayNStartInSeconds]",
"overlay_duration": "[TextOverlayNDurationInSeconds]"
}
]
}
}
}
Format Name | Description | Allowed Values | Default Values |
---|---|---|---|
(required)text Text for overlay | Valid url | None | |
(required)font_source Font's source URL | Valid url | None | |
font_size Text font's size | non-negative integer | 20 | |
font_rotate Angle on which text should be rotated | integer | 0 | |
font_color Font color | 6-digits hexadecimal 000000-FFFFFF | 000000 | |
align_center Align text by center | 0 or 1 | 0 | |
overlay_x Overlay's position X | non-negative integer | 0 | |
overlay_y Overlay's position Y | non-negative integer | 0 | |
size Size of the text block | WxH where W and H - positive integers | None | |
overlay_start Overlay's start time (in seconds) | positive float value | 0 | |
overlay_duration Overlay's duration (in seconds) | positive float value | None |
Time Offset For Closed Captions
<?xml version="1.0"?>
<query>
<userid><<id>></userid> <!-- required-->
<userkey><<key>></userkey> <!-- required-->
<action>[Action]</action> <!-- required-->
<format>
<!-- Format fields -->
<closed_captions>
<!-- ... -->
<time_offset>[TimeOffset]</time_offset>
</closed_captions>
</format>
</query>
{
"query": {
"userid": "<<id>>",
"userkey": "<<key>>",
"action": "[Action]",
"format": {
"closed_captions": {
"time_offset": "[TimeOffset]"
}
}
}
}
Format Name | Description | Allowed Values | Default Values |
---|---|---|---|
time_offset Set time offset for time in CC file | positive or negative integer | 0 |
Sydney Region Support
<?xml version="1.0"?>
<query>
<userid><<id>></userid> <!-- required-->
<userkey><<key>></userkey> <!-- required-->
<action>[Action]</action> <!-- required-->
<region>ap-southeast-2</region>
<format>
<!-- Format fields -->
</format>
</query>
{
"query": {
"userid": "<<id>>",
"userkey": "<<key>>",
"action": "[Action]",
"region": "ap-southeast-2",
"format": {}
}
}
Format Name | Description | Allowed Values | Default Values |
---|---|---|---|
region | Allow you to specify instance's region where your file should be processed | ap-southeast-2 - Asia Pacific (Sydney), | us-east-1 |