com.ooyala.android.freewheelsdk.FWAdSpot Class Reference

The ad spot that holds a list of ISlots (ads) and the Freewheel context. More...

Inheritance diagram for com.ooyala.android.freewheelsdk.FWAdSpot:
com.ooyala.android.item.AdSpot Comparable

Public Member Functions

ISlot getAd ()
 Fetch the ISlot to play. More...
 
int getTime ()
 Fetch the time at which this AdSpot should play. More...
 
boolean equals (Object obj)
 Overrides the equal method of the FWAdSpot class. More...
 
int getPriority ()
 Fetch the priority for the adspots that have same time. More...
 
int compareTo (AdSpot ad)
 compare two ad spots based on time, which is required to properly sort ad spots. More...
 
boolean needsPauseContent ()
 

Static Public Member Functions

static FWAdSpot create (ISlot ad, boolean isPostRoll)
 Initialize a Freewheel Ad Spot. More...
 

Detailed Description

The ad spot that holds a list of ISlots (ads) and the Freewheel context.

Member Function Documentation

int com.ooyala.android.item.AdSpot.compareTo ( AdSpot  ad)
inherited

compare two ad spots based on time, which is required to properly sort ad spots.

Parameters
adthe ad to be compared
static FWAdSpot com.ooyala.android.freewheelsdk.FWAdSpot.create ( ISlot  ad,
boolean  isPostRoll 
)
static

Initialize a Freewheel Ad Spot.

Note that this AdSpot does not actually have a stream like other AdSpots

Parameters
adthe ISlot to play
isPostRollif this is a post roll spot
boolean com.ooyala.android.freewheelsdk.FWAdSpot.equals ( Object  obj)

Overrides the equal method of the FWAdSpot class.

Parameters
objthe object compared with current FWAdSpot
Returns
true if the object is the current FWAdSpot, otherwise false
ISlot com.ooyala.android.freewheelsdk.FWAdSpot.getAd ( )

Fetch the ISlot to play.

Returns
the ISlot to play
int com.ooyala.android.item.AdSpot.getPriority ( )
inherited

Fetch the priority for the adspots that have same time.

The ad spot with higher priority(smaller value) will be played first. subclass should override the default implementation.

Returns
The priority .
int com.ooyala.android.freewheelsdk.FWAdSpot.getTime ( )

Fetch the time at which this AdSpot should play.

Returns
The time at which this AdSpot should play in milliseconds.
boolean com.ooyala.android.item.AdSpot.needsPauseContent ( )
inherited
Returns
if the ad spot needs to pause content and play an ad stream return true if content needs to be paused, e.g. VAST Linear ads false if content does not need to be paused, e.g. VAST Nonlinear ads