Yandex Cloud
Search
Contact UsGet started
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML Services
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
© 2025 Direct Cursus Technology L.L.C.
Yandex Cloud Video
    • Overview
    • Control
    • Troubleshooting
  • Access management
  • Pricing policy
    • API authentication
    • Getting started with the API
      • Overview
        • Overview
        • Get
        • List
        • BatchGet
        • Create
        • Update
        • Delete
        • BatchDelete
        • PerformAction
  • Audit Trails events
  • Release notes

In this article:

  • gRPC request
  • BatchGetStreamsRequest
  • BatchGetStreamsResponse
  • Stream
  • OnDemand
  • Schedule
  1. API reference
  2. gRPC
  3. Stream
  4. BatchGet

Video API, gRPC: StreamService.BatchGet

Written by
Yandex Cloud
Updated at August 8, 2025
  • gRPC request
  • BatchGetStreamsRequest
  • BatchGetStreamsResponse
  • Stream
  • OnDemand
  • Schedule

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 requestgRPC request

rpc BatchGet (BatchGetStreamsRequest) returns (BatchGetStreamsResponse)

BatchGetStreamsRequestBatchGetStreamsRequest

{
  "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.

BatchGetStreamsResponseBatchGetStreamsResponse

{
  "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[]

Stream

List of streams matching the requested IDs.

StreamStream

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.

  • STREAM_STATUS_UNSPECIFIED: The stream status is not specified.
  • OFFLINE: The stream is offline and not broadcasting.
  • PREPARING: The system is preparing the infrastructure for receiving the video signal.
  • READY: The infrastructure is ready to launch the stream.
  • ONAIR: The stream is currently broadcasting live.
  • FINISHED: The stream has completed and is no longer broadcasting.

start_time

google.protobuf.Timestamp

Timestamp when the stream was initiated.

publish_time

google.protobuf.Timestamp

Timestamp when the stream was published (switched to ONAIR status).

finish_time

google.protobuf.Timestamp

Timestamp when the stream was completed.

auto_publish

google.protobuf.BoolValue

Controls automatic publishing of the stream when it's ready.
When set to true, automatically switches status from READY to ONAIR.

on_demand

OnDemand

On-demand stream starts immediately when a video signal appears.

Includes only one of the fields on_demand, schedule.

Specifies the stream scheduling type.

schedule

Schedule

Scheduled stream starts and finishes at specified time.

Includes only one of the fields on_demand, schedule.

Specifies the stream scheduling type.

created_at

google.protobuf.Timestamp

Timestamp when the stream was initially created in the system.

updated_at

google.protobuf.Timestamp

Timestamp of the last modification to the stream or its metadata.

labels

object (map<string, string>)

Custom user-defined labels as key:value pairs.
Maximum 64 labels per stream.
Used for organization, filtering, and metadata purposes.
Labels can be used for organization, filtering, and metadata purposes.

OnDemandOnDemand

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

ScheduleSchedule

Represents a scheduled stream type.
This type of stream starts and finishes automatically at specified time.

Field

Description

start_time

google.protobuf.Timestamp

Scheduled time when the stream should automatically start.

finish_time

google.protobuf.Timestamp

Scheduled time when the stream should automatically finish.

Was the article helpful?

Previous
List
Next
Create
© 2025 Direct Cursus Technology L.L.C.