Inroll

@objc(YMAInroll)
public protocol Inroll

This class is responsible for playing inroll ad breaks.

  1. delegate
  2. instreamAdBreak
  3. prepare(with:)
  4. play(with:)
  5. pause()
  6. resume()
  7. invalidate()

delegate

This object will be notified about the inroll playback events.

Declaration

Swift

var delegate: InstreamAdBreakDelegate? { get set }

instreamAdBreak

InstreamAdBreak associated with this inroll.

Declaration

Swift

var instreamAdBreak: InstreamAdBreak { get }

prepare(with:)

Prepare inroll playback. Note that prepare should always be called before play method.

Declaration

Swift

func prepare(with adPlayer: InstreamAdPlayer)

Parameters

adPlayer

player to play inroll.

adPlayer

player to play inroll.

play(with:)

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

Declaration

Swift

func play(with adView: InstreamAdView)

Parameters

adView

the view in which inroll will be displayed.

adView

the view in which inroll will be displayed.

pause()

Pause inroll playback.

Declaration

Swift

func pause()

resume()

Resume paused inroll playback.

Declaration

Swift

func resume()

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.

Declaration

Swift

func invalidate()