com.iqv.vpaid

Class VideoAd

java.lang.Object

com.iqv.vpaid.VideoAd

public class VideoAd
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
VideoAd(android.content.Context context, java.lang.String data, boolean isInterstitial, boolean isFullscreen, AdPresenter.ImpressionListener impressionListener)

Method Summary

Modifier and Type	Method and Description
void	bindView(VideoAdView bannerView)
void	clearCache() Removes all video files from cache.
void	destroy() Destroy to clean-up resources if Ad no longer needed If the Ad is in "loading ad" phase, destroy causes it's interrupting and cleaning-up all related resources If the Ad is in "displaying ad" phase, destroy causes "closing ad" and cleaning-up all related resources
void	dismiss() Dismisses an banner ad This method dismisses an banner ad and only if it is currently presented.
java.lang.Boolean	isInterstitial()
boolean	isLoading() Indicates whether `AdInterstitial`/`VideoAd` in "loading ad content" process.
boolean	isReady() Indicates whether ad content was loaded successfully and ready to be displayed.
boolean	isRewarded()
boolean	isShowing() Indicates whether `AdInterstitial`/`VideoAd` currently presented on screen.
void	load() Starts loading ad content process.
void	pause() Pauses video ad Needs to be triggered on appropriate Activity life-cycle method "onPause()".
void	resume()
void	setAdListener(VideoAdListener videoAdListener)
void	setDebugMode(boolean mode) Use it for figure out any problems during integration process.
void	setRewarded(boolean isRewarded)
void	setVideoCacheItem(VideoAdCacheItem adCacheItem)
void	show()
void	useMobileNetworkForCaching(boolean useMobile) Defines, should use mobile network for caching video or not.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VideoAd

public VideoAd(android.content.Context context,
               java.lang.String data,
               boolean isInterstitial,
               boolean isFullscreen,
               AdPresenter.ImpressionListener impressionListener)
        throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

bindView

public void bindView(VideoAdView bannerView)

show

public void show()

dismiss

public void dismiss()

Dismisses an banner ad This method dismisses an banner ad and only if it is currently presented. NOTE: should be called from UI thread

After it banner ad requires "loading process" to be ready for displaying

As a result you'll receive onAdDismissed() notification

NOTE: should be triggered from UI thread

resume

public void resume()

pause

public void pause()

Pauses video ad Needs to be triggered on appropriate Activity life-cycle method "onPause()".

isRewarded

public boolean isRewarded()

setRewarded

public void setRewarded(boolean isRewarded)

isReady

public boolean isReady()

Indicates whether ad content was loaded successfully and ready to be displayed. After you initialized a `AdInterstitial`/`VideoAd` object and triggered the `load` method, this property will be set to TRUE on it's successful completion. It is set to FALSE when loaded ad content has expired or already was presented, in this case it requires next `load` method triggering

isShowing

public boolean isShowing()

Indicates whether `AdInterstitial`/`VideoAd` currently presented on screen. Ad status will be set to `AdState.SHOWING` after trigger `show` method

Returns:

true - if ad presented on screen false - if ad absent on screen

isLoading

public boolean isLoading()

Indicates whether `AdInterstitial`/`VideoAd` in "loading ad content" process. Ad status will be set to `AdState.LOADING` after trigger `load` method

Returns:

true - if ad is loading now false - if ad is not loading now

setAdListener

public void setAdListener(VideoAdListener videoAdListener)

Parameters:

videoAdListener - provides call back methods for AdSpot lifecycle

useMobileNetworkForCaching

public void useMobileNetworkForCaching(boolean useMobile)

Defines, should use mobile network for caching video or not. By default, video will not cache on mobile network (only on wi-fi)

Parameters:

useMobile - - true if need to cache video on mobile network, false if need to cache video only on wi-fi network.

setDebugMode

public void setDebugMode(boolean mode)

Use it for figure out any problems during integration process. We recommend to set it "false" after full integration and testing.

If true - all debug logs will be in Logcat. If false - only main info logs will be in Logcat.

clearCache

public void clearCache()

Removes all video files from cache.

load

public void load()

Starts loading ad content process. It is recommended triggering it in advance to have interstitial/banner ad ready and to be able to display instantly in your application. After its execution, the interstitial/banner notifies whether the loading of the ad content failed or succeeded.

destroy

public void destroy()

Destroy to clean-up resources if Ad no longer needed If the Ad is in "loading ad" phase, destroy causes it's interrupting and cleaning-up all related resources If the Ad is in "displaying ad" phase, destroy causes "closing ad" and cleaning-up all related resources

isInterstitial

public java.lang.Boolean isInterstitial()

setVideoCacheItem

public void setVideoCacheItem(VideoAdCacheItem adCacheItem)