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

Video API, gRPC: StreamLineService.List

Статья создана
Обновлена 25 ноября 2025 г.

Lists all stream lines in a specific channel with pagination support.
Results can be filtered and sorted using the provided parameters.

gRPC request

rpc List (ListStreamLinesRequest) returns (ListStreamLinesResponse)

ListStreamLinesRequest

{
  "channel_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "order_by": "string",
  "filter": "string"
}

Field

Description

channel_id

string

Required field. ID of the channel containing the stream lines to list.

The maximum string length in characters is 50.

page_size

int64

The maximum number of stream lines to return per page.

The maximum value is 100.

page_token

string

Page token for retrieving the next page of results.
This token is obtained from the next_page_token field in the previous ListStreamLinesResponse.

The maximum string length in characters is 15000.

order_by

string

Specifies the ordering of results.
Format is "<field> <order>" (e.g., "createdAt desc").
Default: "id asc".
Supported fields: ["id", "title", "createdAt", "updatedAt"].
Both snake_case and camelCase field names are supported.

The maximum string length in characters is 50.

filter

string

Filter expression to narrow down the list of returned stream lines.
Expressions consist of terms connected by logical operators.
Values containing spaces or quotes must be enclosed in quotes (' or ")
with inner quotes being backslash-escaped.

Supported logical operators: ["AND", "OR"].
Supported comparison operators: ["=", "!=", ":"] where ":" enables substring matching.
Parentheses can be used to group logical expressions.

Example: title:'main' AND id='line-1'

Filterable fields: ["id", "title"].
Both snake_case and camelCase field names are supported.

The maximum string length in characters is 1000.

ListStreamLinesResponse

{
  "stream_lines": [
    {
      "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>"
    }
  ],
  "next_page_token": "string"
}

Field

Description

stream_lines[]

StreamLine

List of stream lines matching the request criteria.
May be empty if no stream lines match the criteria or if the channel has no stream lines.

next_page_token

string

Token for retrieving the next page of results.
Empty if there are no more results available.

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