Интеграция InStream API

InstreamAdBreak API не управляет непосредственно отрисовкой рекламного видео в PlayerView. Воспроизводить рекламное видео необходимо со стороны приложения основываясь на сигналах от интерфейсов плееров, переданных в InstreamAdBreak. InstreamAdBreak сообщает о начале проигрывания рекламной вставки через вызов InstreamAdBreakDelegate.instreamAdBreakDidStart() и об окончании проигрывания рекламной вставки через вызов InstreamAdBreakDelegate.instreamAdBreakDidComplete() или InstreamAdBreakDelegate.instreamAdBreakDidError().

В момент вызова InstreamAdBreakDelegate.instreamAdBreakDidStart() со стороны приложения необходимо скрыть контролы управления основным видео, приостановить основное видео. Со стороны рекламного SDK после вызова метода будут показаны рекламные контролы внутри контейнера InstreamAdView и будет вызван метод InstreamAdPlayer.playAd() для старта воспроизведения рекламного видео.

В момент вызова InstreamAdBreakDelegate.instreamAdBreakDidComplete() или InstreamAdBreakDelegate.instreamAdBreakDidError() со стороны приложения необходимо вернуть контролы управления основным видео и продолжить воспроизведение основного видео. Со стороны рекламного SDK до вызова методов будут убраны рекламные контролы из контейнера InstreamAdView.

1. Реализуйте интерфейс InstreamAdPlayer.

   В справочнике приведена подробная информация по работе методов и их реализации. Дополнительно рекомендуется ориентироваться на тестовый пример реализации.

   Совет

   Для упрощения реализации, рекомендуется использовать разные инстансы плееров для воспроизведения рекламы и контентного видео.

2. Добавьте в иерархию View приложения InstreamAdView. InstreamAdView должна содержать в себе PlayerView, в которой будут проигрываться рекламные ролики.

   Важно

   Размер контейнера должен быть не меньше 300dp x 160dp.

3. Загрузите через InstreamAdLoader объект InstreamAd с помощью идентификатора страницы (Page ID) из интерфейса Рекламной сети Яндекса.

4. InstreamAd содержит в себе набор рекламных вставок разных типов в свойстве adBreaks. Чтобы получить рекламные вставки In-roll, отфильтруйте массив по типу InstreamAdBreakType.inroll. Вставки возвращаются в порядке, предназначенном для показа.

   adLoader.loadInstreamAd(configuration: configuration) { result in
       if case .success(let ad) = result {
           inrollQueue = ad.adBreaks.filter { $0.adBreakData.type == InstreamAdBreakType.inroll }
       }
   }
   

5. Чтобы запустить полученный объект In-roll, необходимо его подготовить. Без подготовки In-roll не запустится. Для отслеживания окончания подготовки установите делегат InstreamAdBreakDelegate, вызовите InstreamAdBreak.prepare(with: adPlayer), и передайте в него инстанс созданной реализации InstreamAdPlayer.

   private func prepareNextAd() {
       guard !inrollQueue.isEmpty else { return }
       currentAdBreak = inrollQueue.removeFirst()
       currentAdBreak?.delegate = self
       currentAdBreak?.prepare(with: adPlayer)
   }
   

6. По окончанию подготовки In-roll будет вызван InstreamAdBreakDelegate.instreamAdBreakDidPrepare(). Подготовленный In-roll готов к показу.

   Совет

   Показывайте объявления в порядке их получения из adBreaks. Показ вставок в другом порядке может снизить монетизацию вашего приложения.

7. Чтобы показать подготовленную вставку, вызовите InstreamAdBreak.play(with: adView) и передайте в качестве параметра InstreamAdView, ранее добавленный в иерархию view.

   func instreamAdBreakDidPrepare(_ adBreak: InstreamAdBreak) {
       currentAdBreak?.play(with: instreamAdView)
   }
   

8. После начала проигрывания рекламной вставки, будет вызван метод InstreamAdBreakDelegate.instreamAdBreakDidStart(). По вызову этого метода необходимо поставить на паузу проигрывание основного видео и скрыть контролы управления основного видео.

   func instreamAdBreakDidStart(_ adBreak: InstreamAdBreak) {
       contentVideoPlayer?.pauseVideo()
   }
   

9. После проигрывания рекламной вставки необходимо продолжить воспроизведение основного видео. Проигрывание рекламной вставки может завершиться успешно или с ошибкой, эти две ситуации необходимо обрабатывать.

   func instreamAdBreakDidComplete(_ adBreak: InstreamAdBreak) {
       handleAdBreakCompleted()
   }
   func instreamAdBreakDidError(_ adBreak: InstreamAdBreak) {
       handleAdBreakCompleted()
   }
   private func handleAdBreakCompleted() {
       currentAdBreak = nil
       contentVideoPlayer?.resumeVideo()
   }
   

10. После завершения проигрывания текущей вставки подготовьте следующую из очереди.

    private func prepareNextAd() {
        guard !inrollQueue.isEmpty else { return }
        currentAdBreak = inrollQueue.removeFirst()
        currentAdBreak?.delegate = self
        currentAdBreak?.prepare(with: adPlayer)
    }
    

11. При остановке использования In-roll необходимо очищать его состояние.

    deinit {
        currentAdBreak?.invalidate()
    }