com.ooyala.android.plugin.AdPluginInterface Interface Reference

The interface that must be implemented in order to plug into OoyalaPlayer to play ads. More...

Inheritance diagram for com.ooyala.android.plugin.AdPluginInterface:

Public Member Functions
boolean	onContentChanged ()
	This is called when content changed. More...
boolean	onInitialPlay ()
	This is called before start playing content so plugin can play preroll. More...
boolean	onPlayheadUpdate (int playhead)
	This is called when playhead is updated so plugin can play midroll. More...
boolean	onContentFinished ()
	This is called before finishing playing content so plugin can play postroll. More...
boolean	onCuePoint (int cuePointIndex)
	This is called when a cue point is reached so plugin can play midroll. More...
boolean	onContentError (int errorCode)
	This is called when an error occured when playing back content. More...
void	onAdModeEntered ()
	This is called when control is handed over to the plugin. More...
PlayerInterface	getPlayerInterface ()
	This is called ooyala UI pass down UI related events. More...
void	resetAds ()
	This is called to reset all ads to unplayed. 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...
Set< Integer >	getCuePointsInMilliSeconds ()
	This returns the cue points. 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...

Detailed Description

The interface that must be implemented in order to plug into OoyalaPlayer to play ads.

Member Function Documentation

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

(

)

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.AdPluginInterface.getCuePointsInMilliSeconds

(

)

This returns the cue points.

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, and com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.

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

(

)

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

)

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.AdPluginInterface.onAdModeEntered

(

)

This is called when control is handed over to the plugin.

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, and com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.

boolean com.ooyala.android.plugin.AdPluginInterface.onContentChanged

(

)

This is called when content changed.

Returns

a token string if plugin wants take control, null otherwise

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, com.ooyala.android.OoyalaManagedAdsPlugin, and com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.

boolean com.ooyala.android.plugin.AdPluginInterface.onContentError

(

int

errorCode

)

This is called when an error occured when playing back content.

Returns

a token string if plugin wants take control, null otherwise

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, and com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.

boolean com.ooyala.android.plugin.AdPluginInterface.onContentFinished

(

)

This is called before finishing playing content so plugin can play postroll.

Returns

a token string if plugin wants take control, null otherwise

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, and com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.

boolean com.ooyala.android.plugin.AdPluginInterface.onCuePoint

(

int

cuePointIndex

)

This is called when a cue point is reached so plugin can play midroll.

Returns

a token string if plugin wants take control, null otherwise

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, and com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.

boolean com.ooyala.android.plugin.AdPluginInterface.onInitialPlay

(

)

This is called before start playing content so plugin can play preroll.

Returns

a token string if plugin wants take control, null otherwise

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, and com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.

boolean com.ooyala.android.plugin.AdPluginInterface.onPlayheadUpdate

(

int

playhead

)

This is called when playhead is updated so plugin can play midroll.

Returns

a token string if plugin wants take control, null otherwise

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, and com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.

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.

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.AdPluginInterface.resetAds

(

)

This is called to reset all ads to unplayed.

Implemented in com.ooyala.android.imasdk.OoyalaIMAManager, com.ooyala.android.freewheelsdk.OoyalaFreewheelManager, and com.ooyala.android.plugin.ManagedAdsPlugin< T extends AdSpot >.

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

(

)

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.