Video API, gRPC: StreamLineService
Stream line management service.
Call | Description |
---|---|
Get | Returns the specific stream line. |
List | List lines for channel. |
Create | Create stream line. |
Update | Update stream line. |
Delete | Delete stream line. |
PerformAction | Perform an action on the line. |
GetStreamKey | Returns unique stream key. |
UpdateStreamKey | Change stream key. |
Calls StreamLineService
Get
Returns the specific stream line.
rpc Get (GetStreamLineRequest) returns (StreamLine)
GetStreamLineRequest
Field | Description |
---|---|
stream_line_id | string ID of the line. |
StreamLine
Field | Description |
---|---|
id | string ID of the line. |
channel_id | string ID of the channel where the line was created. |
title | string Line title. |
thumbnail_id | string ID of the thumbnail. |
input_type | oneof: rtmp_push , srt_push , rtmp_pull , srt_pull , tcp_pull or rtsp_pull Video signal settings. |
rtmp_push | RTMPPushInput RTMP push input type. |
srt_push | SRTPushInput SRT push input type. |
rtmp_pull | RTMPPullInput RTMP pull input type. |
srt_pull | SRTPullInput SRT pull input type. |
tcp_pull | TCPPullInput TCP pull input type. |
rtsp_pull | RTSPPullInput RTSP pull input type. |
line_type | oneof: manual_line or auto_line Line type. |
manual_line | ManualLine Manual control of stream. |
auto_line | AutoLine Automatic control of stream. |
created_at | google.protobuf.Timestamp Time when line was created. |
updated_at | google.protobuf.Timestamp Time of last line update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
RTMPPushInput
Field | Description |
---|---|
url | string RTMP server url. |
SRTPushInput
Field | Description |
---|---|
url | string SRT server url. |
RTMPPullInput
Field | Description |
---|---|
url | string RTMP url for receiving video signal. |
SRTPullInput
Field | Description |
---|---|
url | string SRT url for receiving video signal. |
TCPPullInput
Field | Description |
---|---|
url | string TCP url for receiving video signal. |
RTSPPullInput
Field | Description |
---|---|
url | string RTSP url for receiving video signal. |
ManualLine
Empty.
AutoLine
Field | Description |
---|---|
status | enum AutoLineStatus Status of auto line.
|
List
List lines for channel.
rpc List (ListStreamLinesRequest) returns (ListStreamLinesResponse)
ListStreamLinesRequest
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", "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. |
ListStreamLinesResponse
Field | Description |
---|---|
stream_lines[] | StreamLine List of lines for channel. |
next_page_token | string Token for getting the next page. |
StreamLine
Field | Description |
---|---|
id | string ID of the line. |
channel_id | string ID of the channel where the line was created. |
title | string Line title. |
thumbnail_id | string ID of the thumbnail. |
input_type | oneof: rtmp_push , srt_push , rtmp_pull , srt_pull , tcp_pull or rtsp_pull Video signal settings. |
rtmp_push | RTMPPushInput RTMP push input type. |
srt_push | SRTPushInput SRT push input type. |
rtmp_pull | RTMPPullInput RTMP pull input type. |
srt_pull | SRTPullInput SRT pull input type. |
tcp_pull | TCPPullInput TCP pull input type. |
rtsp_pull | RTSPPullInput RTSP pull input type. |
line_type | oneof: manual_line or auto_line Line type. |
manual_line | ManualLine Manual control of stream. |
auto_line | AutoLine Automatic control of stream. |
created_at | google.protobuf.Timestamp Time when line was created. |
updated_at | google.protobuf.Timestamp Time of last line update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
RTMPPushInput
Field | Description |
---|---|
url | string RTMP server url. |
SRTPushInput
Field | Description |
---|---|
url | string SRT server url. |
RTMPPullInput
Field | Description |
---|---|
url | string RTMP url for receiving video signal. |
SRTPullInput
Field | Description |
---|---|
url | string SRT url for receiving video signal. |
TCPPullInput
Field | Description |
---|---|
url | string TCP url for receiving video signal. |
RTSPPullInput
Field | Description |
---|---|
url | string RTSP url for receiving video signal. |
ManualLine
Empty.
AutoLine
Field | Description |
---|---|
status | enum AutoLineStatus Status of auto line.
|
Create
Create stream line.
rpc Create (CreateStreamLineRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateStreamLineMetadata
Operation.response:StreamLine
CreateStreamLineRequest
Field | Description |
---|---|
channel_id | string ID of the channel. |
title | string Line title. |
thumbnail_id | string ID of the thumbnail. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
input_params | oneof: rtmp_push , srt_push , rtmp_pull , srt_pull , tcp_pull or rtsp_pull Video signal settings. |
rtmp_push | RTMPPushParams RTMP push input type. |
srt_push | SRTPushParams SRT push input type. |
rtmp_pull | RTMPPullParams RTMP pull input type. |
srt_pull | SRTPullParams SRT pull input type. |
tcp_pull | TCPPullParams TCP pull input type. |
rtsp_pull | RTSPPullParams RTSP pull input type. |
line_type_params | oneof: manual_line or auto_line Line type. |
manual_line | ManualLineParams Manual control of stream. |
auto_line | AutoLineParams Automatic control of stream. |
RTMPPushParams
Empty.
SRTPushParams
Empty.
RTMPPullParams
Field | Description |
---|---|
url | string URL of a RTMP streaming server. |
SRTPullParams
Field | Description |
---|---|
url | string URL of a SRT streaming server. |
TCPPullParams
Field | Description |
---|---|
url | string URL of a TCP streaming server. |
RTSPPullParams
Field | Description |
---|---|
url | string URL of a RTSP streaming server. |
ManualLineParams
Empty.
AutoLineParams
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. |
CreateStreamLineMetadata
Field | Description |
---|---|
stream_line_id | string ID of the line. |
StreamLine
Field | Description |
---|---|
id | string ID of the line. |
channel_id | string ID of the channel where the line was created. |
title | string Line title. |
thumbnail_id | string ID of the thumbnail. |
input_type | oneof: rtmp_push , srt_push , rtmp_pull , srt_pull , tcp_pull or rtsp_pull Video signal settings. |
rtmp_push | RTMPPushInput RTMP push input type. |
srt_push | SRTPushInput SRT push input type. |
rtmp_pull | RTMPPullInput RTMP pull input type. |
srt_pull | SRTPullInput SRT pull input type. |
tcp_pull | TCPPullInput TCP pull input type. |
rtsp_pull | RTSPPullInput RTSP pull input type. |
line_type | oneof: manual_line or auto_line Line type. |
manual_line | ManualLine Manual control of stream. |
auto_line | AutoLine Automatic control of stream. |
created_at | google.protobuf.Timestamp Time when line was created. |
updated_at | google.protobuf.Timestamp Time of last line update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
RTMPPushInput
Field | Description |
---|---|
url | string RTMP server url. |
SRTPushInput
Field | Description |
---|---|
url | string SRT server url. |
RTMPPullInput
Field | Description |
---|---|
url | string RTMP url for receiving video signal. |
SRTPullInput
Field | Description |
---|---|
url | string SRT url for receiving video signal. |
TCPPullInput
Field | Description |
---|---|
url | string TCP url for receiving video signal. |
RTSPPullInput
Field | Description |
---|---|
url | string RTSP url for receiving video signal. |
ManualLine
Empty.
AutoLine
Field | Description |
---|---|
status | enum AutoLineStatus Status of auto line.
|
Update
Update stream line.
rpc Update (UpdateStreamLineRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateStreamLineMetadata
Operation.response:StreamLine
UpdateStreamLineRequest
Field | Description |
---|---|
stream_line_id | string ID of the line. |
field_mask | google.protobuf.FieldMask Field mask that specifies which fields of the line are going to be updated. |
title | string Line title. |
thumbnail_id | string ID of the thumbnail. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
input_params | oneof: rtmp_push , srt_push , rtmp_pull , srt_pull , tcp_pull or rtsp_pull Video signal settings. |
rtmp_push | RTMPPushParams RTMP push input type. |
srt_push | SRTPushParams SRT push input type. |
rtmp_pull | RTMPPullParams RTMP pull input type. |
srt_pull | SRTPullParams SRT pull input type. |
tcp_pull | TCPPullParams TCP pull input type. |
rtsp_pull | RTSPPullParams RTSP pull input type. |
RTMPPushParams
Empty.
SRTPushParams
Empty.
RTMPPullParams
Field | Description |
---|---|
url | string URL of a RTMP streaming server. |
SRTPullParams
Field | Description |
---|---|
url | string URL of a SRT streaming server. |
TCPPullParams
Field | Description |
---|---|
url | string URL of a TCP streaming server. |
RTSPPullParams
Field | Description |
---|---|
url | string URL of a RTSP streaming server. |
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. |
UpdateStreamLineMetadata
Field | Description |
---|---|
stream_line_id | string ID of the line. |
StreamLine
Field | Description |
---|---|
id | string ID of the line. |
channel_id | string ID of the channel where the line was created. |
title | string Line title. |
thumbnail_id | string ID of the thumbnail. |
input_type | oneof: rtmp_push , srt_push , rtmp_pull , srt_pull , tcp_pull or rtsp_pull Video signal settings. |
rtmp_push | RTMPPushInput RTMP push input type. |
srt_push | SRTPushInput SRT push input type. |
rtmp_pull | RTMPPullInput RTMP pull input type. |
srt_pull | SRTPullInput SRT pull input type. |
tcp_pull | TCPPullInput TCP pull input type. |
rtsp_pull | RTSPPullInput RTSP pull input type. |
line_type | oneof: manual_line or auto_line Line type. |
manual_line | ManualLine Manual control of stream. |
auto_line | AutoLine Automatic control of stream. |
created_at | google.protobuf.Timestamp Time when line was created. |
updated_at | google.protobuf.Timestamp Time of last line update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
RTMPPushInput
Field | Description |
---|---|
url | string RTMP server url. |
SRTPushInput
Field | Description |
---|---|
url | string SRT server url. |
RTMPPullInput
Field | Description |
---|---|
url | string RTMP url for receiving video signal. |
SRTPullInput
Field | Description |
---|---|
url | string SRT url for receiving video signal. |
TCPPullInput
Field | Description |
---|---|
url | string TCP url for receiving video signal. |
RTSPPullInput
Field | Description |
---|---|
url | string RTSP url for receiving video signal. |
ManualLine
Empty.
AutoLine
Field | Description |
---|---|
status | enum AutoLineStatus Status of auto line.
|
Delete
Delete stream line.
rpc Delete (DeleteStreamLineRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteStreamLineMetadata
Operation.response:google.protobuf.Empty
DeleteStreamLineRequest
Field | Description |
---|---|
stream_line_id | string ID of the line. |
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. |
DeleteStreamLineMetadata
Field | Description |
---|---|
stream_line_id | string ID of the line. |
PerformAction
Perform an action on the line.
rpc PerformAction (PerformLineActionRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:PerformLineActionMetadata
Operation.response:StreamLine
PerformLineActionRequest
Field | Description |
---|---|
stream_line_id | string ID of the line. |
action | oneof: activate or deactivate |
activate | ActivateAction |
deactivate | DeactivateAction |
ActivateAction
Empty.
DeactivateAction
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. |
PerformLineActionMetadata
Field | Description |
---|---|
stream_line_id | string ID of the line. |
StreamLine
Field | Description |
---|---|
id | string ID of the line. |
channel_id | string ID of the channel where the line was created. |
title | string Line title. |
thumbnail_id | string ID of the thumbnail. |
input_type | oneof: rtmp_push , srt_push , rtmp_pull , srt_pull , tcp_pull or rtsp_pull Video signal settings. |
rtmp_push | RTMPPushInput RTMP push input type. |
srt_push | SRTPushInput SRT push input type. |
rtmp_pull | RTMPPullInput RTMP pull input type. |
srt_pull | SRTPullInput SRT pull input type. |
tcp_pull | TCPPullInput TCP pull input type. |
rtsp_pull | RTSPPullInput RTSP pull input type. |
line_type | oneof: manual_line or auto_line Line type. |
manual_line | ManualLine Manual control of stream. |
auto_line | AutoLine Automatic control of stream. |
created_at | google.protobuf.Timestamp Time when line was created. |
updated_at | google.protobuf.Timestamp Time of last line update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
RTMPPushInput
Field | Description |
---|---|
url | string RTMP server url. |
SRTPushInput
Field | Description |
---|---|
url | string SRT server url. |
RTMPPullInput
Field | Description |
---|---|
url | string RTMP url for receiving video signal. |
SRTPullInput
Field | Description |
---|---|
url | string SRT url for receiving video signal. |
TCPPullInput
Field | Description |
---|---|
url | string TCP url for receiving video signal. |
RTSPPullInput
Field | Description |
---|---|
url | string RTSP url for receiving video signal. |
ManualLine
Empty.
AutoLine
Field | Description |
---|---|
status | enum AutoLineStatus Status of auto line.
|
GetStreamKey
Returns unique stream key.
rpc GetStreamKey (GetStreamKeyRequest) returns (PushStreamKey)
GetStreamKeyRequest
Field | Description |
---|---|
stream_line_id | string ID of the line. |
PushStreamKey
Field | Description |
---|---|
key | string Unique stream key. |
UpdateStreamKey
Change stream key.
rpc UpdateStreamKey (UpdateStreamKeyRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateStreamKeyMetadata
Operation.response:PushStreamKey
UpdateStreamKeyRequest
Field | Description |
---|---|
stream_line_id | string ID of the line. |
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. |
UpdateStreamKeyMetadata
Field | Description |
---|---|
stream_line_id | string ID of the line. |
PushStreamKey
Field | Description |
---|---|
key | string Unique stream key. |