AdOverlayInfo

class AdOverlayInfo

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

Summary

Nested types

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

The purpose of the overlay.

Constants
const Int

Purpose for ad close buttons overlaying the player.
const Int

Purpose for playback controls overlaying the player.
const Int

Purpose for overlays that are not visible.
const Int

Purpose for other overlays.

Public constructors

This function is deprecated.

Use Builder instead.
@UnstableApi
AdOverlayInfo(
    view: View!,
    @AdOverlayInfo.Purpose purpose: Int,
    detailedReason: String?
)

This function is deprecated.

Use Builder instead.

Public properties
Int

The purpose of the overlay view.
String?

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

The overlay view.

Constants

PURPOSE_CLOSE_AD

const val PURPOSE_CLOSE_AD = 2: Int

Purpose for ad close buttons overlaying the player.

PURPOSE_CONTROLS

const val PURPOSE_CONTROLS = 1: Int

Purpose for playback controls overlaying the player.

PURPOSE_NOT_VISIBLE

const val PURPOSE_NOT_VISIBLE = 4: Int

Purpose for overlays that are not visible.

PURPOSE_OTHER

const val PURPOSE_OTHER = 3: Int

Purpose for other overlays.

Public constructors

AdOverlayInfo

@UnstableApi
AdOverlayInfo(view: View!, @AdOverlayInfo.Purpose purpose: Int)

AdOverlayInfo

@UnstableApi
AdOverlayInfo(
    view: View!,
    @AdOverlayInfo.Purpose purpose: Int,
    detailedReason: String?
)

Public properties

purpose

@AdOverlayInfo.Purpose
val purpose: Int

The purpose of the overlay view.

reasonDetail

val reasonDetail: String?

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

view

val view: View!

The overlay view.