Nimbus Android SDK

2.35.2

nimbus-android/com.adsbynimbus.render/AdController

AdController

abstract class AdController

This interface is used to control an ad unit rendered by Nimbus.

The AdController is designed to be an abstraction around the different types of ad creative Nimbus supports. The AdController provides methods for starting and stopping ads, retrieving information about the current state of an ad, controlling the volume, and destroying the ad.

Each AdController instance is responsible for firing to its collections of listeners events representing state changes of the ad.

Be sure to call destroy whenever an ad is no longer needed. If using the default renderers provided by Nimbus, the ad will destroy itself when a video completes; static ads can be configured to fire a completion event after a set time but must be manually destroyed.

Inheritors

BlockingAdController

Constructors

constructor()

Types

interface Listener : AdEvent.Listener, NimbusError.Listener

Listens for events and errors from an AdController.

Properties

open val duration: Float

Returns the duration of this Ad.

friendlyObstructions

@get:JvmName(name = "friendlyObstructions")

val friendlyObstructions: MutableCollection<View>

Returns a list of friendly obstructions

val listeners: MutableSet<AdController.Listener>

A collection of AdController listener objects.

open val view: View? = null

Returns the View that this AdController manages.

open var volume: Int

The current volume of this AdController from 0 to 100.

Functions

abstract fun destroy()

Destroys this AdController and associated resources.

disableClickProtection

fun AdController.disableClickProtection()

This will disable all click protections on a Nimbus ad, use at your own risk

fun listeners(): MutableSet<AdController.Listener>

This is a convenience method for backwards compatibility with Java

open fun start()

Start the ad playback.

open fun stop()

Stop the ad playback.