list_imagebug
Requires Live Slicer version 19022000 or higher
Provides a list of all scheduled and currently active image overlays.
Response body parameters are listed below.
| Response Parameter | Type | Description |
|---|---|---|
| bugs | List | A list of dictionaries that describes each scheduled and currently active image overlay. |
| duration | Integer | Indicates the duration, in milliseconds, for which the image overlay will be applied to the live stream. A value of 0 indicates that the image overlay will persist until it is removed. |
| start | Integer | Indicates the scheduled start time for the image overlay. For the purpose of this parameter, start time is defined as the number of milliseconds since the start of the live stream. If the image overlay was scheduled to appear immediately, then this parameter will report the live stream's time at the moment that the add_imagebug endpoint was requested. Example: If the image overlay is scheduled for 10 seconds from the start of the live stream, then this parameter would report 10000. |
| id | String | Identifies an image overlay by its ID. |
Sample request:
GET /list_imagebug HTTP/1.1
Sample response:
{
"bugs": [{
"duration": 30000,
"start": 39516608,
"id": "40312374433b78666162691020586f12"
}
],
"error": 0
}