Video API, gRPC: StreamService.BatchGet
Retrieves multiple streams by their IDs in a specific channel in a single request.
This is more efficient than making multiple Get requests when retrieving several streams.
gRPC request
rpc BatchGet (BatchGetStreamsRequest) returns (BatchGetStreamsResponse)
BatchGetStreamsRequest
{
"channel_id": "string",
"stream_ids": [
"string"
]
}
|
Field |
Description |
|
channel_id |
string Required field. ID of the channel containing the streams to retrieve. |
|
stream_ids[] |
string List of stream IDs to retrieve. |
BatchGetStreamsResponse
{
"streams": [
{
"id": "string",
"channel_id": "string",
"line_id": "string",
"title": "string",
"description": "string",
"thumbnail_id": "string",
"status": "StreamStatus",
"start_time": "google.protobuf.Timestamp",
"publish_time": "google.protobuf.Timestamp",
"finish_time": "google.protobuf.Timestamp",
"auto_publish": "google.protobuf.BoolValue",
// Includes only one of the fields `on_demand`, `schedule`
"on_demand": "OnDemand",
"schedule": {
"start_time": "google.protobuf.Timestamp",
"finish_time": "google.protobuf.Timestamp"
},
// end of the list of possible fields
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp",
"labels": "map<string, string>"
}
]
}
|
Field |
Description |
|
streams[] |
List of streams matching the requested IDs. |
Stream
Entity representing a live video stream.
A stream is a real-time video broadcast linked to a specific stream line.
|
Field |
Description |
|
id |
string Unique identifier of the stream. |
|
channel_id |
string Identifier of the channel where the stream is created and managed. |
|
line_id |
string Identifier of the stream line to which this stream is linked. |
|
title |
string Title of the stream displayed in interfaces and players. |
|
description |
string Detailed description of the stream content and context. |
|
thumbnail_id |
string Identifier of the thumbnail image used to represent the stream visually. |
|
status |
enum StreamStatus Current status of the stream.
|
|
start_time |
Timestamp when the stream was initiated. |
|
publish_time |
Timestamp when the stream was published (switched to ONAIR status). |
|
finish_time |
Timestamp when the stream was completed. |
|
auto_publish |
Controls automatic publishing of the stream when it's ready. |
|
on_demand |
On-demand stream starts immediately when a video signal appears. Includes only one of the fields Specifies the stream scheduling type. |
|
schedule |
Scheduled stream starts and finishes at specified time. Includes only one of the fields Specifies the stream scheduling type. |
|
created_at |
Timestamp when the stream was initially created in the system. |
|
updated_at |
Timestamp of the last modification to the stream or its metadata. |
|
labels |
object (map<string, string>) Custom user-defined labels as |
OnDemand
Represents an on-demand stream type.
This type of stream must be started and finished explicitly by the user.
It begins broadcasting immediately when a video signal is detected.
|
Field |
Description |
|
Empty |
|
Schedule
Represents a scheduled stream type.
This type of stream starts and finishes automatically at specified time.
|
Field |
Description |
|
start_time |
Scheduled time when the stream should automatically start. |
|
finish_time |
Scheduled time when the stream should automatically finish. |