Video API, REST: StreamLine.List
List lines for channel.
HTTP request
GET https://video.api.cloud.yandex.net/video/v1/streamLines
Query parameters
Field |
Description |
channelId |
string ID of the channel. |
pageSize |
string (int64) The maximum number of the results per page to return. Default value: 100. |
pageToken |
string Page token for getting the next page of the result. |
orderBy |
string By which column the listing should be ordered and in which direction, |
filter |
string Filter expression that filters resources listed in the response. |
Response
HTTP Code: 200 - OK
{
"streamLines": [
{
"id": "string",
"channelId": "string",
"title": "string",
"thumbnailId": "string",
// Includes only one of the fields `rtmpPush`, `srtPush`, `rtmpPull`, `srtPull`, `tcpPull`, `rtspPull`
"rtmpPush": {
"url": "string"
},
"srtPush": {
"url": "string"
},
"rtmpPull": {
"url": "string"
},
"srtPull": {
"url": "string"
},
"tcpPull": {
"url": "string"
},
"rtspPull": {
"url": "string"
},
// end of the list of possible fields
// Includes only one of the fields `manualLine`, `autoLine`
"manualLine": "object",
"autoLine": {
"status": "string"
},
// end of the list of possible fields
"createdAt": "string",
"updatedAt": "string",
"labels": "string"
}
],
"nextPageToken": "string"
}
Field |
Description |
streamLines[] |
List of lines for channel. |
nextPageToken |
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. |
channelId |
string ID of the channel where the line was created. |
title |
string Line title. |
thumbnailId |
string ID of the thumbnail. |
rtmpPush |
RTMP push input type. Includes only one of the fields Video signal settings. |
srtPush |
SRT push input type. Includes only one of the fields Video signal settings. |
rtmpPull |
RTMP pull input type. Includes only one of the fields Video signal settings. |
srtPull |
SRT pull input type. Includes only one of the fields Video signal settings. |
tcpPull |
TCP pull input type. Includes only one of the fields Video signal settings. |
rtspPull |
RTSP pull input type. Includes only one of the fields Video signal settings. |
manualLine |
object Manual control of stream. Includes only one of the fields Line type. |
autoLine |
Automatic control of stream. Includes only one of the fields Line type. |
createdAt |
string (date-time) Time when line was created. String in RFC3339 To work with values in this field, use the APIs described in the |
updatedAt |
string (date-time) Time of last line update. String in RFC3339 To work with values in this field, use the APIs described in the |
labels |
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. |
AutoLine
Auto line type.
Field |
Description |
status |
enum (AutoLineStatus) Status of auto line.
|