Video API, REST: StreamLine.BatchGet
Batch get lines for channel.
HTTP request
POST https://video.api.cloud.yandex.net/video/v1/streamLines:batchGet
Body parameters
{
"channelId": "string",
"streamLineIds": [
"string"
]
}
|
Field |
Description |
|
channelId |
string Required field. ID of the channel. |
|
streamLineIds[] |
string List of requested stream line IDs. |
Response
HTTP Code: 200 - OK
{
"streamLines": [
{
"id": "string",
"channelId": "string",
"title": "string",
"thumbnailId": "string",
// Includes only one of the fields `rtmpPush`, `rtmpPull`
"rtmpPush": {
"url": "string"
},
"rtmpPull": {
"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": "object"
}
]
}
|
Field |
Description |
|
streamLines[] |
List of lines for specific channel. |
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 to which this stream line belongs. |
|
title |
string Title of the stream line. |
|
thumbnailId |
string ID of the thumbnail image associated with the stream line.. |
|
rtmpPush |
Real-Time Messaging Protocol (RTMP) push input settings. Includes only one of the fields Specifies the input type and settings for the video signal source. |
|
rtmpPull |
Real-Time Messaging Protocol (RTMP) pull input type. Includes only one of the fields Specifies the input type and settings for the video signal source. |
|
manualLine |
object Manual control of stream. Includes only one of the fields Specifies the control type of the stream line. |
|
autoLine |
Automatic control of stream. Includes only one of the fields Specifies the control type of the stream line. |
|
createdAt |
string (date-time) Time when the stream 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 |
|
updatedAt |
string (date-time) Time when the stream line was last updated. 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 |
|
labels |
object (map<string, string>) Custom labels as |
RTMPPushInput
Settings for an RTMP (Real-Time Messaging Protocol) push input.
Used when the video stream is pushed to an RTMP server.
@see https://en.wikipedia.org/wiki/Real-Time_Messaging_Protocol
|
Field |
Description |
|
url |
string RTMP server url. |
RTMPPullInput
Settings for an RTMP pull input.
Used when the service pulls the video stream from an RTMP source.
@see https://en.wikipedia.org/wiki/Real-Time_Messaging_Protocol
|
Field |
Description |
|
url |
string RTMP url for receiving video signal. |
AutoLine
Represents an automatic line type where the stream control is handled automatically.
|
Field |
Description |
|
status |
enum (AutoLineStatus) The status of the automatic line.
|