com.yandex.mobile.ads.instream.pauseroll

Interface Pauseroll

  1. Method Summary
  2. Method Detail
    1. getInstreamAdBreak
    2. setListener
    3. setVideoAdPlaybackListener
    4. prepare
    5. play
    6. pause
    7. resume
    8. invalidate

public interface Pauseroll
This class is used to play pauseroll ad breaks.

Method Summary

All Methods
Instance Methods
Abstract Methods
Modifier and TypeMethod and Description
InstreamAdBreakgetInstreamAdBreak()
Returns InstreamAdBreak that's associated with this pauseroll.
voidinvalidate()
Invalidate pauseroll playback.
voidpause()
Pause pauseroll playback.
voidplay(InstreamAdView instreamAdView)
Start pauseroll playback.
voidprepare(InstreamAdPlayer instreamAdPlayer)
Prepare pauseroll playback.
voidresume()
Resume paused pauseroll playback.
voidsetListener(InstreamAdBreakEventListener listener)
Register a callback for listening pauseroll playback events.
voidsetVideoAdPlaybackListener(com.yandex.mobile.ads.video.playback.VideoAdPlaybackListener listener)
Register a callback for listening video playback events

Method Detail

getInstreamAdBreak

@NonNull
InstreamAdBreak getInstreamAdBreak()
Returns InstreamAdBreak that's associated with this pauseroll.
Returns:
InstreamAdBreak.

setListener

void setListener(@Nullable
                 InstreamAdBreakEventListener listener)
Register a callback for listening pauseroll playback events.
Parameters:
listener - an InstreamAdBreakEventListener object that handles lifecycle of pauseroll.

setVideoAdPlaybackListener

void setVideoAdPlaybackListener(@Nullable
                                com.yandex.mobile.ads.video.playback.VideoAdPlaybackListener listener)
Register a callback for listening video playback events
Parameters:
listener - an VideoAdPlaybackListener object that handles video playback events.

prepare

void prepare(@NonNull
             InstreamAdPlayer instreamAdPlayer)
Prepare pauseroll playback. Note that prepare() should always be called before play() method.
Parameters:
instreamAdPlayer - player to play pauseroll.

play

void play(@NonNull
          InstreamAdView instreamAdView)
Start pauseroll playback. Note that you can call play only on a prepared pauseroll.
Parameters:
instreamAdView - the view in which pauseroll will be displayed.

pause

void pause()
Pause pauseroll playback.

resume

void resume()
Resume paused pauseroll playback.

invalidate

void invalidate()
Invalidate pauseroll playback. Call this method right before ad player is invalidated. To resume playback after invalidation you should prepare and start pauseroll again.