com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot > Class Template Reference

Inheritance diagram for com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >:

Public Member Functions
	ManagedAdsPlugin ()
boolean	onContentChanged ()
	This is called when content changed. More...
boolean	onInitialPlay ()
	called before content play starts More...
boolean	onPlayheadUpdate (int playhead)
	called during content play More...
boolean	onContentFinished ()
	called after content finish More...
boolean	onCuePoint (int cuePointIndex)
	called on cue points More...
boolean	onContentError (int errorCode)
	called when content playback error happens More...
void	onAdModeEntered ()
	called on content More...
void	resetAds ()
	This is called to reset all ads to unplayed. More...
Set< Integer >	getCuePointsInMilliSeconds ()
	This returns the cue points. More...
PlayerInterface	getPlayerInterface ()
	This is called ooyala UI pass down UI related events. More...
void	skipAd ()
	This is called to skip the current ad. More...
void	onAdIconClicked (int index)
	This is called when an icon is clicked. More...
boolean	allADSPlayed ()
void	reset ()
	This is called when plugin should be reset. More...
void	suspend ()
	This is called when plugin should be suspended. More...
void	suspend (boolean onlyRemoveView)
	This is called when plugin should be suspended. More...
void	resume ()
	This is called when plugin should be resumed. More...
void	resume (int timeInMillisecond, State stateToResume)
	This is called when plugin should be resumed. More...
void	destroy ()
	This is called when plugin should be destroyed. More...
void	configurationChanged (Configuration newConfig)
	This method is called when the device configuration changes while your component is running. More...
void	processClickThrough ()
	This is called to process click through. More...

Protected Member Functions
boolean	playAdsBeforeTime ()
abstract boolean	playAd (T ad)
	play the ad after content is paused More...
abstract void	processNonLinearAd (T ad)
	process an ad while content is still playing e.g. More...
int	getLastAdModeTime ()
	called after content finish More...

Protected Attributes
AdSpotManager< T >	_adSpotManager

Static Protected Attributes
static final int	PLUGIN_INIT = -2
static final int	CONTENT_CHANGED = -1

Constructor & Destructor Documentation

com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.ManagedAdsPlugin

(

)

Member Function Documentation

boolean com.ooyala.android.plugin.AdPluginInterface.allADSPlayed ( )

inherited

Returns

true if all ads were played

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, and com.ooyala.android.OoyalaManagedAdsPlugin.

void com.ooyala.android.plugin.LifeCycleInterface.configurationChanged ( Configuration  newConfig )

inherited

This method is called when the device configuration changes while your component is running.

Parameters

newConfig

The new device configuration.

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.Player, and com.ooyala.android.OoyalaManagedAdsPlugin.

void com.ooyala.android.plugin.LifeCycleInterface.destroy ( )

inherited

This is called when plugin should be destroyed.

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.ads.vast.VASTAdPlayer, com.ooyala.android.player.BaseStreamPlayer, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, com.ooyala.android.player.exoplayer.ExoStreamPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.ads.ooyala.OoyalaAdPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.android.player.Player, com.ooyala.android.imasdk.IMAAdPlayer, and com.ooyala.android.OoyalaManagedAdsPlugin.

Set<Integer> com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.getCuePointsInMilliSeconds

(

)

This returns the cue points.

Implements com.ooyala.android.plugin.AdPluginInterface.

int com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.getLastAdModeTime ( )

protected

called after content finish

Returns

CONTENT_CHANGED after onContentChanged, non-negative value after content play starts

PlayerInterface com.ooyala.android.plugin.AdPluginInterface.getPlayerInterface ( )

inherited

This is called ooyala UI pass down UI related events.

Returns

an object that implements PlayerInterface if plugin needs to process ui events, null if these events should be ignored.

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, and com.ooyala.android.OoyalaManagedAdsPlugin.

void com.ooyala.android.plugin.AdPluginInterface.onAdIconClicked ( int  index )

inherited

This is called when an icon is clicked.

Parameters

index

the icon index

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, and com.ooyala.android.OoyalaManagedAdsPlugin.

void com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.onAdModeEntered

(

)

called on content

Implements com.ooyala.android.plugin.AdPluginInterface.

boolean com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.onContentChanged

(

)

This is called when content changed.

Returns

a token string if plugin wants take control, null otherwise

Implements com.ooyala.android.plugin.AdPluginInterface.

boolean com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.onContentError

(

int

errorCode

)

called when content playback error happens

Returns

true if plugin needs to handle error, false otherwise

Implements com.ooyala.android.plugin.AdPluginInterface.

boolean com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.onContentFinished

(

)

called after content finish

Returns

true if plugin needs to play postroll ads, false otherwise

Implements com.ooyala.android.plugin.AdPluginInterface.

boolean com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.onCuePoint

(

int

cuePointIndex

)

called on cue points

Returns

true if plugin needs to play midroll ads, false otherwise

Implements com.ooyala.android.plugin.AdPluginInterface.

boolean com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.onInitialPlay

(

)

called before content play starts

Returns

true if plugin needs to play preroll ads, false otherwise

Implements com.ooyala.android.plugin.AdPluginInterface.

boolean com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.onPlayheadUpdate

(

int

playhead

)

called during content play

Parameters

playhead

the current content playhead

Returns

true if plugin needs to play midroll ads, false otherwise

Implements com.ooyala.android.plugin.AdPluginInterface.

abstract boolean com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.playAd ( T  ad )

abstractprotected

play the ad after content is paused

Parameters

ad	the ad to play

Returns

true if play succeeds, false otherwise

boolean com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.playAdsBeforeTime ( )

protected

void com.ooyala.android.AdsLearnMoreInterface.processClickThrough ( )

inherited

This is called to process click through.

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, com.ooyala.android.ads.vast.VASTAdPlayer, com.ooyala.android.OoyalaManagedAdsPlugin, com.ooyala.android.imasdk.IMAAdPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, and com.ooyala.android.ads.ooyala.OoyalaAdPlayer.

abstract void com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.processNonLinearAd ( T  ad )

abstractprotected

process an ad while content is still playing e.g.

for VAST Nonlinear ad.

Parameters

ad	the ad to process

void com.ooyala.android.plugin.LifeCycleInterface.reset ( )

inherited

This is called when plugin should be reset.

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.BaseStreamPlayer, com.ooyala.android.player.Player, com.ooyala.android.player.MoviePlayer, and com.ooyala.android.OoyalaManagedAdsPlugin.

void com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.resetAds

(

)

This is called to reset all ads to unplayed.

Implements com.ooyala.android.plugin.AdPluginInterface.

void com.ooyala.android.plugin.LifeCycleInterface.resume ( )

inherited

This is called when plugin should be resumed.

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.player.BaseStreamPlayer, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.ads.vast.VASTAdPlayer, com.ooyala.android.ads.ooyala.OoyalaAdPlayer, com.ooyala.android.player.Player, com.ooyala.android.player.MoviePlayer, and com.ooyala.android.OoyalaManagedAdsPlugin.

void com.ooyala.android.plugin.LifeCycleInterface.resume ( int  timeInMillisecond, State  stateToResume  )

inherited

This is called when plugin should be resumed.

Parameters

timeInMillisecond	the playhead time to set
stateToResume	the player state after resume

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, com.ooyala.android.player.BaseStreamPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.Player, com.ooyala.android.player.MoviePlayer, and com.ooyala.android.OoyalaManagedAdsPlugin.

void com.ooyala.android.plugin.AdPluginInterface.skipAd ( )

inherited

This is called to skip the current ad.

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, and com.ooyala.android.OoyalaManagedAdsPlugin.

void com.ooyala.android.plugin.LifeCycleInterface.suspend ( )

inherited

This is called when plugin should be suspended.

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, com.ooyala.android.player.BaseStreamPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.Player, com.ooyala.android.player.MoviePlayer, and com.ooyala.android.OoyalaManagedAdsPlugin.

void com.ooyala.android.plugin.LifeCycleInterface.suspend ( boolean  onlyRemoveView )

inherited

This is called when plugin should be suspended.

Parameters

onlyRemoveView

To remove video view

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, com.ooyala.android.player.BaseStreamPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.Player, com.ooyala.android.player.MoviePlayer, and com.ooyala.android.OoyalaManagedAdsPlugin.

Member Data Documentation

AdSpotManager<T> com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >._adSpotManager

protected

final int com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.CONTENT_CHANGED = -1

staticprotected

final int com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.PLUGIN_INIT = -2

staticprotected