add_imagebug
Requires Live Slicer version 19022000 or higher
Overlays an image on the live stream at the specified start time for the given duration.
Request body parameters are described below.
| Request Parameter | Type | Description |
|---|---|---|
| data Required | String | Defines the image that will be overlaid on the video. Key information: Set this parameter to the base-64-encoded value for a RGBA PNG image whose file size is 32 Kb or smaller. The image overlay effect respects the transparency defined in the PNG image. In order to match positioning information, it is strongly recommended that the specified PNG image match the resolution of the source video. If the resolution does not match, the image will be scaled to fit within the video's width or height. It will then be centered across the other axis. If multiple images overlap, then Z-order is determined by the order in which they are added to the stream. |
| duration | Integer | Defines the duration, in milliseconds, for which the image passed by the data parameter will be overlaid on the video. Omit this parameter or set it to 0 to overlay the image defined by the data parameter until it is removed. An image overlay will persist until one of the following conditions is true: The image overlay is removed via the remove_imagebug endpoint. The image overlay's duration has expired. |
| offset_from_now_ms | Integer | Requires Live Slicer version 17061500 or higher. Identifies a time relative to now (local system time), in milliseconds, when an operation will take effect. |
| offset_time_ms | Integer | Identifies a time relative to the start of the current asset, in milliseconds, when an operation will take effect. |
| start_timecode | String | Identifies the video frame at which this operation will take effect. |
A response body parameter is listed below.
| Response Parameter | Type | Description |
|---|---|---|
| id | String | Identifies an image overlay by its ID. Use the list_imagebug endpoint to retrieve a list of scheduled and currently active image overlays and their IDs. |
Sample request:
POST /add_imagebug HTTP/1.1
{
"data": "iVBORw0KGg ... U5Erkggg==",
"duration": 30000
}
Sample response:
{
"error": 0,
"id": "40312374433b78666162691020586f12"
}