Video API, gRPC: StreamLineService.Create

Written by

Yandex Cloud

Updated at October 17, 2024

gRPC request
CreateStreamLineRequest
RTMPPushParams
SRTPushParams
RTMPPullParams
SRTPullParams
TCPPullParams
RTSPPullParams
ManualLineParams
AutoLineParams
operation.Operation
CreateStreamLineMetadata
StreamLine
RTMPPushInput
SRTPushInput
RTMPPullInput
SRTPullInput
TCPPullInput
RTSPPullInput
ManualLine
AutoLine

Create stream line.

gRPC request

rpc Create (CreateStreamLineRequest) returns (operation.Operation)

CreateStreamLineRequest

{
  "channelId": "string",
  "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
  // Includes only one of the fields `manualLine`, `autoLine`
  "manualLine": "ManualLineParams",
  "autoLine": "AutoLineParams"
  // end of the list of possible fields
}

Field	Description
channelId	string ID of the channel.
title	string Line title.
thumbnailId	string ID of the thumbnail.
labels	string Custom labels as `key:value` pairs. Maximum 64 per resource.
rtmpPush	RTMPPushParams RTMP push input type. Includes only one of the fields `rtmpPush`, `srtPush`, `rtmpPull`, `srtPull`, `tcpPull`, `rtspPull`. Video signal settings.
srtPush	SRTPushParams SRT push input type. Includes only one of the fields `rtmpPush`, `srtPush`, `rtmpPull`, `srtPull`, `tcpPull`, `rtspPull`. Video signal settings.
rtmpPull	RTMPPullParams RTMP pull input type. Includes only one of the fields `rtmpPush`, `srtPush`, `rtmpPull`, `srtPull`, `tcpPull`, `rtspPull`. Video signal settings.
srtPull	SRTPullParams SRT pull input type. Includes only one of the fields `rtmpPush`, `srtPush`, `rtmpPull`, `srtPull`, `tcpPull`, `rtspPull`. Video signal settings.
tcpPull	TCPPullParams TCP pull input type. Includes only one of the fields `rtmpPush`, `srtPush`, `rtmpPull`, `srtPull`, `tcpPull`, `rtspPull`. Video signal settings.
rtspPull	RTSPPullParams RTSP pull input type. Includes only one of the fields `rtmpPush`, `srtPush`, `rtmpPull`, `srtPull`, `tcpPull`, `rtspPull`. Video signal settings.
manualLine	ManualLineParams Manual control of stream. Includes only one of the fields `manualLine`, `autoLine`. Line type.
autoLine	AutoLineParams Automatic control of stream. Includes only one of the fields `manualLine`, `autoLine`. Line type.

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.

ManualLineParams

Field	Description
Empty

AutoLineParams

Field	Description
Empty

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	google.protobuf.Timestamp Creation timestamp.
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	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	CreateStreamLineMetadata 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.

CreateStreamLineMetadata

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	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	ManualLine 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	google.protobuf.Timestamp Time when line was created.
updatedAt	google.protobuf.Timestamp Time of last line update.
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.

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.Create

gRPC requestgRPC request

CreateStreamLineRequestCreateStreamLineRequest

RTMPPushParamsRTMPPushParams

SRTPushParamsSRTPushParams

RTMPPullParamsRTMPPullParams

SRTPullParamsSRTPullParams

TCPPullParamsTCPPullParams

RTSPPullParamsRTSPPullParams

ManualLineParamsManualLineParams

AutoLineParamsAutoLineParams

operation.Operationoperation.Operation

CreateStreamLineMetadataCreateStreamLineMetadata

StreamLineStreamLine

RTMPPushInputRTMPPushInput

SRTPushInputSRTPushInput

RTMPPullInputRTMPPullInput

SRTPullInputSRTPullInput

TCPPullInputTCPPullInput

RTSPPullInputRTSPPullInput

ManualLineManualLine

AutoLineAutoLine

Was the article helpful?

gRPC request

CreateStreamLineRequest

RTMPPushParams

SRTPushParams

RTMPPullParams

SRTPullParams

TCPPullParams

RTSPPullParams

ManualLineParams

AutoLineParams

operation.Operation

CreateStreamLineMetadata

StreamLine

RTMPPushInput

SRTPushInput

RTMPPullInput

SRTPullInput

TCPPullInput

RTSPPullInput

ManualLine

AutoLine