Video API, gRPC: StreamService.List
List streams for channel.
gRPC request
rpc List (ListStreamsRequest) returns (ListStreamsResponse)
ListStreamsRequest
{
"channel_id": "string",
"page_size": "int64",
"page_token": "string",
"order_by": "string",
"filter": "string"
}
Field |
Description |
channel_id |
string Required field. ID of the channel. |
page_size |
int64 The maximum number of the results per page to return. |
page_token |
string Page token for getting the next page of the result. |
order_by |
string By which column the listing should be ordered and in which direction, |
filter |
string Filter expression that filters resources listed in the response. |
ListStreamsResponse
{
"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>"
}
],
"next_page_token": "string"
}
Field |
Description |
streams[] |
List of streams for channel. |
next_page_token |
string Token for getting the next page. |
Stream
Field |
Description |
id |
string ID of the stream. |
channel_id |
string ID of the channel where the stream was created. |
line_id |
string ID of the line to which stream is linked. |
title |
string Stream title. |
description |
string Stream description. |
thumbnail_id |
string ID of the thumbnail. |
status |
enum StreamStatus Stream status.
|
start_time |
Stream start time. |
publish_time |
Stream publish time. Time when stream switched to ONAIR status. |
finish_time |
Stream finish time. |
auto_publish |
Automatically publish stream when ready. |
on_demand |
On-demand stream. Starts immediately when a signal appears. Includes only one of the fields Stream type. |
schedule |
Schedule stream. Starts or finished at the specified time. Includes only one of the fields Stream type. |
created_at |
Time when stream was created. |
updated_at |
Time of last stream update. |
labels |
object (map<string, string>) Custom labels as |
OnDemand
On-demand stream type.
This type of streams should be started and finished explicitly.
Field |
Description |
Empty |
Schedule
Schedule stream type.
This type of streams start and finish automatically at the specified time.
Field |
Description |
start_time |
|
finish_time |