Video API, gRPC: StreamService.Get
Returns the specific stream.
gRPC request
rpc Get (GetStreamRequest) returns (Stream)
GetStreamRequest
{
"streamId": "string"
}
|
Field |
Description |
|
streamId |
string ID of the stream. |
Stream
{
"id": "string",
"channelId": "string",
"lineId": "string",
"title": "string",
"description": "string",
"thumbnailId": "string",
"status": "StreamStatus",
"startTime": "google.protobuf.Timestamp",
"publishTime": "google.protobuf.Timestamp",
"finishTime": "google.protobuf.Timestamp",
// Includes only one of the fields `onDemand`, `schedule`
"onDemand": "OnDemand",
"schedule": {
"startTime": "google.protobuf.Timestamp",
"finishTime": "google.protobuf.Timestamp"
},
// end of the list of possible fields
"createdAt": "google.protobuf.Timestamp",
"updatedAt": "google.protobuf.Timestamp",
"labels": "string"
}
|
Field |
Description |
|
id |
string ID of the stream. |
|
channelId |
string ID of the channel where the stream was created. |
|
lineId |
string ID of the line to which stream is linked. |
|
title |
string Stream title. |
|
description |
string Stream description. |
|
thumbnailId |
string ID of the thumbnail. |
|
status |
enum StreamStatus Stream status.
|
|
startTime |
Stream start time. |
|
publishTime |
Stream publish time. Time when stream switched to ONAIR status. |
|
finishTime |
Stream finish time. |
|
onDemand |
On demand stream. It starts immediately when a signal appears. Includes only one of the fields Stream type. |
|
schedule |
Schedule stream. Determines when to start receiving the signal or finish time. Includes only one of the fields Stream type. |
|
createdAt |
Time when stream was created. |
|
updatedAt |
Time of last stream update. |
|
labels |
string Custom labels as |
OnDemand
If "OnDemand" is used, client should start and finish explicitly.
|
Field |
Description |
|
Empty |
|
Schedule
If "Schedule" is used, stream automatically start and finish at this time.
|
Field |
Description |
|
startTime |
|
|
finishTime |