Contact UsGet started

Video API, gRPC: StreamLineService.List

Written by
Updated at April 24, 2025

List lines for channel.

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.

page_size

int64

The maximum number of the results per page to return.
Default value: 100.

page_token

string

Page token for getting the next page of the result.

order_by

string

By which column the listing should be ordered and in which direction,
format is " " (e.g. "createdAt desc").
Default: "id asc".
Possible fields: ["id", "title", "createdAt", "updatedAt"].
Both snake_case and camelCase are supported for fields.

filter

string

Filter expression that filters resources listed in the response.
Expressions are composed of terms connected by logic operators.
If value contains spaces or quotes,
it should be in quotes (' or ") with the inner quotes being backslash escaped.
Supported logical operators: ["AND", "OR"].
Supported string match operators: ["=", "!=", ":"].
Operator ":" stands for substring matching.
Filter expressions may also contain parentheses to group logical operands.
Example: key1='value' AND (key2!='\'value\'' OR key2:"\"value\"")
Supported fields: ["id", "title"].
Both snake_case and camelCase are supported for fields.

ListStreamLinesResponse

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

Field

Description

stream_lines[]

StreamLine

List of lines for channel.

next_page_token

string

Token for getting the next page.

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.
Previous
Get
Next
BatchGet