Video API, REST: Episode methods
Episode management service.
JSON Representation
{
"id": "string",
"streamId": "string",
"lineId": "string",
"title": "string",
"description": "string",
"thumbnailId": "string",
"startTime": "string",
"finishTime": "string",
"dvrSeconds": "string",
"visibilityStatus": "string",
"createdAt": "string",
"updatedAt": "string",
// includes only one of the fields `publicAccess`, `authSystemAccess`
"publicAccess": {},
"authSystemAccess": {},
// end of the list of possible fields
}
Field | Description |
---|---|
id | string ID of the episode. |
streamId | string ID of the stream. Optional, empty if the episode is linked to the line |
lineId | string ID of the line. Optional, empty if the episode is linked to the stream |
title | string Channel title. |
description | string Channel description. |
thumbnailId | string ID of the thumbnail. |
startTime | string (date-time) Episode start time. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
finishTime | string (date-time) Episode finish time. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
dvrSeconds | string (int64) Enables episode DVR mode. DVR seconds determines how many last seconds of the stream are available. possible values:
|
visibilityStatus | string |
createdAt | string (date-time) Time when episode was created. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
updatedAt | string (date-time) Time of last episode update. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
publicAccess | object Episode is available to everyone. includes only one of the fields publicAccess , authSystemAccess |
authSystemAccess | object Checking access rights using the authorization system. includes only one of the fields publicAccess , authSystemAccess |
Methods
Method | Description |
---|---|
create | Create episode. |
delete | Delete episode. |
get | Returns the specific channel. |
getManifests | Returns manifest urls. |
getPlayerURL | Returns url to the player. |
list | List episodes for stream or line. |
performAction | Perform an action on the episode. |
update | Update episode. |