Video API, gRPC: StreamService
Stream management service.
Call | Description |
---|---|
Get | Returns the specific stream. |
List | List streams for channel. |
Create | Create stream. |
Update | Update stream. |
Delete | Delete stream. |
PerformAction | Perform an action on the episode. |
Calls StreamService
Get
Returns the specific stream.
rpc Get (GetStreamRequest) returns (Stream)
GetStreamRequest
Field | Description |
---|---|
stream_id | string ID of the stream. |
Stream
Field | Description |
---|---|
id | string ID of the stream. |
channel_id | string ID of the channel where the stream was created. |
line_id | string ID of the line to which stream is linked. |
title | string Stream title. |
description | string Stream description. |
thumbnail_id | string ID of the thumbnail. |
status | enum StreamStatus Stream status.
|
start_time | google.protobuf.Timestamp Stream start time. |
publish_time | google.protobuf.Timestamp Stream publish time. Time when stream switched to ONAIR status. |
finish_time | google.protobuf.Timestamp Stream finish time. |
stream_type | oneof: on_demand or schedule Stream type. |
on_demand | OnDemand On demand stream. It starts immediately when a signal appears. |
schedule | Schedule Schedule stream. Determines when to start receiving the signal or finish time. |
created_at | google.protobuf.Timestamp Time when stream was created. |
updated_at | google.protobuf.Timestamp Time of last stream update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
OnDemand
Empty.
Schedule
Field | Description |
---|---|
start_time | google.protobuf.Timestamp |
finish_time | google.protobuf.Timestamp |
List
List streams for channel.
rpc List (ListStreamsRequest) returns (ListStreamsResponse)
ListStreamsRequest
Field | Description |
---|---|
channel_id | string ID of the channel. |
page_size | int64 The maximum number of the results per page to return. Default value: 100. |
page_token | string Page token for getting the next page of the result. |
order_by | 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", "startTime", "finishTime", "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", "lineId", "status"] Both snake_case and camelCase are supported for fields. |
ListStreamsResponse
Field | Description |
---|---|
streams[] | Stream List of streams for channel. |
next_page_token | string Token for getting the next page. |
Stream
Field | Description |
---|---|
id | string ID of the stream. |
channel_id | string ID of the channel where the stream was created. |
line_id | string ID of the line to which stream is linked. |
title | string Stream title. |
description | string Stream description. |
thumbnail_id | string ID of the thumbnail. |
status | enum StreamStatus Stream status.
|
start_time | google.protobuf.Timestamp Stream start time. |
publish_time | google.protobuf.Timestamp Stream publish time. Time when stream switched to ONAIR status. |
finish_time | google.protobuf.Timestamp Stream finish time. |
stream_type | oneof: on_demand or schedule Stream type. |
on_demand | OnDemand On demand stream. It starts immediately when a signal appears. |
schedule | Schedule Schedule stream. Determines when to start receiving the signal or finish time. |
created_at | google.protobuf.Timestamp Time when stream was created. |
updated_at | google.protobuf.Timestamp Time of last stream update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
OnDemand
Empty.
Schedule
Field | Description |
---|---|
start_time | google.protobuf.Timestamp |
finish_time | google.protobuf.Timestamp |
Create
Create stream.
rpc Create (CreateStreamRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateStreamMetadata
Operation.response:Stream
CreateStreamRequest
Field | Description |
---|---|
channel_id | string ID of the channel. |
line_id | string ID of the line. |
title | string Stream title. |
description | string Stream description. |
thumbnail_id | string ID of the thumbnail. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
stream_type | oneof: on_demand or schedule Stream type. |
on_demand | OnDemandParams On demand stream. It starts immediately when a signal appears. |
schedule | ScheduleParams Schedule stream. Determines when to start receiving the signal or finish time. |
OnDemandParams
Empty.
ScheduleParams
Field | Description |
---|---|
start_time | google.protobuf.Timestamp |
finish_time | google.protobuf.Timestamp |
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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateStreamMetadata
Field | Description |
---|---|
stream_id | string ID of the stream. |
Stream
Field | Description |
---|---|
id | string ID of the stream. |
channel_id | string ID of the channel where the stream was created. |
line_id | string ID of the line to which stream is linked. |
title | string Stream title. |
description | string Stream description. |
thumbnail_id | string ID of the thumbnail. |
status | enum StreamStatus Stream status.
|
start_time | google.protobuf.Timestamp Stream start time. |
publish_time | google.protobuf.Timestamp Stream publish time. Time when stream switched to ONAIR status. |
finish_time | google.protobuf.Timestamp Stream finish time. |
stream_type | oneof: on_demand or schedule Stream type. |
on_demand | OnDemand On demand stream. It starts immediately when a signal appears. |
schedule | Schedule Schedule stream. Determines when to start receiving the signal or finish time. |
created_at | google.protobuf.Timestamp Time when stream was created. |
updated_at | google.protobuf.Timestamp Time of last stream update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
OnDemand
Empty.
Schedule
Field | Description |
---|---|
start_time | google.protobuf.Timestamp |
finish_time | google.protobuf.Timestamp |
Update
Update stream.
rpc Update (UpdateStreamRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateStreamMetadata
Operation.response:Stream
UpdateStreamRequest
Field | Description |
---|---|
stream_id | string ID of the stream. |
field_mask | google.protobuf.FieldMask Field mask that specifies which fields of the stream are going to be updated. |
line_id | string ID of the line. |
title | string Stream title. |
description | string Stream description. |
thumbnail_id | string ID of the thumbnail. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
stream_type | oneof: on_demand or schedule Stream type. |
on_demand | OnDemandParams On demand stream. It starts immediately when a signal appears. |
schedule | ScheduleParams Schedule stream. Determines when to start receiving the signal or finish time. |
OnDemandParams
Empty.
ScheduleParams
Field | Description |
---|---|
start_time | google.protobuf.Timestamp |
finish_time | google.protobuf.Timestamp |
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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateStreamMetadata
Field | Description |
---|---|
stream_id | string ID of the stream. |
Stream
Field | Description |
---|---|
id | string ID of the stream. |
channel_id | string ID of the channel where the stream was created. |
line_id | string ID of the line to which stream is linked. |
title | string Stream title. |
description | string Stream description. |
thumbnail_id | string ID of the thumbnail. |
status | enum StreamStatus Stream status.
|
start_time | google.protobuf.Timestamp Stream start time. |
publish_time | google.protobuf.Timestamp Stream publish time. Time when stream switched to ONAIR status. |
finish_time | google.protobuf.Timestamp Stream finish time. |
stream_type | oneof: on_demand or schedule Stream type. |
on_demand | OnDemand On demand stream. It starts immediately when a signal appears. |
schedule | Schedule Schedule stream. Determines when to start receiving the signal or finish time. |
created_at | google.protobuf.Timestamp Time when stream was created. |
updated_at | google.protobuf.Timestamp Time of last stream update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
OnDemand
Empty.
Schedule
Field | Description |
---|---|
start_time | google.protobuf.Timestamp |
finish_time | google.protobuf.Timestamp |
Delete
Delete stream.
rpc Delete (DeleteStreamRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteStreamMetadata
Operation.response:google.protobuf.Empty
DeleteStreamRequest
Field | Description |
---|---|
stream_id | string ID of the stream. |
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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteStreamMetadata
Field | Description |
---|---|
stream_id | string ID of the stream. |
PerformAction
Perform an action on the episode.
rpc PerformAction (PerformStreamActionRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:PerformStreamActionMetadata
Operation.response:Stream
PerformStreamActionRequest
Field | Description |
---|---|
stream_id | string ID of the stream. |
action | oneof: publish or stop |
publish | PublishAction |
stop | StopAction |
PublishAction
Empty.
StopAction
Empty.
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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
PerformStreamActionMetadata
Field | Description |
---|---|
stream_id | string ID of the stream. |
Stream
Field | Description |
---|---|
id | string ID of the stream. |
channel_id | string ID of the channel where the stream was created. |
line_id | string ID of the line to which stream is linked. |
title | string Stream title. |
description | string Stream description. |
thumbnail_id | string ID of the thumbnail. |
status | enum StreamStatus Stream status.
|
start_time | google.protobuf.Timestamp Stream start time. |
publish_time | google.protobuf.Timestamp Stream publish time. Time when stream switched to ONAIR status. |
finish_time | google.protobuf.Timestamp Stream finish time. |
stream_type | oneof: on_demand or schedule Stream type. |
on_demand | OnDemand On demand stream. It starts immediately when a signal appears. |
schedule | Schedule Schedule stream. Determines when to start receiving the signal or finish time. |
created_at | google.protobuf.Timestamp Time when stream was created. |
updated_at | google.protobuf.Timestamp Time of last stream update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
OnDemand
Empty.
Schedule
Field | Description |
---|---|
start_time | google.protobuf.Timestamp |
finish_time | google.protobuf.Timestamp |