Video API, gRPC: EpisodeService.List
List episodes for stream or line.
gRPC request
rpc List (ListEpisodesRequest) returns (ListEpisodesResponse)
ListEpisodesRequest
{
// Includes only one of the fields `streamId`, `lineId`
"streamId": "string",
"lineId": "string",
// end of the list of possible fields
"pageSize": "int64",
"pageToken": "string",
"orderBy": "string",
"filter": "string"
}
Field |
Description |
streamId |
string ID of the stream. Includes only one of the fields |
lineId |
string ID of the line. Includes only one of the fields |
pageSize |
int64 The maximum number of the results per page to return. Default value: 100. |
pageToken |
string Page token for getting the next page of the result. |
orderBy |
string By which column the listing should be ordered and in which direction, |
filter |
string Filter expression that filters resources listed in the response. |
ListEpisodesResponse
{
"episodes": [
{
"id": "string",
"streamId": "string",
"lineId": "string",
"title": "string",
"description": "string",
"thumbnailId": "string",
"startTime": "google.protobuf.Timestamp",
"finishTime": "google.protobuf.Timestamp",
"dvrSeconds": "int64",
"visibilityStatus": "VisibilityStatus",
// Includes only one of the fields `publicAccess`, `authSystemAccess`
"publicAccess": "EpisodePublicAccessRights",
"authSystemAccess": "EpisodeAuthSystemAccessRights",
// end of the list of possible fields
"createdAt": "google.protobuf.Timestamp",
"updatedAt": "google.protobuf.Timestamp"
}
],
"nextPageToken": "string"
}
Field |
Description |
episodes[] |
List of episodes for specific parent_id. |
nextPageToken |
string Token for getting the next page. |
Episode
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 |
Episode start time. |
finishTime |
Episode finish time. |
dvrSeconds |
int64 Enables episode DVR mode. DVR seconds determines how many last seconds of the stream are available. possible values:
|
visibilityStatus |
enum VisibilityStatus
|
publicAccess |
Episode is available to everyone. Includes only one of the fields Episode access rights. |
authSystemAccess |
Checking access rights using the authorization system. Includes only one of the fields Episode access rights. |
createdAt |
Time when episode was created. |
updatedAt |
Time of last episode update. |
EpisodePublicAccessRights
Field |
Description |
Empty |
EpisodeAuthSystemAccessRights
Field |
Description |
Empty |