Video API, gRPC: StreamLineService.PerformAction
Perform an action on the line.
gRPC request
rpc PerformAction (PerformLineActionRequest) returns (operation.Operation)
PerformLineActionRequest
{
"stream_line_id": "string",
// Includes only one of the fields `activate`, `deactivate`
"activate": "ActivateAction",
"deactivate": "DeactivateAction"
// end of the list of possible fields
}
Field |
Description |
stream_line_id |
string Required field. ID of the line. |
activate |
Includes only one of the fields |
deactivate |
Includes only one of the fields |
ActivateAction
Field |
Description |
Empty |
DeactivateAction
Field |
Description |
Empty |
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"stream_line_id": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"channel_id": "string",
"title": "string",
"thumbnail_id": "string",
// Includes only one of the fields `rtmp_push`, `rtmp_pull`
"rtmp_push": {
"url": "string"
},
"rtmp_pull": {
"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
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp",
"labels": "map<string, 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. |
created_at |
Creation timestamp. |
created_by |
string ID of the user or service account who initiated the operation. |
modified_at |
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. |
PerformLineActionMetadata
Field |
Description |
stream_line_id |
string ID of the line. |
StreamLine
Entity that is responsible for 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. |
thumbnail_id |
string ID of the thumbnail image associated with the stream line.. |
rtmp_push |
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. |
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. |
manual_line |
Manual control of stream. Includes only one of the fields Specifies the control type of the stream line. |
auto_line |
Automatic control of stream. Includes only one of the fields Specifies the control type of the stream line. |
created_at |
Time when the stream line was created. |
updated_at |
Time when the stream line was last updated. |
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. |
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.
|