Video API, gRPC: StreamService.Create

Статья создана

Обновлена 28 мая 2026 г.

gRPC request
CreateStreamRequest
OnDemandParams
ScheduleParams
operation.Operation

Creates a new stream in the specified channel.
Streams can be created as on-demand (starting when a signal appears)
or scheduled (starting and finishing at specified time).

gRPC request

rpc Create (CreateStreamRequest) returns (operation.Operation)

CreateStreamRequest

{
  "channel_id": "string",
  "line_id": "string",
  "title": "string",
  "description": "string",
  "thumbnail_id": "string",
  "auto_publish": "google.protobuf.BoolValue",
  "labels": "map<string, string>",
  // Includes only one of the fields `on_demand`, `schedule`
  "on_demand": "OnDemandParams",
  "schedule": {
    "start_time": "google.protobuf.Timestamp",
    "finish_time": "google.protobuf.Timestamp"
  }
  // end of the list of possible fields
}

Field	Description
channel_id	string Required field. ID of the channel where the stream will be created. The maximum string length in characters is 50.
line_id	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.
thumbnail_id	string ID of the thumbnail image to be used for the stream. The maximum string length in characters is 50.
auto_publish	google.protobuf.BoolValue 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.
on_demand	OnDemandParams 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 `on_demand`, `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 `on_demand`, `schedule`. Specifies the stream scheduling type (exactly one must be chosen).

OnDemandParams

On-demand streams start automatically when a video signal is detected
and must be manually stopped when no longer needed.

Field	Description
Empty

ScheduleParams

Field

Description

start_time

google.protobuf.Timestamp

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.

finish_time

google.protobuf.Timestamp

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.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any 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	google.rpc.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	google.protobuf.Any 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.

Video API, gRPC: StreamService.Create

gRPC requestgRPC request

CreateStreamRequestCreateStreamRequest

OnDemandParamsOnDemandParams

ScheduleParamsScheduleParams

operation.Operationoperation.Operation

Была ли статья полезна?

gRPC request

CreateStreamRequest

OnDemandParams

ScheduleParams

operation.Operation