Video API, gRPC: StreamLineService.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.
gRPC request
rpc BatchGet (BatchGetStreamLinesRequest) returns (BatchGetStreamLinesResponse)
BatchGetStreamLinesRequest
{
"channel_id": "string",
"stream_line_ids": [
"string"
]
}
|
Field |
Description |
|
channel_id |
string Required field. ID of the channel containing the stream lines to retrieve. The maximum string length in characters is 50. |
|
stream_line_ids[] |
string List of stream line IDs to retrieve. The maximum string length in characters for each value is 50. The number of elements must be in the range 1-100. |
BatchGetStreamLinesResponse
{
"stream_lines": [
{
"id": "string",
"channel_id": "string",
"title": "string",
"input_source": "LineInputSource",
// Includes only one of the fields `rtmp_push`, `srt_push`, `rtmp_pull`, `srt_pull`
"rtmp_push": {
"url": "string",
"backup_url": "string"
},
"srt_push": {
"url": "string",
"backup_url": "string"
},
"rtmp_pull": {
"url": "string",
"backup_url": "string"
},
"srt_pull": {
"url": "string",
"backup_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
"processing_settings": {
"summarization": {
"enable": "bool",
"tracks": [
{
"track_index": "int64",
"src_lang": "string"
}
]
},
"translation": {
"enable": "bool",
"tracks": [
{
"input_track": {
"track_index": "int64",
"src_lang": "string"
},
"subtitles": [
{
"dst_lang": "string"
}
],
"audios": [
{
"dst_lang": "string"
}
]
}
]
}
},
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp",
"labels": "map<string, string>"
}
]
}
|
Field |
Description |
|
stream_lines[] |
List of stream lines matching the requested IDs. |
StreamLine
Entity representing the incoming video signal settings.
|
Field |
Description |
|
id |
string ID of the line. |
|
channel_id |
string ID of the channel to which this stream line belongs. |
|
title |
string Title of the stream line. |
|
input_source |
enum LineInputSource Specifies which input source (main or backup) is currently active.
|
|
rtmp_push |
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. |
|
srt_push |
Secure Reliable Transport (SRT) push input type. Includes only one of the fields Specifies the input type and settings for the video signal source. |
|
rtmp_pull |
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. |
|
srt_pull |
Secure Reliable Transport (SRT) pull input type. Includes only one of the fields Specifies the input type and settings for the video signal source. |
|
manual_line |
Manual stream control. Includes only one of the fields Specifies the control type of the stream line. |
|
auto_line |
Automatic stream control. Includes only one of the fields Specifies the control type of the stream line. |
|
processing_settings |
Processing settings. |
|
created_at |
Timestamp when the stream line was initially created in the system. |
|
updated_at |
Timestamp of the last modification to the stream line or its metadata. |
|
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. |
|
backup_url |
string RTMP server URL for the signal identified by the backup stream key. |
SRTPushInput
Settings for an SRT (Secure Reliable Transport) push input.
Used when the video stream is pushed to an SRT server.
@see https://en.wikipedia.org/wiki/Secure_Reliable_Transport
|
Field |
Description |
|
url |
string SRT server url. |
|
backup_url |
string SRT server URL for the signal identified by the backup stream key. |
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. |
|
backup_url |
string Backup RTMP url (optional). |
SRTPullInput
Settings for an SRT pull input.
Used when the service pulls the video stream from an SRT source.
@see https://en.wikipedia.org/wiki/Secure_Reliable_Transport
|
Field |
Description |
|
url |
string SRT url for receiving video signal. |
|
backup_url |
string Backup SRT url (optional). |
ManualLine
Represents a manual line type where the stream control is handled manually.
This means that stream start/stop actions are performed by the user.
|
Field |
Description |
|
Empty |
|
AutoLine
Represents an automatic line type where the stream control is handled automatically.
|
Field |
Description |
|
status |
enum AutoLineStatus The status of the automatic line.
|
StreamLineProcessingSettings
|
Field |
Description |
|
summarization |
Settings for stream line summarization. |
|
translation |
Settings for stream line translation. |
Summarization
|
Field |
Description |
|
enable |
bool Enable line summarization. |
|
tracks[] |
Input tracks. |
InputTrack
|
Field |
Description |
|
track_index |
int64 Input audio track index (one-based). The minimum value is 1. |
|
src_lang |
string Source track language represented as a three-letter code according to ISO 639-2/T. Value must match the regular expression |
Translation
|
Field |
Description |
|
enable |
bool Enable line translation. |
|
tracks[] |
Input tracks. |
TranslationTrack
|
Field |
Description |
|
input_track |
Required field. Input track settings. |
|
subtitles[] |
Settings for target subtitle tracks. |
|
audios[] |
Settings for target audio tracks. |
SubtitleTrack
|
Field |
Description |
|
dst_lang |
string Required field. Language of subtitles represented as a three-letter code according to ISO 639-2/T. Value must match the regular expression |
AudioTrack
|
Field |
Description |
|
dst_lang |
string Required field. Target language represented as a three-letter code according to ISO 639-2/T. Value must match the regular expression |