Video API, gRPC: VideoService.Create
Create video.
gRPC request
rpc Create (CreateVideoRequest) returns (operation.Operation)
CreateVideoRequest
{
"channelId": "string",
"title": "string",
"description": "string",
"thumbnailId": "string",
"labels": "string",
// Includes only one of the fields `tusd`
"tusd": {
"fileSize": "int64",
"fileName": "string"
},
// end of the list of possible fields
// Includes only one of the fields `publicAccess`, `authSystemAccess`
"publicAccess": "VideoPublicAccessParams",
"authSystemAccess": "VideoAuthSystemAccessParams"
// end of the list of possible fields
}
Field |
Description |
channelId |
string ID of the channel. |
title |
string Video title. |
description |
string Video description. |
thumbnailId |
string ID of the thumbnail. |
labels |
string Custom labels as |
tusd |
Upload video using the tus protocol. Includes only one of the fields Source type. |
publicAccess |
Video is available to everyone. Includes only one of the fields Video access rights. |
authSystemAccess |
Checking access rights using the authorization system. Includes only one of the fields Video access rights. |
VideoTUSDParams
Field |
Description |
fileSize |
int64 File size. |
fileName |
string File name. |
VideoPublicAccessParams
Field |
Description |
Empty |
VideoAuthSystemAccessParams
Field |
Description |
Empty |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"videoId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"channelId": "string",
"title": "string",
"description": "string",
"thumbnailId": "string",
"status": "VideoStatus",
"duration": "google.protobuf.Duration",
"visibilityStatus": "VisibilityStatus",
// Includes only one of the fields `tusd`
"tusd": {
"url": "string"
},
// end of the list of possible fields
// Includes only one of the fields `publicAccess`, `authSystemAccess`
"publicAccess": "VideoPublicAccessRights",
"authSystemAccess": "VideoAuthSystemAccessRights",
// end of the list of possible fields
"createdAt": "google.protobuf.Timestamp",
"updatedAt": "google.protobuf.Timestamp",
"labels": "string"
}
// 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. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
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. |
CreateVideoMetadata
Field |
Description |
videoId |
string ID of the video. |
Video
Field |
Description |
id |
string ID of the video. |
channelId |
string ID of the channel where the video was created. |
title |
string Video title. |
description |
string Video description. |
thumbnailId |
string ID of the thumbnail. |
status |
enum VideoStatus Video status.
|
duration |
Video duration. Optional, may be empty until the transcoding result is ready. |
visibilityStatus |
enum VisibilityStatus Video visibility status.
|
tusd |
Upload video using the tus protocol. Includes only one of the fields Source type. |
publicAccess |
Video is available to everyone. Includes only one of the fields Video access rights. |
authSystemAccess |
Checking access rights using the authorization system. Includes only one of the fields Video access rights. |
createdAt |
Time when video was created. |
updatedAt |
Time of last video update. |
labels |
string Custom labels as |
VideoTUSDSource
Field |
Description |
url |
string URL for uploading video via the tus protocol. |
VideoPublicAccessRights
Field |
Description |
Empty |
VideoAuthSystemAccessRights
Field |
Description |
Empty |