Class AdOverlayInfo


  • public final class AdOverlayInfo
    extends Object
    Provides information about an overlay view shown on top of an ad view group.
    • Field Detail

      • PURPOSE_CONTROLS

        public static final int PURPOSE_CONTROLS
        Purpose for playback controls overlaying the player.
        See Also:
        Constant Field Values
      • PURPOSE_CLOSE_AD

        public static final int PURPOSE_CLOSE_AD
        Purpose for ad close buttons overlaying the player.
        See Also:
        Constant Field Values
      • PURPOSE_OTHER

        public static final int PURPOSE_OTHER
        Purpose for other overlays.
        See Also:
        Constant Field Values
      • PURPOSE_NOT_VISIBLE

        public static final int PURPOSE_NOT_VISIBLE
        Purpose for overlays that are not visible.
        See Also:
        Constant Field Values
      • view

        public final View view
        The overlay view.
      • purpose

        @Purpose
        public final int purpose
        The purpose of the overlay view.
      • reasonDetail

        @Nullable
        public final String reasonDetail
        An optional, detailed reason that the overlay view is needed.
    • Constructor Detail

      • AdOverlayInfo

        public AdOverlayInfo​(View view,
                             @Purpose
                             int purpose)
        Creates a new overlay info.
        Parameters:
        view - The view that is overlaying the player.
        purpose - The purpose of the view.
      • AdOverlayInfo

        public AdOverlayInfo​(View view,
                             @Purpose
                             int purpose,
                             @Nullable
                             String detailedReason)
        Creates a new overlay info.
        Parameters:
        view - The view that is overlaying the player.
        purpose - The purpose of the view.
        detailedReason - An optional, detailed reason that the view is on top of the player.