Video API, REST: StreamLine.list
List lines for channel.
HTTP request
GET https://video.api.cloud.yandex.net/video/v1/streamLines
Query parameters
Parameter | Description |
---|---|
channelId | ID of the channel. |
pageSize | The maximum number of the results per page to return. Default value: 100. |
pageToken | Page token for getting the next page of the result. |
orderBy | By which column the listing should be ordered and in which direction, format is "createdAt desc". "id asc" if omitted. Possible fields: ["id", "title", "createdAt", "updatedAt"] Both snake_case and camelCase are supported for fields. |
filter | Filter expression that filters resources listed in the response. Expressions are composed of terms connected by logic operators. Value in quotes: |
Response
HTTP Code: 200 - OK
{
"streamLines": [
{
"id": "string",
"channelId": "string",
"title": "string",
"thumbnailId": "string",
"createdAt": "string",
"updatedAt": "string",
"labels": "object",
// `streamLines[]` includes only one of the fields `manualLine`, `autoLine`
"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`streamLines[]`
"manualLine": {},
"autoLine": {
"status": "string"
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
streamLines[] | object List of lines for channel. |
streamLines[]. id |
string ID of the line. |
streamLines[]. channelId |
string ID of the channel where the line was created. |
streamLines[]. title |
string Line title. |
streamLines[]. thumbnailId |
string ID of the thumbnail. |
streamLines[]. createdAt |
string (date-time) Time when line was created. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
streamLines[]. updatedAt |
string (date-time) Time of last line update. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
streamLines[]. labels |
object Custom labels as |
streamLines[]. rtmpPush |
object RTMP push input type. streamLines[] includes only one of the fields rtmpPush , srtPush , rtmpPull , srtPull , tcpPull , rtspPull |
streamLines[]. rtmpPush. url |
string RTMP server url. |
streamLines[]. srtPush |
object SRT push input type. streamLines[] includes only one of the fields rtmpPush , srtPush , rtmpPull , srtPull , tcpPull , rtspPull |
streamLines[]. srtPush. url |
string SRT server url. |
streamLines[]. rtmpPull |
object RTMP pull input type. streamLines[] includes only one of the fields rtmpPush , srtPush , rtmpPull , srtPull , tcpPull , rtspPull |
streamLines[]. rtmpPull. url |
string RTMP url for receiving video signal. |
streamLines[]. srtPull |
object SRT pull input type. streamLines[] includes only one of the fields rtmpPush , srtPush , rtmpPull , srtPull , tcpPull , rtspPull |
streamLines[]. srtPull. url |
string SRT url for receiving video signal. |
streamLines[]. tcpPull |
object TCP pull input type. streamLines[] includes only one of the fields rtmpPush , srtPush , rtmpPull , srtPull , tcpPull , rtspPull |
streamLines[]. tcpPull. url |
string TCP url for receiving video signal. |
streamLines[]. rtspPull |
object RTSP pull input type. streamLines[] includes only one of the fields rtmpPush , srtPush , rtmpPull , srtPull , tcpPull , rtspPull |
streamLines[]. rtspPull. url |
string RTSP url for receiving video signal. |
streamLines[]. manualLine |
object Manual control of stream. streamLines[] includes only one of the fields manualLine , autoLine |
streamLines[]. autoLine |
object Automatic control of stream. streamLines[] includes only one of the fields manualLine , autoLine |
streamLines[]. autoLine. status |
string Status of auto line. Auto line status.
|
nextPageToken | string Token for getting the next page. |