-
- All Implemented Interfaces:
@MainThread() public interface Inroll
This class is used to play inroll ad breaks.
-
-
Method Summary
Modifier and Type Method Description abstract InstreamAdBreak
getInstreamAdBreak()
Returns InstreamAdBreak that's associated with this inroll. abstract void
setListener(@Nullable() InstreamAdBreakEventListener listener)
Register a callback for listening inroll playback events. abstract void
setVideoAdPlaybackListener(@Nullable() VideoAdPlaybackListener listener)
Register a callback for listening video playback events abstract void
prepare(@NonNull() InstreamAdPlayer instreamAdPlayer)
Prepare inroll playback. abstract void
play(@NonNull() InstreamAdView instreamAdView)
Start inroll playback. abstract void
pause()
Pause inroll playback. abstract void
resume()
Resume paused inroll playback. abstract void
invalidate()
Invalidate inroll playback. -
-
Method Detail
-
getInstreamAdBreak
@NonNull() abstract InstreamAdBreak getInstreamAdBreak()
Returns InstreamAdBreak that's associated with this inroll.
-
setListener
abstract void setListener(@Nullable() InstreamAdBreakEventListener listener)
Register a callback for listening inroll playback events.
- Parameters:
listener
- an InstreamAdBreakEventListener object that handles lifecycle of inroll.
-
setVideoAdPlaybackListener
abstract void setVideoAdPlaybackListener(@Nullable() VideoAdPlaybackListener listener)
Register a callback for listening video playback events
- Parameters:
listener
- an VideoAdPlaybackListener object that handles video playback events.
-
prepare
abstract 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
abstract 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
abstract void pause()
Pause inroll playback.
-
resume
abstract void resume()
Resume paused inroll playback.
-
invalidate
abstract 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.
-
-
-
-