com.pubmatic.sdk.video.renderer

Class POBVideoRenderer

java.lang.Object

com.pubmatic.sdk.video.renderer.POBVideoRenderer

All Implemented Interfaces:

com.pubmatic.sdk.common.ui.POBBannerRendering, POBVastPlayerListener, POBVastPlayerListener.POBAutoClickEventListener, POBVideoRendering, com.pubmatic.sdk.webrendering.ui.POBOnSkipOptionUpdateListener, com.pubmatic.sdk.webrendering.ui.POBViewabilityTracker.OnViewabilityChangedListener

public class POBVideoRenderer
extends java.lang.Object
implements POBVideoRendering, POBVastPlayerListener, POBVastPlayerListener.POBAutoClickEventListener, com.pubmatic.sdk.webrendering.ui.POBViewabilityTracker.OnViewabilityChangedListener, com.pubmatic.sdk.webrendering.ui.POBOnSkipOptionUpdateListener

Renderer class handles the Video Rendering and provides related callbacks

Nested Class Summary

Nested classes/interfaces inherited from interface com.pubmatic.sdk.video.player.POBVastPlayerListener

POBVastPlayerListener.POBAutoClickEventListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	VIEWABILITY_THRESHOLD_PERCENT_FOR_BANNER

Constructor Summary

Constructors

Constructor and Description
POBVideoRenderer(POBVastPlayer vastPlayer, com.pubmatic.sdk.webrendering.ui.POBViewabilityTracker viewabilityTracker, java.lang.String placementType) Constructs video renderer by using vast player, registers to setVastPlayerListener and set max threshold for wrapper calls and set the linearity for the vast player

Method Summary

Modifier and Type	Method and Description
void	destroy() To do cleanup
void	disableIconClickCallbacks() To disable industry icon related click callbacks.
void	invalidateExpiration()
void	onAutoClickEvent() Notifies for Click Event when actt is enabled
void	onClose() Callback method which notifies interaction callback to PMHtmlRendererListener reference
void	onEndCardWillLeaveApp() Notifies if end card leaves app
void	onFailedToPlay(com.pubmatic.sdk.common.POBError error) Callback method, gets called when failed to load/play vast ad Also notifies it to reference of PMHtmlRendererListener
void	onIndustryIconClick(java.lang.String url) Callback method, gets called when landing page is about to open on industry icon click.
void	onOpenLandingPage(java.lang.String url) Callback method, gets called when landing page is about to open Open the url either in internal browser/ external browser or opens up specific app if url is deep link supported and notifies specific PMHtmlRendererListener callbacks
void	onPlaybackCompleted(float duration) Notifies when video content is played completely and end card is about to show.
void	onReadyToPlay(POBVastAd vastAd, float skipOffset) Callback method, gets called when content is available and Vast player is ready to ad Also notifies it to reference of PMHtmlRendererListener
void	onSkip() Callback method, gets called when skip button is about to click
void	onSkipOptionUpdate(boolean isEnable)
void	onVideoEventOccurred(POBVastCreative.POBEventTypes eventType) Notifies all vast event.
void	onVideoStarted(float duration, float playerVolume) Notifies when first frame of video is rendered.
void	onViewabilityChanged(boolean viewability)
void	proceedAdSkip(boolean skip) Method to notify video renderer to proceed to skip depending on skip parameter value.
void	renderAd(com.pubmatic.sdk.common.base.POBAdDescriptor descriptor) Callback method gets called to prepare ad play inside Vast player
void	setAdRendererListener(com.pubmatic.sdk.common.base.POBAdRendererListener listener) Registers to POBAdRendererListener
void	setExpirationTimeout(long timeOut) Sets an Ad expiration time out value in milli seconds.
void	setMeasurementProvider(com.pubmatic.sdk.common.viewability.POBVideoMeasurementProvider measurementProvider)
void	setVideoRenderingListener(POBVideoRenderingListener listener) Register to Video rendering listener to get POBVideoRenderingListener callbacks
void	setVideoSkipEventListener(POBVideoSkipEventListener listener) Registers to POBVideoSkipEventListener to get video skip related callbacks
void	shouldForwardClickEvent() Notifies whether click should be forwarded or not Note: This event should be fired in case of MRAID end card click

Methods inherited from class java.lang.Object

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

Field Detail

VIEWABILITY_THRESHOLD_PERCENT_FOR_BANNER

public static final int VIEWABILITY_THRESHOLD_PERCENT_FOR_BANNER

See Also:

Constant Field Values

Constructor Detail

POBVideoRenderer

public POBVideoRenderer(@NonNull
                        POBVastPlayer vastPlayer,
                        @NonNull
                        com.pubmatic.sdk.webrendering.ui.POBViewabilityTracker viewabilityTracker,
                        @NonNull
                        java.lang.String placementType)

Constructs video renderer by using vast player, registers to setVastPlayerListener and set max threshold for wrapper calls and set the linearity for the vast player

Parameters:

vastPlayer - Vast Player instance

viewabilityTracker - instance of POBViewabilityTracker to track view visibility

placementType - Placement type either 'interstitial' or 'inline'

Method Detail

setMeasurementProvider

public void setMeasurementProvider(@Nullable
                                   com.pubmatic.sdk.common.viewability.POBVideoMeasurementProvider measurementProvider)

disableIconClickCallbacks

public void disableIconClickCallbacks()

To disable industry icon related click callbacks. By default it's value set to false

setExpirationTimeout

public void setExpirationTimeout(long timeOut)

Sets an Ad expiration time out value in milli seconds.

Parameters:

timeOut - Expiration time out value in milli seconds

renderAd

public void renderAd(@NonNull
                     com.pubmatic.sdk.common.base.POBAdDescriptor descriptor)

Callback method gets called to prepare ad play inside Vast player

Specified by:

renderAd in interface com.pubmatic.sdk.common.ui.POBBannerRendering

Parameters:

descriptor - ad descriptor

setAdRendererListener

public void setAdRendererListener(@Nullable
                                  com.pubmatic.sdk.common.base.POBAdRendererListener listener)

Registers to POBAdRendererListener

Specified by:

setAdRendererListener in interface com.pubmatic.sdk.common.ui.POBBannerRendering

Parameters:

listener - ad renderer listener

invalidateExpiration

public void invalidateExpiration()

Specified by:

invalidateExpiration in interface com.pubmatic.sdk.common.ui.POBBannerRendering

setVideoRenderingListener

public void setVideoRenderingListener(@Nullable
                                      POBVideoRenderingListener listener)

Register to Video rendering listener to get POBVideoRenderingListener callbacks

Specified by:

setVideoRenderingListener in interface POBVideoRendering

Parameters:

listener - the reference of POBVideoRenderingListener

setVideoSkipEventListener

public void setVideoSkipEventListener(@Nullable
                                      POBVideoSkipEventListener listener)

Description copied from interface: POBVideoRendering

Registers to POBVideoSkipEventListener to get video skip related callbacks

Specified by:

setVideoSkipEventListener in interface POBVideoRendering

Parameters:

listener - reference of POBVideoSkipEventListener

proceedAdSkip

public void proceedAdSkip(boolean skip)

Description copied from interface: POBVideoRendering

Method to notify video renderer to proceed to skip depending on skip parameter value.

Specified by:

proceedAdSkip in interface POBVideoRendering

Parameters:

skip - Value for skip

destroy

public void destroy()

To do cleanup

Specified by:

destroy in interface com.pubmatic.sdk.common.ui.POBBannerRendering

Specified by:

destroy in interface POBVideoRendering

onReadyToPlay

public void onReadyToPlay(@Nullable
                          POBVastAd vastAd,
                          float skipOffset)

Callback method, gets called when content is available and Vast player is ready to ad Also notifies it to reference of PMHtmlRendererListener

Specified by:

onReadyToPlay in interface POBVastPlayerListener

Parameters:

vastAd - selected vast ad

skipOffset - skip offset for skippable ads

onPlaybackCompleted

public void onPlaybackCompleted(float duration)

Description copied from interface: POBVastPlayerListener

Notifies when video content is played completely and end card is about to show.

Specified by:

onPlaybackCompleted in interface POBVastPlayerListener

Parameters:

duration - selected media file duration

onFailedToPlay

public void onFailedToPlay(@NonNull
                           com.pubmatic.sdk.common.POBError error)

Callback method, gets called when failed to load/play vast ad Also notifies it to reference of PMHtmlRendererListener

Specified by:

onFailedToPlay in interface POBVastPlayerListener

Parameters:

error - the error of POBVastError which has specific error codes with its specific error

onOpenLandingPage

public void onOpenLandingPage(@Nullable
                              java.lang.String url)

Callback method, gets called when landing page is about to open Open the url either in internal browser/ external browser or opens up specific app if url is deep link supported and notifies specific PMHtmlRendererListener callbacks

Specified by:

onOpenLandingPage in interface POBVastPlayerListener

Parameters:

url - the url which gets called on landing page

onIndustryIconClick

public void onIndustryIconClick(@Nullable
                                java.lang.String url)

Callback method, gets called when landing page is about to open on industry icon click.

Specified by:

onIndustryIconClick in interface POBVastPlayerListener

Parameters:

url - the url which gets called on landing page

shouldForwardClickEvent

public void shouldForwardClickEvent()

Description copied from interface: POBVastPlayerListener

Notifies whether click should be forwarded or not Note: This event should be fired in case of MRAID end card click

Specified by:

shouldForwardClickEvent in interface POBVastPlayerListener

onEndCardWillLeaveApp

public void onEndCardWillLeaveApp()

Description copied from interface: POBVastPlayerListener

Notifies if end card leaves app

Specified by:

onEndCardWillLeaveApp in interface POBVastPlayerListener

onSkip

public void onSkip()

Callback method, gets called when skip button is about to click

Specified by:

onSkip in interface POBVastPlayerListener

onClose

public void onClose()

Callback method which notifies interaction callback to PMHtmlRendererListener reference

Specified by:

onClose in interface POBVastPlayerListener

onVideoStarted

public void onVideoStarted(float duration,
                           float playerVolume)

Description copied from interface: POBVastPlayerListener

Notifies when first frame of video is rendered.

Specified by:

onVideoStarted in interface POBVastPlayerListener

Parameters:

duration - selected media file duration

playerVolume - media player volume

onVideoEventOccurred

public void onVideoEventOccurred(@NonNull
                                 POBVastCreative.POBEventTypes eventType)

Description copied from interface: POBVastPlayerListener

Notifies all vast event.

Specified by:

onVideoEventOccurred in interface POBVastPlayerListener

Parameters:

eventType - event occured.

onViewabilityChanged

public void onViewabilityChanged(boolean viewability)

Specified by:

onViewabilityChanged in interface com.pubmatic.sdk.webrendering.ui.POBViewabilityTracker.OnViewabilityChangedListener

onSkipOptionUpdate

public void onSkipOptionUpdate(boolean isEnable)

Specified by:

onSkipOptionUpdate in interface com.pubmatic.sdk.webrendering.ui.POBOnSkipOptionUpdateListener

onAutoClickEvent

public void onAutoClickEvent()

Description copied from interface: POBVastPlayerListener.POBAutoClickEventListener

Notifies for Click Event when actt is enabled

Specified by:

onAutoClickEvent in interface POBVastPlayerListener.POBAutoClickEventListener