Instream SDK/com.smartadserver.android.instreamsdk.admanager/SVSAdManager

SVSAdManager

open class SVSAdManager : SVSAdPlayerControls.AdPlayerControlsListener, SVSAdBreakManagerListener, SCSViewabilityManagerListener, SVSRemoteLoggerManagerDataSource, SVSAdPlaybackEvent.OnAdPlaybackEventListener

The SVSAdManager is the class responsible for loading ads and displaying them into the ad player. This class is instantiated with a SVSAdPlacement, a set of SVSAdRule, a SVSAdPlayerConfiguration object and is started with an Object implementing the SVSContentPlayerPlugin interface that makes the connection with the content player

Constructors

Link copied to clipboard
constructor(@NonNull context: Context, @NonNull placement: SVSAdPlacement, @Nullable adRules: Array<SVSAdRule>, @Nullable adPlayerConfiguration: SVSAdPlayerConfiguration, @Nullable contentData: SVSContentData)
Main constructor

Types

Link copied to clipboard
interface AdBreakEventListener
Interface for Objects that will monitor SVSAdManager ad break events
Link copied to clipboard
interface AdManagerListener
Interface for Objects that will monitor SVSAdManager main events and actions
Link copied to clipboard
interface UIInteractionListener
Interface for Objects that will respond to interactions with the ad player controls (like enter fullscreen/ exit fullscreen requests for now)

Properties

Link copied to clipboard
@NonNull
@get:NonNull
val adPlacement: SVSAdPlacement
The SASAdPlacement of this SVSAdManager instance.
Link copied to clipboard
@NonNull
@get:NonNull
val adPlayerConfiguration: SVSAdPlayerConfiguration
The full ad player configuration of this SVSAdManager instance.

Functions

Link copied to clipboard
Link copied to clipboard
open fun addAdManagerListener(@NonNull listener: SVSAdManager.AdManagerListener)
Add a AdManagerListener to this SVSAdManager
Link copied to clipboard
Link copied to clipboard
open fun cancelAdLoading()
Cancel any pending ad loading process
Link copied to clipboard
open fun notifyContentHasCompleted()
Manually notifies the SVSAdManager instance that the content has reached its end (in case it can not be properly detected internally)
Link copied to clipboard
Link copied to clipboard
open fun onAdPlaybackEvent(@NonNull event: SVSAdPlaybackEvent)
Link copied to clipboard
open fun onDestroy()
Releases resources allocated by this SVSAdManager.
Link copied to clipboard
open fun onFullscreenStateChange(isFullscreen: Boolean)
Tells the ad manager that your content player entered / exited fullscreen mode.
Link copied to clipboard
open fun onPause()
Notifies this SVSAdManager that the hosting Activity's onPause() method was called
Link copied to clipboard
open fun onResume()
Notifies this SVSAdManager that the hosting Activity's onResume() method was called
Link copied to clipboard
Link copied to clipboard
open fun removeAdManagerListener(@NonNull listener: SVSAdManager.AdManagerListener)
Add a AdManagerListener to this SVSAdManager
Link copied to clipboard
open fun removeUIInteractionListener(@NonNull listener: SVSAdManager.UIInteractionListener)
Removes a UIInteractionListener from this SVSAdManager.
Link copied to clipboard
open fun replay()
Tells the ad manager that your content is being replayed (after being completed).
Link copied to clipboard
open fun resumeContent()
Will resume the content monitoring.
Link copied to clipboard
open fun setCreativeMediaURIProvider(@Nullable provider: SVSMediaURIProvider)
Sets the SVSMediaURIProvider object used to determine the URI of the actual media to play for a given VAST media url (for media caching for instance)
Link copied to clipboard
open fun start(@NonNull contentPlayerPlugin: SVSContentPlayerPlugin)
Starts the ad playback process on the content player represented by the SVSContentPlayerPlugin object
Link copied to clipboard
open fun startAdBreak()
Will start the waiting ad break, if any.