Связаться с намиПодключиться

Video API, REST: StreamLine.PerformAction

Статья создана
Обновлена 17 октября 2024 г.

Perform an action on the line.

HTTP request

POST https://video.api.cloud.yandex.net/video/v1/streamLines/{streamLineId}:performAction

Path parameters

Field

Description

streamLineId

string

Required field. ID of the line.

Body parameters

{
  // Includes only one of the fields `activate`, `deactivate`
  "activate": "object",
  "deactivate": "object"
  // end of the list of possible fields
}

Field

Description

activate

object

Includes only one of the fields activate, deactivate.

deactivate

object

Includes only one of the fields activate, deactivate.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "streamLineId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "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": "object",
    "autoLine": {
      "status": "string"
    },
    // end of the list of possible fields
    "createdAt": "string",
    "updatedAt": "string",
    "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

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

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

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

streamLineId

string

ID of the line.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

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

RTMPPushInput

RTMP push input type.

Includes only one of the fields rtmpPush, srtPush, rtmpPull, srtPull, tcpPull, rtspPull.

Video signal settings.

srtPush

SRTPushInput

SRT push input type.

Includes only one of the fields rtmpPush, srtPush, rtmpPull, srtPull, tcpPull, rtspPull.

Video signal settings.

rtmpPull

RTMPPullInput

RTMP pull input type.

Includes only one of the fields rtmpPush, srtPush, rtmpPull, srtPull, tcpPull, rtspPull.

Video signal settings.

srtPull

SRTPullInput

SRT pull input type.

Includes only one of the fields rtmpPush, srtPush, rtmpPull, srtPull, tcpPull, rtspPull.

Video signal settings.

tcpPull

TCPPullInput

TCP pull input type.

Includes only one of the fields rtmpPush, srtPush, rtmpPull, srtPull, tcpPull, rtspPull.

Video signal settings.

rtspPull

RTSPPullInput

RTSP pull input type.

Includes only one of the fields rtmpPush, srtPush, rtmpPull, srtPull, tcpPull, rtspPull.

Video signal settings.

manualLine

object

Manual control of stream.

Includes only one of the fields manualLine, autoLine.

Line type.

autoLine

AutoLine

Automatic control of stream.

Includes only one of the fields manualLine, autoLine.

Line type.

createdAt

string (date-time)

Time when line was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updatedAt

string (date-time)

Time of last line update.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

labels

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.

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.
Предыдущая
Delete
Следующая
GetStreamKey