com.ooyala.android.plugin.SsaiPluginInterface Interface Reference

Interface for communicating with SSAI module. More...

Inheritance diagram for com.ooyala.android.plugin.SsaiPluginInterface:
com.ooyala.android.plugin.AdPluginInterface com.ooyala.android.plugin.LifeCycleInterface com.ooyala.android.AdsLearnMoreInterface

Public Member Functions

void onMetadataFetched (SsaiMetadata metadata)
 
int timeWithoutAdsInMillis (int playhead)
 
boolean isPlayingAd (int playhead)
 
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

Interface for communicating with SSAI module.

Member Function Documentation

boolean com.ooyala.android.plugin.AdPluginInterface.allADSPlayed ( )
inherited
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
newConfigThe 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.

Set<Integer> com.ooyala.android.plugin.AdPluginInterface.getCuePointsInMilliSeconds ( )
inherited
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.

boolean com.ooyala.android.plugin.SsaiPluginInterface.isPlayingAd ( int  playhead)
void com.ooyala.android.plugin.AdPluginInterface.onAdIconClicked ( int  index)
inherited

This is called when an icon is clicked.

Parameters
indexthe 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 ( )
inherited
boolean com.ooyala.android.plugin.AdPluginInterface.onContentChanged ( )
inherited
boolean com.ooyala.android.plugin.AdPluginInterface.onContentError ( int  errorCode)
inherited

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 ( )
inherited

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)
inherited

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 ( )
inherited

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

void com.ooyala.android.plugin.SsaiPluginInterface.onMetadataFetched ( SsaiMetadata  metadata)
boolean com.ooyala.android.plugin.AdPluginInterface.onPlayheadUpdate ( int  playhead)
inherited

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.plugin.AdPluginInterface.resetAds ( )
inherited
void com.ooyala.android.plugin.LifeCycleInterface.resume ( int  timeInMillisecond,
State  stateToResume 
)
inherited
void com.ooyala.android.plugin.AdPluginInterface.skipAd ( )
inherited
void com.ooyala.android.plugin.LifeCycleInterface.suspend ( boolean  onlyRemoveView)
inherited
int com.ooyala.android.plugin.SsaiPluginInterface.timeWithoutAdsInMillis ( int  playhead)