Video API, gRPC: EpisodeService.BatchGet
Batch get episodes for channel.
gRPC request
rpc BatchGet (BatchGetEpisodesRequest) returns (BatchGetEpisodesResponse)
BatchGetEpisodesRequest
{
"channel_id": "string",
"episode_ids": [
"string"
]
}
|
Field |
Description |
|
channel_id |
string Required field. ID of the channel. |
|
episode_ids[] |
string List of requested episode IDs. |
BatchGetEpisodesResponse
{
"episodes": [
{
"id": "string",
"stream_id": "string",
"line_id": "string",
"title": "string",
"description": "string",
"thumbnail_id": "string",
"start_time": "google.protobuf.Timestamp",
"finish_time": "google.protobuf.Timestamp",
"dvr_seconds": "int64",
"visibility_status": "VisibilityStatus",
// Includes only one of the fields `public_access`, `auth_system_access`, `sign_url_access`
"public_access": "EpisodePublicAccessRights",
"auth_system_access": "EpisodeAuthSystemAccessRights",
"sign_url_access": "EpisodeSignURLAccessRights",
// end of the list of possible fields
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp"
}
]
}
|
Field |
Description |
|
episodes[] |
List of episodes for specific channel. |
Episode
|
Field |
Description |
|
id |
string ID of the episode. |
|
stream_id |
string ID of the stream. Optional, empty if the episode is linked to the line |
|
line_id |
string ID of the line. Optional, empty if the episode is linked to the stream |
|
title |
string Episode title. |
|
description |
string Episode description. |
|
thumbnail_id |
string ID of the thumbnail. |
|
start_time |
Episode start time. |
|
finish_time |
Episode finish time. |
|
dvr_seconds |
int64 Enables episode DVR mode. Possible values:
|
|
visibility_status |
enum VisibilityStatus
|
|
public_access |
Episode is available to everyone. Includes only one of the fields Episode access rights. |
|
auth_system_access |
Checking access rights using the authorization system. Includes only one of the fields Episode access rights. |
|
sign_url_access |
Checking access rights using url's signature. Includes only one of the fields Episode access rights. |
|
created_at |
Time when episode was created. |
|
updated_at |
Time of last episode update. |
EpisodePublicAccessRights
|
Field |
Description |
|
Empty |
|
EpisodeAuthSystemAccessRights
|
Field |
Description |
|
Empty |
|
EpisodeSignURLAccessRights
|
Field |
Description |
|
Empty |
|