Package com.yandex.mobile.ads.instream.inroll

Interface Inroll

@MainThread
public interface Inroll

This class is used to play inroll ad breaks.

Method Summary

Modifier and Type	Method	Description
InstreamAdBreak	getInstreamAdBreak()	Returns InstreamAdBreak that's associated with this inroll.
void	invalidate()	Invalidate inroll playback.
void	pause()	Pause inroll playback.
void	play(InstreamAdView instreamAdView)	Start inroll playback.
void	prepare(InstreamAdPlayer instreamAdPlayer)	Prepare inroll playback.
void	resume()	Resume paused inroll playback.
void	setListener(InstreamAdBreakEventListener listener)	Register a callback for listening inroll playback events.
void	setVideoAdPlaybackListener(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 inroll.

Returns:

InstreamAdBreak.

setListener

void setListener(@Nullable
                 InstreamAdBreakEventListener listener)

Register a callback for listening inroll playback events.

Parameters:

listener - an InstreamAdBreakEventListener object that handles lifecycle of inroll.

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 inroll playback. Note that prepare() should always be called before play() method.

Parameters:

instreamAdPlayer - player to play inroll.

play

void play(@NonNull
          InstreamAdView instreamAdView)

Start inroll playback. Note that you can call play only on a prepared inroll.

Parameters:

instreamAdView - the view in which inroll will be displayed.

pause

void pause()

Pause inroll playback.

resume

void resume()

Resume paused inroll playback.

invalidate

void invalidate()

Invalidate inroll playback. Call this method right before ad player is invalidated. To resume playback after invalidation you should prepare and start inroll again.