Package com.longtailvideo.jwplayer

Class JWFriendlyAdObstructions

  • public class JWFriendlyAdObstructions
extends java.lang.Object

    Friendly obstructions are views such as video controls that are essential to the user’s experience but do not impact viewability. Once registered as such, these controls are excluded from ad viewability measurements. These controls must only be fully transparent overlays or small buttons. Any other non-control views must not be registered.

    When ad viewability via the OMSDK is calculated, all views overlaying the media element are considered obstructions and reduce the viewability rate.

    You may register:

    • A transparent overlay used to capture user taps.
    • Transient buttons such as:
      • Pause
      • Play
      • Fullscreen
      • Cast/AirPlay
      • Collapse
      • Progress/Seek
      • Other playback relevant actions

    You must NOT register:

    • Watermarks
    • Pop ups
    • Dialogs
    • Non-transient buttons

    For more information, see Open Measurement in the IMA SDK.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(android.view.View friendlyObstruction)
      Used to register View elements as friendly advertising obstructions.
      java.util.List<android.view.View> getList()
      Used to retrieve all View elements registered as friendly advertising obstructions.
      void remove​(android.view.View friendlyObstruction)
      Used to unregister View elements previously registered as friendly advertising obstructions.
      void removeAll()
      Used to unregister all View elements previously registered as friendly advertising obstructions.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • JWFriendlyAdObstructions

        protected JWFriendlyAdObstructions()

    • Method Detail

      • add

        public void add​(android.view.View friendlyObstruction)
        Used to register View elements as friendly advertising obstructions.
        Parameters:
        friendlyObstruction - the View element appearing on top of the player's view during ad playback.

      • remove

        public void remove​(android.view.View friendlyObstruction)
        Used to unregister View elements previously registered as friendly advertising obstructions.
        Parameters:
        friendlyObstruction - the View element appearing on top of the player's view during ad playback.

      • removeAll

        public void removeAll()
        Used to unregister all View elements previously registered as friendly advertising obstructions.

      • getList

        public java.util.List<android.view.View> getList()
        Used to retrieve all View elements registered as friendly advertising obstructions.
        Returns:
        the list of View elements registered as friendly advertising obstructions.