Перейти к основному содержимому
Версия: v1

VoD

Создание VoD

Для подключения VoD необходимо cоздать объект vod, указав в качестве источника видео ресурс, на котором хранятся видео файлы. Источником может быть домен или S3 бакет, подключенный к CDN. После регистрации источника функция VoD по умолчанию неактивна. Для начала работы VoD его необходимо включить.

Включение функции VoD

После создания объекта VoD появляется возможность включения (активации) VoD. Для включения VoD необходимо использовать API метод enable_vod. При включении VoD создаётся задача с типом ENABLE_VOD, выполняемая в отдельном процессе. Домен для VoD (vod_domain), выданный при создании объекта VoD станет активен. Далее можно выбрать подходящий стриминговый протокол (HLS, DASH или MSS) и сформировать URL для доступа к плейлистам.

Выключение функции VoD

Для выключения VoD необходимо использовать API метод disable_vod. При этом создается задача c типом DISABLE_VOD, выполняемая в отдельном процессе. Данная задача создается, если VoD для домена или S3 бакета на данный момент активен.

Изменение VoD

Для изменения параметров VoD используется API метод update_vod.

Удаление VoD

Для удаления объекта VoD необходимо использовать API метод delete_vod. Перед удалением необходимо убедиться, что VoD отключен.

Генерация токена доступа

Для генерации токена используется API метод generate_vod_token.

Инвалидация токенов доступа

Для отзыва токенов используется API метод revoke_vod_tokens. При этом все ранее выданные токены становятся недействительными.

Ограничение доступа

Для объектов VoD доступна функция ограничения доступа, за которую отвечает объект vod.access_params. Структура объекта:

{
"disallowed_country_codes": [
"RU",
"BY"
]
}

В поле disallowed_country_codes указывается список кодов стран, при запросах из которых клиент получит ответ с кодом ошибки 403 Forbidden. Коды стран должны соответствовать двухбуквенным обозначениям по ISO 3166 Alpha-2.

Адаптивный битрейт

За активацию функции адаптивного битрейта отвечает поле vod.enable_adaptive_bitrate. Доступны методы просмотра списка задач на преобразование видео и очистки кеша VoD с адаптивным битрейтом.

Рекомендуемые сценарии

Ниже представлены рекомендации по управлению объектами vod.

Первичное включение:

  1. выбрать активированный источник для Vod (s3_resource или domain)
  2. активировать услугу VoD
  3. предоставить клиенту список сгенерированных url для обращения к видеофайлам

Управление токенами:

  1. включить опцию restrict_access для VoD
  2. сгенерировать токен с необходимыми параметрами
  3. сформировать ссылку на плейлист вида {vod_url}?token={vod_token}

Адаптивный битрейт

  1. включить опцию enable_adaptive_bitrate для VoD
  2. выполнить запрос к плейлисту (например, GET https://{vod_domain}/hls/{bucket_name}/{filename}/master.m3u8)
  3. дождаться выполнения преобразования видео, контролируя ход выполнения задачи

API методы

VoD

Токены доступа

Адаптивный битрейт