Video API, REST: Episode.create
Create episode.
HTTP request
POST https://video.api.cloud.yandex.net/video/v1/episodes
Body parameters
{
"title": "string",
"description": "string",
"thumbnailId": "string",
"startTime": "string",
"finishTime": "string",
"dvrSeconds": "string",
// includes only one of the fields `publicAccess`, `authSystemAccess`
"streamId": "string",
"lineId": "string",
// end of the list of possible fields
"publicAccess": {},
"authSystemAccess": {}
}
Field | Description |
---|---|
title | string Episode title. |
description | string Episode 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:
|
streamId | string includes only one of the fields streamId , lineId ID of the stream. |
lineId | string includes only one of the fields streamId , lineId ID of the line. |
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 |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
createdAt | string (date-time) Creation timestamp. 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). |
createdBy | string ID of the user or service account who initiated the operation. |
modifiedAt | string (date-time) The time when the Operation resource was last modified. 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). |
done | boolean (boolean) If the value is |
metadata | object Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
error | object The error result of the operation in case of failure or cancellation. includes only one of the fields error , response |
error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
error. message |
string An error message. |
error. details[] |
object A list of messages that carry the error details. |
response | object includes only one of the fields error , response The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |