Video API, REST: Stream.Create

Field

Description

channelId

string

Required field. ID of the channel where the stream will be created.

The maximum string length in characters is 50.

lineId

string

Required field. ID of the stream line to which this stream will be linked.
Stream lines define the technical configuration for streaming.

The maximum string length in characters is 50.

title

string

Required field. Title of the stream to be displayed in interfaces and players.

The maximum string length in characters is 300.

description

string

Detailed description of the stream content and context.
Optional field that can provide additional information about the stream.

The maximum string length in characters is 4000.

thumbnailId

string

ID of the thumbnail image to be used for the stream.

The maximum string length in characters is 50.

autoPublish

boolean

Controls whether the stream is automatically published when ready.
When set to true, the stream's status will automatically change from
READY to ONAIR when the streaming infrastructure is prepared,
making it available for viewing without manual intervention.

labels

object (map<string, string>)

Custom user-defined labels as key:value pairs.
Maximum 64 labels per stream.
Keys must be lowercase alphanumeric strings with optional hyphens/underscores.
Values can contain alphanumeric characters and various symbols.

The maximum string length in characters for each value is 63. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*. Each value must match the regular expression [-_.@:/0-9a-zA-Z]*. No more than 64 per resource.

onDemand

object

On-demand stream that starts immediately when a video signal appears.
This type of stream has no predetermined start or end time.

Includes only one of the fields onDemand, schedule.

Specifies the stream scheduling type (exactly one must be chosen).

schedule

ScheduleParams

Scheduled stream that starts and finishes at specified time.
This type of stream has predetermined start and end time.

Includes only one of the fields onDemand, schedule.

Specifies the stream scheduling type (exactly one must be chosen).

Field

Description

startTime

string (date-time)

Required field. Scheduled time when the stream should automatically start.
The streaming infrastructure will be prepared at this time
and will begin accepting the video signal.

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).

finishTime

string (date-time)

Required field. Scheduled time when the stream should automatically finish.
The streaming infrastructure will be shut down at this time
and the stream will be marked as FINISHED.

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).

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

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).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

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).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

object

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

object

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.