AdOverlayInfo

public final class AdOverlayInfo

Provides information about an overlay view shown on top of an ad view group.

Summary

Nested types
public final class AdOverlayInfo.Builder

A builder for AdOverlayInfo instances.
@Documented
@Retention(value = RetentionPolicy.SOURCE)
@Target(value = )
@IntDef(value = )
public annotation AdOverlayInfo.Purpose

The purpose of the overlay.

Constants
static final int

Purpose for ad close buttons overlaying the player.
static final int

Purpose for playback controls overlaying the player.
static final int

Purpose for overlays that are not visible.
static final int

Purpose for other overlays.

Public fields
final int

The purpose of the overlay view.
final @Nullable String

An optional, detailed reason that the overlay view is needed.
final View

The overlay view.

Public constructors

This method is deprecated.

Use Builder instead.
@UnstableApi
AdOverlayInfo(
    View view,
    @AdOverlayInfo.Purpose int purpose,
    @Nullable String detailedReason
)

This method is deprecated.

Use Builder instead.

Constants

PURPOSE_CLOSE_AD

public static final int PURPOSE_CLOSE_AD = 2

Purpose for ad close buttons overlaying the player.

PURPOSE_CONTROLS

public static final int PURPOSE_CONTROLS = 1

Purpose for playback controls overlaying the player.

PURPOSE_NOT_VISIBLE

public static final int PURPOSE_NOT_VISIBLE = 4

Purpose for overlays that are not visible.

PURPOSE_OTHER

public static final int PURPOSE_OTHER = 3

Purpose for other overlays.

Public fields

purpose

@AdOverlayInfo.Purpose
public final int purpose

The purpose of the overlay view.

reasonDetail

public final @Nullable String reasonDetail

An optional, detailed reason that the overlay view is needed.

view

public final View view

The overlay view.

Public constructors

AdOverlayInfo

@UnstableApi
public AdOverlayInfo(View view, @AdOverlayInfo.Purpose int purpose)

AdOverlayInfo

@UnstableApi
public AdOverlayInfo(
    View view,
    @AdOverlayInfo.Purpose int purpose,
    @Nullable String detailedReason
)