Video API, gRPC: EpisodeService.BatchGet
Retrieves multiple episodes by their IDs in a specific channel in a single request.
This is more efficient than making multiple Get requests when retrieving several episodes.
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 containing the episodes to retrieve. The maximum string length in characters is 50. |
|
episode_ids[] |
string List of episode IDs to retrieve. The maximum string length in characters for each value is 50. The number of elements must be in the range 1-100. |
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",
"style_preset_id": "string",
// Includes only one of the fields `public_access`, `sign_url_access`
"public_access": "EpisodePublicAccessRights",
"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 matching the requested IDs. |
Episode
Entity representing a stream fragment that can be accessed independently.
Episodes can be linked to either a stream or a line
and provide a way to reference specific portions of the corresponding content.
|
Field |
Description |
|
id |
string Unique identifier of the episode. |
|
stream_id |
string Identifier of the stream this episode is linked to. |
|
line_id |
string Identifier of the line this episode is linked to. |
|
title |
string Title of the episode displayed in interfaces and players. |
|
description |
string Detailed description of the episode content and context. |
|
thumbnail_id |
string Identifier of the thumbnail image used to represent the episode visually. |
|
start_time |
Timestamp marking the beginning of the episode content. |
|
finish_time |
Timestamp marking the end of the episode content. |
|
dvr_seconds |
int64 Controls the Digital Video Recording (DVR) functionality for the episode.
|
|
visibility_status |
enum VisibilityStatus Current visibility status controlling whether the episode is publicly available.
|
|
style_preset_id |
string Identifier of the style preset used in the player during episode playback. |
|
public_access |
Allows unrestricted public access to the episode via direct link. Includes only one of the fields Specifies the episode access permission settings. |
|
sign_url_access |
Restricts episode access using URL signatures for secure time-limited access. Includes only one of the fields Specifies the episode access permission settings. |
|
created_at |
Timestamp when the episode was initially created in the system. |
|
updated_at |
Timestamp of the last modification to the episode or its metadata. |
EpisodePublicAccessRights
Represents public access rights for an episode.
When this access type is set, the episode is publicly accessible via direct link.
|
Field |
Description |
|
Empty |
|
EpisodeSignURLAccessRights
Represents access rights controlled by URL signatures.
When this access type is set, the episode is accessible only via properly signed temporary link.
|
Field |
Description |
|
Empty |
|