Contact UsGet started

Video API, gRPC: VideoService.List

Written by
Updated at December 17, 2024

List videos for channel.

gRPC request

rpc List (ListVideoRequest) returns (ListVideoResponse)

ListVideoRequest

{
  "channel_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "order_by": "string",
  "filter": "string"
}

Field

Description

channel_id

string

Required field. 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

{
  "videos": [
    {
      "id": "string",
      "channel_id": "string",
      "title": "string",
      "description": "string",
      "thumbnail_id": "string",
      "status": "VideoStatus",
      "duration": "google.protobuf.Duration",
      "visibility_status": "VisibilityStatus",
      "auto_transcode": "AutoTranscode",
      "subtitle_ids": [
        "string"
      ],
      // Includes only one of the fields `tusd`
      "tusd": {
        "url": "string"
      },
      // end of the list of possible fields
      // Includes only one of the fields `public_access`, `auth_system_access`, `sign_url_access`
      "public_access": "VideoPublicAccessRights",
      "auth_system_access": "VideoAuthSystemAccessRights",
      "sign_url_access": "VideoSignURLAccessRights",
      // end of the list of possible fields
      "created_at": "google.protobuf.Timestamp",
      "updated_at": "google.protobuf.Timestamp",
      "labels": "map<string, string>"
    }
  ],
  "next_page_token": "string"
}

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.

  • VIDEO_STATUS_UNSPECIFIED: Video status unspecified.
  • WAIT_UPLOADING: Waiting for the whole number of bytes to be loaded.
  • PROCESSING: Video processing.
  • READY: Video is ready, processing is completed.
  • ERROR: An error occurred during video processing.

duration

google.protobuf.Duration

Video duration. Optional, may be empty until the transcoding result is ready.

visibility_status

enum VisibilityStatus

Video visibility status.

  • VISIBILITY_STATUS_UNSPECIFIED: Visibility status unspecified.
  • PUBLISHED: Video is published and available for viewing.
  • UNPUBLISHED: Video is unpublished, only admin can watch.

auto_transcode

enum AutoTranscode

Auto start transcoding.
If set to ENABLE, transcoding process is initiated automatically after video upload.
If set to DISABLE, manual "Transcode()" call is required instead.

  • AUTO_TRANSCODE_UNSPECIFIED: Unspecified auto transcoding value.
  • ENABLE: Enable auto transcoding.
  • DISABLE: Disable auto transcoding.

subtitle_ids[]

string

IDs of active video subtitles.

tusd

VideoTUSDSource

Upload video using the tus protocol.

Includes only one of the fields tusd.

Source type.

public_access

VideoPublicAccessRights

Video is available to everyone.

Includes only one of the fields public_access, auth_system_access, sign_url_access.

Video access rights.

auth_system_access

VideoAuthSystemAccessRights

Checking access rights using the authorization system.

Includes only one of the fields public_access, auth_system_access, sign_url_access.

Video access rights.

sign_url_access

VideoSignURLAccessRights

Checking access rights using url's signature.

Includes only one of the fields public_access, auth_system_access, sign_url_access.

Video access rights.

created_at

google.protobuf.Timestamp

Time when video was created.

updated_at

google.protobuf.Timestamp

Time of last video update.

labels

object (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

Field

Description

Empty

VideoAuthSystemAccessRights

Field

Description

Empty

VideoSignURLAccessRights

Field

Description

Empty
Previous
Get
Next
BatchGet