Video API, gRPC: StreamService.PerformAction
Performs a specific action on a stream, such as publishing or stopping.
Actions change the stream's state without modifying its content or metadata.
gRPC request
rpc PerformAction (PerformStreamActionRequest) returns (operation.Operation)
PerformStreamActionRequest
{
"stream_id": "string",
// Includes only one of the fields `publish`, `stop`
"publish": "PublishAction",
"stop": "StopAction"
// end of the list of possible fields
}
|
Field |
Description |
|
stream_id |
string Required field. ID of the stream on which to perform the action. The maximum string length in characters is 50. |
|
publish |
Publish the stream, changing its status from READY to ONAIR. Includes only one of the fields Specifies which action to perform on the stream (exactly one must be chosen). |
|
stop |
Stop the stream, changing its status to FINISHED. Includes only one of the fields Specifies which action to perform on the stream (exactly one must be chosen). |
PublishAction
Parameters for the publish action.
The action changes the stream's status from READY to ONAIR.
|
Field |
Description |
|
Empty |
|
StopAction
Parameters for the stop action.
The action changes the stream's status to FINISHED.
|
Field |
Description |
|
Empty |
|
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 |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |