Video API, gRPC: StreamLineService.PerformAction

Written by

Yandex Cloud

Updated at December 17, 2024

gRPC request
PerformLineActionRequest
ActivateAction
DeactivateAction
operation.Operation
PerformLineActionMetadata
StreamLine
RTMPPushInput
SRTPushInput
RTMPPullInput
SRTPullInput
TCPPullInput
RTSPPullInput
ManualLine
AutoLine

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	ActivateAction Includes only one of the fields `activate`, `deactivate`.
deactivate	DeactivateAction Includes only one of the fields `activate`, `deactivate`.

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`, `srt_push`, `rtmp_pull`, `srt_pull`, `tcp_pull`, `rtsp_pull`
    "rtmp_push": {
      "url": "string"
    },
    "srt_push": {
      "url": "string"
    },
    "rtmp_pull": {
      "url": "string"
    },
    "srt_pull": {
      "url": "string"
    },
    "tcp_pull": {
      "url": "string"
    },
    "rtsp_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	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	PerformLineActionMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	StreamLine The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

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 where the line was created.
title	string Line title.
thumbnail_id	string ID of the thumbnail.
rtmp_push	RTMPPushInput RTMP push input type. Includes only one of the fields `rtmp_push`, `srt_push`, `rtmp_pull`, `srt_pull`, `tcp_pull`, `rtsp_pull`. Video signal settings.
srt_push	SRTPushInput SRT push input type. Includes only one of the fields `rtmp_push`, `srt_push`, `rtmp_pull`, `srt_pull`, `tcp_pull`, `rtsp_pull`. Video signal settings.
rtmp_pull	RTMPPullInput RTMP pull input type. Includes only one of the fields `rtmp_push`, `srt_push`, `rtmp_pull`, `srt_pull`, `tcp_pull`, `rtsp_pull`. Video signal settings.
srt_pull	SRTPullInput SRT pull input type. Includes only one of the fields `rtmp_push`, `srt_push`, `rtmp_pull`, `srt_pull`, `tcp_pull`, `rtsp_pull`. Video signal settings.
tcp_pull	TCPPullInput TCP pull input type. Includes only one of the fields `rtmp_push`, `srt_push`, `rtmp_pull`, `srt_pull`, `tcp_pull`, `rtsp_pull`. Video signal settings.
rtsp_pull	RTSPPullInput RTSP pull input type. Includes only one of the fields `rtmp_push`, `srt_push`, `rtmp_pull`, `srt_pull`, `tcp_pull`, `rtsp_pull`. Video signal settings.
manual_line	ManualLine Manual control of stream. Includes only one of the fields `manual_line`, `auto_line`. Line type.
auto_line	AutoLine Automatic control of stream. Includes only one of the fields `manual_line`, `auto_line`. Line type.
created_at	google.protobuf.Timestamp Time when line was created.
updated_at	google.protobuf.Timestamp Time of last line update.
labels	object (map<string, string>) Custom labels as `key:value` pairs. Maximum 64 per resource.

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.

AUTO_LINE_STATUS_UNSPECIFIED: Auto line status unspecified.
DEACTIVATED: Auto line deactivated.
ACTIVE: Auto line active.

Video API, gRPC: StreamLineService.PerformAction

gRPC requestgRPC request

PerformLineActionRequestPerformLineActionRequest

ActivateActionActivateAction

DeactivateActionDeactivateAction

operation.Operationoperation.Operation

PerformLineActionMetadataPerformLineActionMetadata

StreamLineStreamLine

RTMPPushInputRTMPPushInput

SRTPushInputSRTPushInput

RTMPPullInputRTMPPullInput

SRTPullInputSRTPullInput

TCPPullInputTCPPullInput

RTSPPullInputRTSPPullInput

ManualLineManualLine

AutoLineAutoLine

Was the article helpful?

gRPC request

PerformLineActionRequest

ActivateAction

DeactivateAction

operation.Operation

PerformLineActionMetadata

StreamLine

RTMPPushInput

SRTPushInput

RTMPPullInput

SRTPullInput

TCPPullInput

RTSPPullInput

ManualLine

AutoLine