Video API, gRPC: StreamLineService.Update
Update stream line.
gRPC request
rpc Update (UpdateStreamLineRequest) returns (operation.Operation)
UpdateStreamLineRequest
{
"streamLineId": "string",
"fieldMask": "google.protobuf.FieldMask",
"title": "string",
"thumbnailId": "string",
"labels": "string",
// Includes only one of the fields `rtmpPush`, `srtPush`, `rtmpPull`, `srtPull`, `tcpPull`, `rtspPull`
"rtmpPush": "RTMPPushParams",
"srtPush": "SRTPushParams",
"rtmpPull": {
"url": "string"
},
"srtPull": {
"url": "string"
},
"tcpPull": {
"url": "string"
},
"rtspPull": {
"url": "string"
}
// end of the list of possible fields
}
Field |
Description |
streamLineId |
string ID of the line. |
fieldMask |
Field mask that specifies which fields of the line are going to be updated. |
title |
string Line title. |
thumbnailId |
string ID of the thumbnail. |
labels |
string Custom labels as |
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. |
RTMPPushParams
Field |
Description |
Empty |
SRTPushParams
Field |
Description |
Empty |
RTMPPullParams
Field |
Description |
url |
string URL of a RTMP streaming server. |
SRTPullParams
Field |
Description |
url |
string URL of a SRT streaming server. |
TCPPullParams
Field |
Description |
url |
string URL of a TCP streaming server. |
RTSPPullParams
Field |
Description |
url |
string URL of a RTSP streaming server. |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"streamLineId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"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": "ManualLine",
"autoLine": {
"status": "AutoLineStatus"
},
// end of the list of possible fields
"createdAt": "google.protobuf.Timestamp",
"updatedAt": "google.protobuf.Timestamp",
"labels": "string"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateStreamLineMetadata
Field |
Description |
streamLineId |
string ID of the line. |
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 |
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 |
Time when line was created. |
updatedAt |
Time of last line update. |
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. |
ManualLine
Manual line type.
Field |
Description |
Empty |
AutoLine
Auto line type.
Field |
Description |
status |
enum AutoLineStatus Status of auto line.
|