Добавить обложку для трансляции

Статья создана

Yandex Cloud

Обновлена 18 ноября 2024 г.

Чтобы добавить обложку для трансляции:

Интерфейс Cloud Video

REST API

gRPC API

Откройте главную страницу Cloud Video.
Выберите канал.
На вкладке Трансляции в строке с нужной трансляцией нажмите значок и выберите Редактировать.
Если у трансляции уже есть обложка, удалите ее. Для этого наведите указатель на превью обложки и нажмите значок .
Нажмите кнопку Выберите файл и выберите новое изображение для обложки.

Поддерживаются обложки в следующих форматах: JPG, PNG и GIF.
Нажмите кнопку Сохранить.

Перед началом работы:
- Получите идентификатор организации, в которой находится ваш канал Cloud Video.
- Получите IAM-токен, необходимый для аутентификации в API Cloud Video.
- Чтобы воспользоваться примерами, установите утилиту cURL.

Получите список каналов Cloud Video в вашей организации:

curl \
  --request GET \
  --url 'https://video.api.cloud.yandex.net/video/v1/channels?organizationId=<идентификатор_организации>' \
  --header 'Authorization: Bearer <IAM-токен>'

Где:

<идентификатор_организации> — полученный перед началом работы идентификатор организации.
<IAM-токен> — полученный перед началом работы IAM-токен.

Результат:

{
 "channels": [
  {
   "id": "vplc3neipzso********",
   "organizationId": "bpfaidqca8vd********",
   "title": "my-first-channel",
   "description": "My very first Cloud Video channel",
   "createdAt": "2023-07-07T10:51:48.658737Z",
   "updatedAt": "2023-07-07T10:51:48.658737Z"
  },
  {
   "id": "vplc3vssjcxh********",
   "organizationId": "bpfaidqca8vd********",
   "title": "my-work-channel",
   "createdAt": "2023-08-09T23:32:55.372456Z",
   "updatedAt": "2023-08-09T23:32:55.372456Z"
  },
  {
   "id": "vplc4cfwamlx********",
   "organizationId": "bpfaidqca8vd********",
   "title": "my-personal-channel",
   "createdAt": "2024-03-14T13:48:34.535821Z",
   "updatedAt": "2024-03-14T13:48:34.535821Z"
  },
 ]
}

Сохраните идентификатор канала (id), в хранилище которого вы хотите загрузить обложку.

Зарегистрируйте обложку в Cloud Video:

curl \
  --request POST \
  --url 'https://video.api.cloud.yandex.net/video/v1/thumbnails' \
  --header 'Authorization: Bearer <IAM-токен>' \
  --header 'Content-Type: application/json' \
  --data '{
    "channelId": "<идентификатор_канала>"
  }'

Где:

<IAM-токен> — полученный перед началом работы IAM-токен.
<идентификатор_канала> — сохраненный ранее идентификатор канала.

Результат:

{
 "done": true,
 "metadata": {
  "@type": "type.googleapis.com/yandex.cloud.video.v1.CreateThumbnailMetadata",
  "thumbnailId": "vpltaurfr4pr********"
 },
 "response": {
  "@type": "type.googleapis.com/yandex.cloud.video.v1.Thumbnail",
  "id": "vpltaurfr4pr********",
  "channelId": "vplcdyphvqik********",
  "createdAt": "2024-11-02T16:56:19.296797Z"
 },
 "id": "vplpgbyqopdr********",
 "description": "Thumbnail create",
 "createdAt": "2024-11-02T16:56:19.301776Z",
 "createdBy": "ajeol2afu1js********",
 "modifiedAt": "2024-11-02T16:56:19.301776Z"
}

Сохраните значение идентификатора обложки (thumbnailId), оно понадобится позднее.

Получите ссылку на загрузку изображения в обложку:

curl \
  --request POST \
  --url 'https://video.api.cloud.yandex.net/video/v1/thumbnails/<идентификатор_обложки>:generateUploadURL' \
  --header 'Authorization: Bearer <IAM-токен>'

Где:

<IAM-токен> — полученный перед началом работы IAM-токен.
<идентификатор_обложки> — сохраненное ранее значение идентификатора обложки.

Результат:

{
  "uploadUrl": "https://storage.yandexcloud.net/videoplatform-thumbnail/vpltleyrfnjh********?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=********3aBOmv27nzbJZaEHZ%2F20241102%2Fru-central1%2Fs3%2Faws4_request&X-Amz-Date=20241102T190000Z&X-Amz-Expires=43200&X-Amz-Signature=057fe4c0da26c7758474f5eaa85ff41d7212632572fb636ed6d8f65d039c309b&X-Amz-SignedHeaders=host"
}

Поле uploadUrl содержит подписанную ссылку, с помощью которой вы сможете загрузить файл обложки.

Загрузите в обложку файл с изображением:
```
curl \
  --request PUT \
  --url '<подписанная_ссылка>' \
  --header 'Content-Type: image/<формат_изображения>' \
  --upload-file '<путь_к_файлу_с_обложкой>'
```
Где:
- <подписанная_ссылка> — полученная на предыдущем шаге подписанная ссылка на загрузку файла обложки.
- <формат_изображения> — в зависимости от формата загружаемого изображения, укажите png, jpeg или gif.
- <путь_к_файлу_с_обложкой> — абсолютный путь к файлу с загружаемым изображением. Не используйте сокращения, в т.ч. тильду ~.

Получите список трансляций на канале:

curl \
  --request GET \
  --url 'https://video.api.cloud.yandex.net/video/v1/streams?channelId=<идентификатор_канала>' \
  --header 'Authorization: Bearer <IAM-токен>'

Где:

<идентификатор_канала> — идентификатор канала с трансляцией, для которой вы хотите добавить обложку.
<IAM-токен> — полученный перед началом работы IAM-токен.

Результат:

{
 "streams": [
  {
   "onDemand": {},
   "id": "vplsfj23t7tf********",
   "channelId": "vplcdyphvqik********",
   "lineId": "vplldrpqy42y********",
   "title": "my-first-stream",
   "status": "OFFLINE",
   "createdAt": "2024-11-03T16:55:32.976950Z",
   "updatedAt": "2024-11-03T16:55:33.091744Z"
  },
  {
   "onDemand": {},
   "id": "vplsgchsr5gi********",
   "channelId": "vplcdyphvqik********",
   "lineId": "vpllxc2mfleb********",
   "title": "my-new-stream",
   "thumbnailId": "vpltznjxpnyj********",
   "status": "OFFLINE",
   "createdAt": "2024-11-03T16:34:10.617101Z",
   "updatedAt": "2024-11-03T16:35:06.601920Z"
  }
 ]
}

Сохраните идентификатор трансляции (id), для которой вы хотите добавить обложку.

Добавьте созданную обложку к выбранной трансляции:

curl \
  --request PATCH \
  --url 'https://video.api.cloud.yandex.net/video/v1/streams/<идентификатор_трансляции>' \
  --header 'Authorization: Bearer <IAM-токен>' \
  --header 'Content-Type: application/json' \
  --data '{
    "fieldMask": "thumbnailId",
    "thumbnailId": "<идентификатор_обложки>"
  }'

Где:

<идентификатор_трансляции> — сохраненный ранее идентификатор трансляции, для которой вы хотите добавить обложку.
<IAM-токен> — полученный перед началом работы IAM-токен.
<идентификатор_обложки> — сохраненный ранее идентификатор обложки.

Результат:

{
 "done": true,
 "metadata": {
  "@type": "type.googleapis.com/yandex.cloud.video.v1.UpdateStreamMetadata",
  "streamId": "vplsfj23t7tf********"
 },
 "response": {
  "@type": "type.googleapis.com/yandex.cloud.video.v1.Stream",
  "onDemand": {},
  "id": "vplsfj23t7tf********",
  "channelId": "vplcdyphvqik********",
  "lineId": "vplldrpqy42y********",
  "title": "my-new-stream",
  "thumbnailId": "vpltxnjvjyzy********",
  "status": "OFFLINE",
  "createdAt": "2024-11-03T16:55:32.976950Z",
  "updatedAt": "2024-11-03T17:21:31.672357Z"
 },
 "id": "vplpgadtyvhm********",
 "description": "Stream update",
 "createdAt": "2024-11-03T17:21:31.680037Z",
 "createdBy": "ajeol2afu1js********",
 "modifiedAt": "2024-11-03T17:21:31.680037Z"
}

Перед началом работы:
- Получите идентификатор организации, в которой находится ваш канал Cloud Video.
- Получите IAM-токен, необходимый для аутентификации в API Cloud Video.
- Чтобы воспользоваться примерами, установите утилиты cURL, gRPCurl и jq.

Получите список каналов Cloud Video в вашей организации:

grpcurl \
  -rpc-header "Authorization: Bearer <IAM-токен>" \
  -d '{
    "organizationId": "<идентификатор_организации>"
  }' \
  video.api.cloud.yandex.net:443 yandex.cloud.video.v1.ChannelService/List

Где:

<IAM-токен> — полученный перед началом работы IAM-токен.
<идентификатор_организации> — полученный перед началом работы идентификатор организации.

Результат:

{
  "channels": [
    {
      "id": "vplc3neipzso********",
      "organizationId": "bpfaidqca8vd********",
      "title": "my-first-channel",
      "description": "My very first Cloud Video channel",
      "createdAt": "2023-07-07T10:51:48.658737Z",
      "updatedAt": "2023-07-07T10:51:48.658737Z"
    },
    {
      "id": "vplc3vssjcxh********",
      "organizationId": "bpfaidqca8vd********",
      "title": "my-work-channel",
      "createdAt": "2023-08-09T23:32:55.372456Z",
      "updatedAt": "2023-08-09T23:32:55.372456Z"
    },
    {
      "id": "vplc4cfwamlx********",
      "organizationId": "bpfaidqca8vd********",
      "title": "my-personal-channel",
      "createdAt": "2024-03-14T13:48:34.535821Z",
      "updatedAt": "2024-03-14T13:48:34.535821Z"
    },
  ]
}

Сохраните идентификатор канала (id), в хранилище которого вы хотите загрузить обложку.

Зарегистрируйте обложку в Cloud Video:

grpcurl \
  -rpc-header "Authorization: Bearer <IAM-токен>" \
  -rpc-header 'Content-Type: application/json' \
  -d '{
    "channel_id": "<идентификатор_канала>"
  }' \
  video.api.cloud.yandex.net:443 yandex.cloud.video.v1.ThumbnailService/Create

Где:

<IAM-токен> — полученный перед началом работы IAM-токен.
<идентификатор_канала> — сохраненный ранее идентификатор канала.

Результат:

{
  "id": "vplpoqhxep6q********",
  "description": "Thumbnail create",
  "createdAt": "2024-11-02T19:04:28.412672Z",
  "createdBy": "ajeol2afu1js********",
  "modifiedAt": "2024-11-02T19:04:28.412672Z",
  "done": true,
  "metadata": {
    "@type": "type.googleapis.com/yandex.cloud.video.v1.CreateThumbnailMetadata",
    "thumbnailId": "vpltleyrfnjh********"
  },
  "response": {
    "@type": "type.googleapis.com/yandex.cloud.video.v1.Thumbnail",
    "channelId": "vplcdyphvqik********",
    "createdAt": "2024-11-02T19:04:28.402787Z",
    "id": "vpltleyrfnjh********"
  }
}

Сохраните значение идентификатора обложки (thumbnailId), оно понадобится позднее.

Получите ссылку на загрузку изображения в обложку:

grpcurl \
  -rpc-header "Authorization: Bearer <IAM-токен>" \
  -d '{
    "thumbnailId": "<идентификатор_обложки>"
  }' \
  video.api.cloud.yandex.net:443 yandex.cloud.video.v1.ThumbnailService/GenerateUploadURL | jq

Где:

<IAM-токен> — полученный перед началом работы IAM-токен.
<идентификатор_обложки> — сохраненное ранее значение идентификатора обложки.

Результат:

{
  "uploadUrl": "https://storage.yandexcloud.net/videoplatform-thumbnail/vpltleyrfnjh********?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=********3aBOmv27nzbJZaEHZ%2F20241102%2Fru-central1%2Fs3%2Faws4_request&X-Amz-Date=20241102T190000Z&X-Amz-Expires=43200&X-Amz-Signature=057fe4c0da26c7758474f5eaa85ff41d7212632572fb636ed6d8f65d039c309b&X-Amz-SignedHeaders=host"
}

Поле uploadUrl содержит подписанную ссылку, с помощью которой вы сможете загрузить файл обложки.

Загрузите в обложку файл с изображением:
```
curl \
  --request PUT \
  --url '<подписанная_ссылка>' \
  --header 'Content-Type: image/<формат_изображения>' \
  --upload-file '<путь_к_файлу_с_обложкой>'
```
Где:
- <подписанная_ссылка> — полученная на предыдущем шаге подписанная ссылка на загрузку файла обложки.
- <формат_изображения> — в зависимости от формата загружаемого изображения, укажите png, jpeg или gif.
- <путь_к_файлу_с_обложкой> — абсолютный путь к файлу с загружаемым изображением. Не используйте сокращения, в т.ч. тильду ~.

Получите список трансляций на канале:

grpcurl \
  -rpc-header "Authorization: Bearer <IAM-токен>" \
  -d '{
    "channelId": "<идентификатор_канала>"
  }' \
  video.api.cloud.yandex.net:443 yandex.cloud.video.v1.StreamService/List

Где:

<IAM-токен> — полученный перед началом работы IAM-токен.
<идентификатор_канала> — идентификатор канала с трансляцией, для которой вы хотите добавить обложку.

Результат:

{
  "streams": [
    {
      "id": "vplsfj23t7tf********",
      "channelId": "vplcdyphvqik********",
      "lineId": "vplldrpqy42y********",
      "title": "my-first-stream",
      "status": "OFFLINE",
      "createdAt": "2024-11-03T16:55:32.976950Z",
      "updatedAt": "2024-11-03T16:55:33.091744Z",
      "onDemand": {}
    },
    {
      "id": "vplsgchsr5gi********",
      "channelId": "vplcdyphvqik********",
      "lineId": "vpllxc2mfleb********",
      "title": "my-new-stream",
      "thumbnailId": "vpltznjxpnyj********",
      "status": "OFFLINE",
      "createdAt": "2024-11-03T16:34:10.617101Z",
      "updatedAt": "2024-11-03T16:35:06.601920Z",
      "onDemand": {}
    }
  ]
}

Сохраните идентификатор трансляции (id), для которой вы хотите добавить обложку.

Добавьте созданную обложку к выбранной трансляции:

grpcurl \
  -rpc-header "Authorization: Bearer <IAM-токен>" \
  -rpc-header "Content-Type: application/json" \
  -d '{
    "streamId": "<идентификатор_трансляции>",
    "fieldMask": {"paths": ["thumbnail_id"]},
    "thumbnailId": "<идентификатор_обложки>"
  }' \
  video.api.cloud.yandex.net:443 yandex.cloud.video.v1.StreamService/Update

Где:

<IAM-токен> — полученный перед началом работы IAM-токен.
<идентификатор_трансляции> — сохраненный ранее идентификатор трансляции, для которой вы хотите добавить обложку.
<идентификатор_обложки> — сохраненный ранее идентификатор обложки.

Результат:

{
  "id": "vplpl2wqhe62********",
  "description": "Stream update",
  "createdAt": "2024-11-03T17:29:26.987297Z",
  "createdBy": "ajeol2afu1js********",
  "modifiedAt": "2024-11-03T17:29:26.987297Z",
  "done": true,
  "metadata": {
    "@type": "type.googleapis.com/yandex.cloud.video.v1.UpdateStreamMetadata",
    "streamId": "vplsfj23t7tf********"
  },
  "response": {
    "@type": "type.googleapis.com/yandex.cloud.video.v1.Stream",
    "channelId": "vplcdyphvqik********",
    "createdAt": "2024-11-03T16:55:32.976950Z",
    "id": "vplsfj23t7tf********",
    "lineId": "vplldrpqy42y********",
    "onDemand": {},
    "status": "OFFLINE",
    "thumbnailId": "vpltxnjvjyzy********",
    "title": "my-new-stream",
    "updatedAt": "2024-11-03T17:29:26.986096Z"
  }
}

Добавить обложку для трансляции

Была ли статья полезна?