Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Video API, gRPC: StreamLineService.Update

Written by
Updated at November 25, 2025

Updates an existing stream line's metadata and configuration.
Only fields specified in the field_mask will be updated.

gRPC request

rpc Update (UpdateStreamLineRequest) returns (operation.Operation)

UpdateStreamLineRequest

{
  "stream_line_id": "string",
  "field_mask": "google.protobuf.FieldMask",
  "title": "string",
  // Includes only one of the fields `rtmp_push`, `rtmp_pull`
  "rtmp_push": "RTMPPushParams",
  "rtmp_pull": {
    "url": "string"
  },
  // end of the list of possible fields
  "labels": "map<string, string>"
}

Field

Description

stream_line_id

string

Required field. ID of the line.

The maximum string length in characters is 50.

field_mask

google.protobuf.FieldMask

Required field. Field mask specifying which fields of the stream line should be updated.
Only fields specified in this mask will be modified;
all other fields will retain their current values.
This allows for partial updates.

title

string

Line title.

The maximum string length in characters is 300.

rtmp_push

RTMPPushParams

RTMP push input type.

Includes only one of the fields rtmp_push, rtmp_pull.

Video signal settings.

rtmp_pull

RTMPPullParams

RTMP pull input type.

Includes only one of the fields rtmp_push, rtmp_pull.

Video signal settings.

labels

object (map<string, string>)

New custom labels for the stream line as key:value pairs.
Maximum 64 labels per stream line.
If provided, replaces all existing labels.

No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_.@:/0-9a-zA-Z]*. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*.

RTMPPushParams

Parameters for creating an RTMP push input type stream line.

Field

Description

Empty

RTMPPullParams

Parameters for creating an RTMP pull input type stream line.

Field

Description

url

string

Required field. The RTMP URL from which to pull the video stream.
Must be a valid RTMP URL starting with "rtmp://".

Value must match the regular expression rtmp://.*.

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",
    // 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

UpdateStreamLineMetadata

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.

UpdateStreamLineMetadata

Field

Description

stream_line_id

string

ID of the stream line.

StreamLine

Entity representing 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.

rtmp_push

RTMPPushInput

Real-Time Messaging Protocol (RTMP) push input type.

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 stream control.

Includes only one of the fields manual_line, auto_line.

Specifies the control type of the stream line.

auto_line

AutoLine

Automatic stream control.

Includes only one of the fields manual_line, auto_line.

Specifies the control type of the stream line.

created_at

google.protobuf.Timestamp

Timestamp when the stream line was initially created in the system.

updated_at

google.protobuf.Timestamp

Timestamp of the last modification to the stream line or its metadata.

labels

object (map<string, string>)

Custom user-defined labels as key:value pairs.
Maximum 64 labels per stream line.
Labels can be used for organization, filtering, and metadata purposes.

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.
Previous
Create
Next
Delete