Package org.prebid.mobile.rendering.video.vast

Interface VASTInterface

All Known Implementing Classes:
RewardedVideoCreative, VideoCreative, VideoCreativeProtocol
public interface VASTInterface

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    the user clicked the close button on the creative.
    void
    closeLinear()
    the user clicked the close button on the creative.
    void
    collapse()
    the user activated a control to reduce the creative to its original dimensions.
    void
    exitFullScreen()
    the user activated the control to reduce video player size to original dimensions.
    void
    expand()
    Per IAB: the user activated a control to expand the creative.
    void
    fullScreen()
    Per IAB: the user activated a control to extend the video player to the edges of the viewer’s screen.
    void
    mute()
    the user activated the mute control and muted the creative.
    void
    onWindowFocusChanged(boolean hasFocus)
    the user made a window focus change, such as leaving the activity, pressing back, invoking Recents, or returning from one of these states back to the video player.
    void
    orientationChanged(int orientation)
    the user made an orientation change by rotating the device.
    void
    pause()
    Per IAB: the user clicked the pause control and stopped the creative.
    void
    resume()
    Per IAB: the user activated the resume control after the creative had been stopped or paused.
    void
    rewind()
    the user activated the rewind control to access a previous point in the creative timeline.
    void
    skip()
    the user activated a skip control to skip the creative, which is a different control than the one used to close the creative.
    void
    touch()
    the user simply touched the video player in a non-specific region of the player (touched an empty area of the video, not a widget or button).
    void
    unmute()
    the user activated the mute control and unmuted the creative.

  • Method Details

    • resume

      void resume()
      Per IAB: the user activated the resume control after the creative had been stopped or paused.

    • pause

      void pause()
      Per IAB: the user clicked the pause control and stopped the creative.

    • expand

      void expand()
      Per IAB: the user activated a control to expand the creative.

    • fullScreen

      void fullScreen()
      Per IAB: the user activated a control to extend the video player to the edges of the viewer’s screen.

    • collapse

      void collapse()
      the user activated a control to reduce the creative to its original dimensions.

    • exitFullScreen

      void exitFullScreen()
      the user activated the control to reduce video player size to original dimensions.

    • mute

      void mute()
      the user activated the mute control and muted the creative.

    • unmute

      void unmute()
      the user activated the mute control and unmuted the creative.

    • close

      void close()
      the user clicked the close button on the creative.

    • closeLinear

      void closeLinear()
      the user clicked the close button on the creative. The name of this event distinguishes it from the existing “close” event described in the 2008 IAB Digital Video In-Stream Ad Metrics Definitions, which defines the “close” metric as applying to non-linear ads only. The “closeLinear” event extends the “close” event for use in Linear creative.

    • skip

      void skip()
      the user activated a skip control to skip the creative, which is a different control than the one used to close the creative.

    • rewind

      void rewind()
      the user activated the rewind control to access a previous point in the creative timeline.

    • touch

      void touch()
      the user simply touched the video player in a non-specific region of the player (touched an empty area of the video, not a widget or button).

    • orientationChanged

      void orientationChanged(int orientation)
      the user made an orientation change by rotating the device. The orientation of Configuration.ORIENTATION_LANDSCAPE or Configuration.ORIENTATION_PORTRAIT is passed in.

    • onWindowFocusChanged

      void onWindowFocusChanged(boolean hasFocus)
      the user made a window focus change, such as leaving the activity, pressing back, invoking Recents, or returning from one of these states back to the video player. This will allow for internal threads to pause and resume correctly.