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 "createdAt desc". "id asc" if omitted.
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.
Value in quotes: ' or "
Example: "key1='value' AND key2='value'"
Supported operators: ["AND"].
Supported fields: ["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 where the line was created.

title

string

Line title.

thumbnailId

string

ID of the thumbnail.

rtmpPush

RTMPPushInput

RTMP push input type.

Includes only one of the fields rtmpPush, srtPush, rtmpPull, srtPull, tcpPull, rtspPull.

Video signal settings.

srtPush

SRTPushInput

SRT push input type.

Includes only one of the fields rtmpPush, srtPush, rtmpPull, srtPull, tcpPull, rtspPull.

Video signal settings.

rtmpPull

RTMPPullInput

RTMP pull input type.

Includes only one of the fields rtmpPush, srtPush, rtmpPull, srtPull, tcpPull, rtspPull.

Video signal settings.

srtPull

SRTPullInput

SRT pull input type.

Includes only one of the fields rtmpPush, srtPush, rtmpPull, srtPull, tcpPull, rtspPull.

Video signal settings.

tcpPull

TCPPullInput

TCP pull input type.

Includes only one of the fields rtmpPush, srtPush, rtmpPull, srtPull, tcpPull, rtspPull.

Video signal settings.

rtspPull

RTSPPullInput

RTSP pull input type.

Includes only one of the fields rtmpPush, srtPush, rtmpPull, srtPull, tcpPull, rtspPull.

Video signal settings.

manualLine

object

Manual control of stream.

Includes only one of the fields manualLine, autoLine.

Line type.

autoLine

AutoLine

Automatic control of stream.

Includes only one of the fields manualLine, autoLine.

Line type.

createdAt

string (date-time)

Time when 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 of last line update.

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

SRT server url.

Field

Description

url

string

RTMP url for receiving video signal.

Field

Description

url

string

SRT url for receiving video signal.

Field

Description

url

string

TCP url for receiving video signal.

Field

Description

url

string

RTSP url for receiving video signal.

Field

Description

status

enum (AutoLineStatus)

Status of auto line.

• AUTO_LINE_STATUS_UNSPECIFIED: Auto line status unspecified.
• DEACTIVATED: Auto line deactivated.
• ACTIVE: Auto line active.