Video API, gRPC: VideoService
Video management service.
Call | Description |
---|---|
Get | Returns the specific video. |
List | List videos for channel. |
Create | Create video. |
Update | Update video. |
Delete | Delete video. |
PerformAction | Perform an action on the episode. |
GetPlayerURL | Returns url to the player. |
GetManifests | Returns manifest urls. |
Calls VideoService
Get
Returns the specific video.
rpc Get (GetVideoRequest) returns (Video)
GetVideoRequest
Field | Description |
---|---|
video_id | string ID of the video. |
Video
Field | Description |
---|---|
id | string ID of the video. |
channel_id | string ID of the channel where the video was created. |
title | string Video title. |
description | string Video description. |
thumbnail_id | string ID of the thumbnail. |
status | enum VideoStatus Video status.
|
duration | google.protobuf.Duration Video duration. Optional, may be empty until the transcoding result is ready. |
visibility_status | enum VisibilityStatus Video visibility status.
|
source | oneof: tusd Source type. |
tusd | VideoTUSDSource Upload video using the tus protocol. |
access_rights | oneof: public_access or auth_system_access Video access rights. |
public_access | VideoPublicAccessRights Video is available to everyone. |
auth_system_access | VideoAuthSystemAccessRights Checking access rights using the authorization system. |
created_at | google.protobuf.Timestamp Time when video was created. |
updated_at | google.protobuf.Timestamp Time of last video update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
VideoTUSDSource
Field | Description |
---|---|
url | string URL for uploading video via the tus protocol. |
VideoPublicAccessRights
Empty.
VideoAuthSystemAccessRights
Empty.
List
List videos for channel.
rpc List (ListVideoRequest) returns (ListVideoResponse)
ListVideoRequest
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", "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", "status", "visibility_status"] Both snake_case and camelCase are supported for fields. |
ListVideoResponse
Field | Description |
---|---|
videos[] | Video |
next_page_token | string Token for getting the next page. |
Video
Field | Description |
---|---|
id | string ID of the video. |
channel_id | string ID of the channel where the video was created. |
title | string Video title. |
description | string Video description. |
thumbnail_id | string ID of the thumbnail. |
status | enum VideoStatus Video status.
|
duration | google.protobuf.Duration Video duration. Optional, may be empty until the transcoding result is ready. |
visibility_status | enum VisibilityStatus Video visibility status.
|
source | oneof: tusd Source type. |
tusd | VideoTUSDSource Upload video using the tus protocol. |
access_rights | oneof: public_access or auth_system_access Video access rights. |
public_access | VideoPublicAccessRights Video is available to everyone. |
auth_system_access | VideoAuthSystemAccessRights Checking access rights using the authorization system. |
created_at | google.protobuf.Timestamp Time when video was created. |
updated_at | google.protobuf.Timestamp Time of last video update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
VideoTUSDSource
Field | Description |
---|---|
url | string URL for uploading video via the tus protocol. |
VideoPublicAccessRights
Empty.
VideoAuthSystemAccessRights
Empty.
Create
Create video.
rpc Create (CreateVideoRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateVideoMetadata
Operation.response:Video
CreateVideoRequest
Field | Description |
---|---|
channel_id | string ID of the channel. |
title | string Video title. |
description | string Video description. |
thumbnail_id | string ID of the thumbnail. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
source | oneof: tusd Source type. |
tusd | VideoTUSDParams Upload video using the tus protocol. |
access_rights | oneof: public_access or auth_system_access Video access rights. |
public_access | VideoPublicAccessParams Video is available to everyone. |
auth_system_access | VideoAuthSystemAccessParams Checking access rights using the authorization system. |
VideoTUSDParams
Field | Description |
---|---|
file_size | int64 File size. |
file_name | string File name. |
VideoPublicAccessParams
Empty.
VideoAuthSystemAccessParams
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. |
CreateVideoMetadata
Field | Description |
---|---|
video_id | string ID of the video. |
Video
Field | Description |
---|---|
id | string ID of the video. |
channel_id | string ID of the channel where the video was created. |
title | string Video title. |
description | string Video description. |
thumbnail_id | string ID of the thumbnail. |
status | enum VideoStatus Video status.
|
duration | google.protobuf.Duration Video duration. Optional, may be empty until the transcoding result is ready. |
visibility_status | enum VisibilityStatus Video visibility status.
|
source | oneof: tusd Source type. |
tusd | VideoTUSDSource Upload video using the tus protocol. |
access_rights | oneof: public_access or auth_system_access Video access rights. |
public_access | VideoPublicAccessRights Video is available to everyone. |
auth_system_access | VideoAuthSystemAccessRights Checking access rights using the authorization system. |
created_at | google.protobuf.Timestamp Time when video was created. |
updated_at | google.protobuf.Timestamp Time of last video update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
VideoTUSDSource
Field | Description |
---|---|
url | string URL for uploading video via the tus protocol. |
VideoPublicAccessRights
Empty.
VideoAuthSystemAccessRights
Empty.
Update
Update video.
rpc Update (UpdateVideoRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateVideoMetadata
Operation.response:Video
UpdateVideoRequest
Field | Description |
---|---|
video_id | string ID of the video. |
field_mask | google.protobuf.FieldMask Field mask that specifies which fields of the video are going to be updated. |
title | string Video title. |
description | string Video description. |
thumbnail_id | string ID of the thumbnail. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
access_rights | oneof: public_access or auth_system_access |
public_access | VideoPublicAccessParams |
auth_system_access | VideoAuthSystemAccessParams |
VideoPublicAccessParams
Empty.
VideoAuthSystemAccessParams
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. |
UpdateVideoMetadata
Field | Description |
---|---|
video_id | string ID of the video. |
Video
Field | Description |
---|---|
id | string ID of the video. |
channel_id | string ID of the channel where the video was created. |
title | string Video title. |
description | string Video description. |
thumbnail_id | string ID of the thumbnail. |
status | enum VideoStatus Video status.
|
duration | google.protobuf.Duration Video duration. Optional, may be empty until the transcoding result is ready. |
visibility_status | enum VisibilityStatus Video visibility status.
|
source | oneof: tusd Source type. |
tusd | VideoTUSDSource Upload video using the tus protocol. |
access_rights | oneof: public_access or auth_system_access Video access rights. |
public_access | VideoPublicAccessRights Video is available to everyone. |
auth_system_access | VideoAuthSystemAccessRights Checking access rights using the authorization system. |
created_at | google.protobuf.Timestamp Time when video was created. |
updated_at | google.protobuf.Timestamp Time of last video update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
VideoTUSDSource
Field | Description |
---|---|
url | string URL for uploading video via the tus protocol. |
VideoPublicAccessRights
Empty.
VideoAuthSystemAccessRights
Empty.
Delete
Delete video.
rpc Delete (DeleteVideoRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteVideoMetadata
Operation.response:google.protobuf.Empty
DeleteVideoRequest
Field | Description |
---|---|
video_id | string ID of the video. |
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. |
DeleteVideoMetadata
Field | Description |
---|---|
video_id | string ID of the video. |
PerformAction
Perform an action on the episode.
rpc PerformAction (PerformVideoActionRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:PerformVideoActionMetadata
Operation.response:Video
PerformVideoActionRequest
Field | Description |
---|---|
video_id | string ID of the video. |
action | oneof: publish or unpublish |
publish | PublishVideoAction |
unpublish | UnpublishVideoAction |
PublishVideoAction
Empty.
UnpublishVideoAction
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. |
PerformVideoActionMetadata
Field | Description |
---|---|
video_id | string ID of the video. |
Video
Field | Description |
---|---|
id | string ID of the video. |
channel_id | string ID of the channel where the video was created. |
title | string Video title. |
description | string Video description. |
thumbnail_id | string ID of the thumbnail. |
status | enum VideoStatus Video status.
|
duration | google.protobuf.Duration Video duration. Optional, may be empty until the transcoding result is ready. |
visibility_status | enum VisibilityStatus Video visibility status.
|
source | oneof: tusd Source type. |
tusd | VideoTUSDSource Upload video using the tus protocol. |
access_rights | oneof: public_access or auth_system_access Video access rights. |
public_access | VideoPublicAccessRights Video is available to everyone. |
auth_system_access | VideoAuthSystemAccessRights Checking access rights using the authorization system. |
created_at | google.protobuf.Timestamp Time when video was created. |
updated_at | google.protobuf.Timestamp Time of last video update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
VideoTUSDSource
Field | Description |
---|---|
url | string URL for uploading video via the tus protocol. |
VideoPublicAccessRights
Empty.
VideoAuthSystemAccessRights
Empty.
GetPlayerURL
Returns url to the player.
rpc GetPlayerURL (GetVideoPlayerURLRequest) returns (GetVideoPlayerURLResponse)
GetVideoPlayerURLRequest
Field | Description |
---|---|
video_id | string ID of the video. |
params | VideoPlayerParams |
VideoPlayerParams
Field | Description |
---|---|
mute | bool If true, a player will be muted by default. |
autoplay | bool If true, playback will start automatically. |
hidden | bool If true, a player interface will be hidden by default. |
GetVideoPlayerURLResponse
Field | Description |
---|---|
player_url | string Direct link to the video. |
html | string HTML embed code in Iframe format. |
GetManifests
Returns manifest urls.
rpc GetManifests (GetVideoManifestsRequest) returns (GetVideoManifestsResponse)
GetVideoManifestsRequest
Field | Description |
---|---|
video_id | string ID of the video. |
GetVideoManifestsResponse
Field | Description |
---|---|
manifests[] | Manifest |
Manifest
Field | Description |
---|---|
url | string |
type | enum ManifestType |