Video API, gRPC: EpisodeService.Create
Creates a new episode associated with a stream or stream line.
Episodes can be configured with various settings including title, description,
time boundaries, and access rights.
gRPC request
rpc Create (CreateEpisodeRequest) returns (operation.Operation)
CreateEpisodeRequest
{
// Includes only one of the fields `stream_id`, `line_id`
"stream_id": "string",
"line_id": "string",
// end of the list of possible fields
"title": "string",
"description": "string",
"thumbnail_id": "string",
"start_time": "google.protobuf.Timestamp",
"finish_time": "google.protobuf.Timestamp",
"dvr_seconds": "int64",
"style_preset_id": "string",
// Includes only one of the fields `public_access`, `sign_url_access`
"public_access": "EpisodePublicAccessParams",
"sign_url_access": "EpisodeSignURLAccessParams"
// end of the list of possible fields
}
|
Field |
Description |
|
stream_id |
string ID of the stream. The maximum string length in characters is 50. Includes only one of the fields Parent resource ID to link the episode to (exactly one must be chosen). |
|
line_id |
string ID of the line. The maximum string length in characters is 50. Includes only one of the fields Parent resource ID to link the episode to (exactly one must be chosen). |
|
title |
string Required field. Episode title. The maximum string length in characters is 300. |
|
description |
string Episode description. The maximum string length in characters is 5000. |
|
thumbnail_id |
string ID of the thumbnail. The maximum string length in characters is 50. |
|
start_time |
Episode start time. |
|
finish_time |
Episode finish time. |
|
dvr_seconds |
int64 Enables episode DVR mode.
|
|
style_preset_id |
string ID of the style preset. The maximum string length in characters is 50. |
|
public_access |
Episode is publicly available. Includes only one of the fields Episode access permission settings (exactly one must be chosen). |
|
sign_url_access |
Access to the episode is restricted by temporarily signed links. Includes only one of the fields Episode access permission settings (exactly one must be chosen). |
EpisodePublicAccessParams
Parameters for episode public access rights.
|
Field |
Description |
|
Empty |
|
EpisodeSignURLAccessParams
Parameters for episode access restrictions based on temporary signed links.
|
Field |
Description |
|
Empty |
|
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": "google.protobuf.Any",
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": "google.protobuf.Any"
// 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. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |