Video API, gRPC: StreamLineService.List
List lines for channel.
gRPC request
rpc List (ListStreamLinesRequest) returns (ListStreamLinesResponse)
ListStreamLinesRequest
{
"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. Default value: 100. |
|
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. |
ListStreamLinesResponse
{
"stream_lines": [
{
"id": "string",
"channel_id": "string",
"title": "string",
"thumbnail_id": "string",
// Includes only one of the fields `rtmp_push`, `srt_push`, `rtmp_pull`, `srt_pull`, `tcp_pull`, `rtsp_pull`
"rtmp_push": {
"url": "string"
},
"srt_push": {
"url": "string"
},
"rtmp_pull": {
"url": "string"
},
"srt_pull": {
"url": "string"
},
"tcp_pull": {
"url": "string"
},
"rtsp_pull": {
"url": "string"
},
// end of the list of possible fields
// Includes only one of the fields `manual_line`, `auto_line`
"manual_line": "ManualLine",
"auto_line": {
"status": "AutoLineStatus"
},
// 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 |
|
stream_lines[] |
List of lines for channel. |
|
next_page_token |
string Token for getting the next page. |
StreamLine
Entity that is responsible for the incoming video signal settings.
|
Field |
Description |
|
id |
string ID of the line. |
|
channel_id |
string ID of the channel where the line was created. |
|
title |
string Line title. |
|
thumbnail_id |
string ID of the thumbnail. |
|
rtmp_push |
RTMP push input type. Includes only one of the fields Video signal settings. |
|
srt_push |
SRT push input type. Includes only one of the fields Video signal settings. |
|
rtmp_pull |
RTMP pull input type. Includes only one of the fields Video signal settings. |
|
srt_pull |
SRT pull input type. Includes only one of the fields Video signal settings. |
|
tcp_pull |
TCP pull input type. Includes only one of the fields Video signal settings. |
|
rtsp_pull |
RTSP pull input type. Includes only one of the fields Video signal settings. |
|
manual_line |
Manual control of stream. Includes only one of the fields Line type. |
|
auto_line |
Automatic control of stream. Includes only one of the fields Line type. |
|
created_at |
Time when line was created. |
|
updated_at |
Time of last line update. |
|
labels |
object (map<string, string>) Custom labels as |
RTMPPushInput
|
Field |
Description |
|
url |
string RTMP server url. |
SRTPushInput
|
Field |
Description |
|
url |
string SRT server url. |
RTMPPullInput
|
Field |
Description |
|
url |
string RTMP url for receiving video signal. |
SRTPullInput
|
Field |
Description |
|
url |
string SRT url for receiving video signal. |
TCPPullInput
|
Field |
Description |
|
url |
string TCP url for receiving video signal. |
RTSPPullInput
|
Field |
Description |
|
url |
string RTSP url for receiving video signal. |
ManualLine
Manual line type.
|
Field |
Description |
|
Empty |
|
AutoLine
Auto line type.
|
Field |
Description |
|
status |
enum AutoLineStatus Status of auto line.
|