Video API, REST: StreamLine.BatchGet
Retrieves multiple stream lines by their IDs in a specific channel in a single request.
This is more efficient than making multiple Get requests when retrieving several stream lines.
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 containing the stream lines to retrieve. The maximum string length in characters is 50. |
|
streamLineIds[] |
string List of stream line IDs to retrieve. The number of elements must be in the range 1-100. The maximum string length in characters for each value is 50. |
Response
HTTP Code: 200 - OK
{
"streamLines": [
{
"id": "string",
"channelId": "string",
"title": "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 stream lines matching the requested IDs. |
StreamLine
Entity representing 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. |
|
rtmpPush |
Real-Time Messaging Protocol (RTMP) push input type. 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 stream control. Includes only one of the fields Specifies the control type of the stream line. |
|
autoLine |
Automatic stream control. Includes only one of the fields Specifies the control type of the stream line. |
|
createdAt |
string (date-time) Timestamp when the stream line was initially created in the system. 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) Timestamp of the last modification to the stream line or its metadata. 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 user-defined 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.
|