Video API, REST: StreamLine.List

Field

Description

channelId

string

Required field. ID of the channel.

pageSize

string (int64)

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

pageToken

string

Page token for getting the next page of the result.

orderBy

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.

Field

Description

streamLines[]

StreamLine

List of lines for channel.

nextPageToken

string

Token for getting the next page.

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.

thumbnailId

string

ID of the thumbnail image associated with the stream line..

rtmpPush

RTMPPushInput

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

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

Includes only one of the fields manualLine, autoLine.

Specifies the control type of the stream line.

autoLine

AutoLine

Automatic control of stream.

Includes only one of the fields manualLine, autoLine.

Specifies the control type of the stream line.

createdAt

string (date-time)

Time when the stream line was created.

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)

Time when the stream line was last updated.

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 labels as key:value pairs. Maximum 64 per resource.

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.