TBA
Reference
Embedlinkdelivery deliverembedformat
GET/v5/deliverEmbed/:link/:format
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| format | string | ✗ | embedformat to deliver allowed values: iframeurloembedoembed.xmljson |
| link | string | ✓ | Link to deliver embedformat for |
| refresh | boolean | ✗ | If true, data is not used from cache. |
| title | string | ✗ | optional title of the format as query parameter |
Embedlinkdelivery deliversubtitles
GET/v5/deliverEmbed/:link/subtitle/:id
Returns webvtt captions for a given embedlink (player link) and subtitle id. This function is used by the player! If you send hls = true, the response will be a list with URIs for the different segments. The player will make the call with the appropriate segment to get the WebVTT captions.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| format | string | ✗ | subtitle format to deliver allowed values: jsonwebvtthtml5srtssaassdfxpttmltimedTextvtt |
| hls | boolean | ✗ | If true, HLS subtitles will be delivered |
| i | string | ✗ | Identifier for public areas |
| id | integer | ✓ | ID of the subtitle to deliver |
| link | string | ✓ | Link of embedlink to deliver subtitles for |
| mpr | string | ✗ | Identifier for authentication |
| refresh | boolean | ✗ | If true, data is not used from cache. |
| segment | integer | ✗ | HLS segment number to deliver |
Examples
HLS
Request
/v5/deliverEmbed/LINK/subtitle/1234
Response
{
"body": "#EXTM3U\n#EXT-X-TARGETDURATION:60\n#EXT-X-VERSION:3\n#EXT-X-MEDIA-SEQUENCE:0\n#EXT-X-PLAYLIST-TYPE:VOD\n#EXTINF:60,\nhttps:\/\/external.admiralcloud.com\/v5\/deliverEmbed\/PLAYERLINK\/subtitle\/123?hls=true&segment=1\n#EXT-X-ENDLIST"
}Embedlinkdelivery deliverimage
GET/v5/deliverEmbed/:link/image/:width/:mediaId
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| debug | boolean | ✗ | If set to true, instead of a redirect, you will see the actual response (helps debugging problems) |
| language | string | ✗ | Language TBD |
| link | string | ✓ | link of the embed code/embed link |
| mediaId | integer | ✗ | Known media ID to deliver |
| refresh | boolean | ✗ | If true, data is not used from cache. |
| width | integer | ✗ | optional width to deliver. If not set 640px width will be delivered. range: -1 to 10000 |
Embedlinkdelivery updateembedlinkproperties
POST/v5/deliverEmbed
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| bandwidth | integer | ✗ | Bandwidth value for BWC |
| event | string | ✓ | Event address for BWC allowed values: playmarkerbuffering |
| ip | ip | ✓ | IP address for BWC |
| link | string | ✓ | Update this link |
| op | string | ✓ | Update embed link properties. Only available for enabled apps allowed values: bwc |