Video API, gRPC: StreamLineService.PerformAction

Статья создана

Yandex Cloud

Обновлена 24 апреля 2025 г.

gRPC request
PerformLineActionRequest
ActivateAction
DeactivateAction
operation.Operation
PerformLineActionMetadata
StreamLine
RTMPPushInput
RTMPPullInput
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`, `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	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 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	RTMPPushInput Real-Time Messaging Protocol (RTMP) push input settings. Includes only one of the fields `rtmp_push`, `rtmp_pull`. Specifies the input type and settings for the video signal source.
rtmp_pull	RTMPPullInput Real-Time Messaging Protocol (RTMP) pull input type. Includes only one of the fields `rtmp_push`, `rtmp_pull`. Specifies the input type and settings for the video signal source.
manual_line	ManualLine Manual control of stream. Includes only one of the fields `manual_line`, `auto_line`. Specifies the control type of the stream line.
auto_line	AutoLine Automatic control of stream. Includes only one of the fields `manual_line`, `auto_line`. Specifies the control type of the stream line.
created_at	google.protobuf.Timestamp Time when the stream line was created.
updated_at	google.protobuf.Timestamp Time when the stream line was last updated.
labels	object (map<string, string>) Custom labels as `key:value` pairs. Maximum 64 per resource.

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.

AUTO_LINE_STATUS_UNSPECIFIED: Auto line status unspecified.
DEACTIVATED: The automatic line is deactivated and not currently active.
ACTIVE: The automatic line is active and operational.

Video API, gRPC: StreamLineService.PerformAction

gRPC requestgRPC request

PerformLineActionRequestPerformLineActionRequest

ActivateActionActivateAction

DeactivateActionDeactivateAction

operation.Operationoperation.Operation

PerformLineActionMetadataPerformLineActionMetadata

StreamLineStreamLine

RTMPPushInputRTMPPushInput

RTMPPullInputRTMPPullInput

ManualLineManualLine

AutoLineAutoLine

Была ли статья полезна?

gRPC request

PerformLineActionRequest

ActivateAction

DeactivateAction

operation.Operation

PerformLineActionMetadata

StreamLine

RTMPPushInput

RTMPPullInput

ManualLine

AutoLine