Video API, REST: StreamLine.List

Field

Description

channelId

string

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

pageSize

string (int64)

The maximum number of stream lines to return per page.

pageToken

string

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

orderBy

string

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

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.

Field

Description

streamLines[]

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.

nextPageToken

string

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

Field

Description

id

string

ID of the line.

channelId

string

ID of the channel to which this stream line belongs.

title

string

Title of the stream line.

rtmpPush

RTMPPushInput

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

Includes only one of the fields rtmpPush, rtmpPull.

Specifies the input type and settings for the video signal source.

rtmpPull

RTMPPullInput

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

Includes only one of the fields rtmpPush, rtmpPull.

Specifies the input type and settings for the video signal source.

manualLine

object

Manual stream control.

Includes only one of the fields manualLine, autoLine.

Specifies the control type of the stream line.

autoLine

AutoLine

Automatic stream control.

Includes only one of the fields manualLine, autoLine.

Specifies the control type of the stream line.

createdAt

string (date-time)

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

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)

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

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

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.

Field

Description

url

string

RTMP server url.

Field

Description

url

string

RTMP url for receiving video signal.

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.