Package com.pubmatic.sdk.video.renderer

Class POBVideoRenderer

  • All Implemented Interfaces:
    com.pubmatic.sdk.common.ui.POBBannerRendering , com.pubmatic.sdk.video.player.POBVastPlayerListener , com.pubmatic.sdk.video.renderer.POBVideoRendering , com.pubmatic.sdk.webrendering.ui.POBOnSkipOptionUpdateListener , com.pubmatic.sdk.webrendering.ui.POBViewabilityTracker.OnViewabilityChangedListener 
    
public class POBVideoRenderer
 implements POBVideoRendering, POBVastPlayerListener, POBViewabilityTracker.OnViewabilityChangedListener, POBOnSkipOptionUpdateListener

    Renderer class handles the Video Rendering and provides related callbacks

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description
      POBVideoRenderer(POBVastPlayer vastPlayer, POBViewabilityTracker viewabilityTracker, 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

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      void renderAd(@NonNull() POBAdDescriptor descriptor) Callback method gets called to prepare ad play inside Vast player
      void setAdRendererListener(@Nullable() POBAdRendererListener listener) Registers to POBAdRendererListener
      void invalidateExpiration()
      void setVideoSkipEventListener(@Nullable() POBVideoSkipEventListener listener) Registers to POBVideoSkipEventListener to get video skip related callbacks
      void proceedAdSkip(boolean skip) Method to notify video renderer to proceed to skip depending on skip parameter value.
      void destroy() To do cleanup
      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
      void onPlaybackCompleted(float duration) Notifies when video content is played completely and end card is about to show.
      void onFailedToPlay(@NonNull() POBError error) Callback method, gets called when failed to load/play vast ad Also notifies it to reference of PMHtmlRendererListener
      void onOpenLandingPage(@Nullable() 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 onIndustryIconClick(@Nullable() String url) Callback method, gets called when landing page is about to open on industry icon click.
      void shouldForwardClickEvent() Notifies whether click should be forwarded or not Note: This event should be fired in case of MRAID end card click
      void onEndCardWillLeaveApp() Notifies if end card leaves app
      void onDsaInfoIconClick() Notifies to show the DSA info detail screen
      void onSkip() Callback method, gets called when skip button is about to click
      void onClose() Callback method which notifies interaction callback to PMHtmlRendererListener reference
      void onVideoStarted(float duration, float playerVolume) Notifies when first frame of video is rendered.
      void onVideoEventOccurred(@NonNull() POBVastCreative.POBEventTypes eventType) Notifies all vast event.
      void onViewabilityChanged(boolean viewability)
      void onSkipOptionUpdate(boolean isEnable)
      void setMeasurementProvider(@Nullable() POBVideoMeasurementProvider measurementProvider) Set measurement provider to manage video viewability.
      void setExpirationTimeout(long timeOut) Sets an Ad expiration time out value in milli seconds.
      void setVideoRenderingListener(@Nullable() POBVideoRenderingListener listener) Register to Video rendering listener to get POBVideoRenderingListener callbacks

      • Methods inherited from class com.pubmatic.sdk.common.ui.POBBannerRendering

        destroy

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • POBVideoRenderer

        POBVideoRenderer(POBVastPlayer vastPlayer, POBViewabilityTracker viewabilityTracker, 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

      • renderAd

         void renderAd(@NonNull() POBAdDescriptor descriptor)

        Callback method gets called to prepare ad play inside Vast player

        Parameters:
        descriptor - ad descriptor

      • setAdRendererListener

         void setAdRendererListener(@Nullable() POBAdRendererListener listener)

        Registers to POBAdRendererListener

        Parameters:
        listener - ad renderer listener

      • proceedAdSkip

         void proceedAdSkip(boolean skip)

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

        Parameters:
        skip - Value for skip

      • destroy

         void destroy()

        To do cleanup

      • onReadyToPlay

         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

      • onPlaybackCompleted

         void onPlaybackCompleted(float duration)

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

        Parameters:
        duration - selected media file duration

      • onFailedToPlay

         void onFailedToPlay(@NonNull() POBError error)

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

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

      • onOpenLandingPage

         void onOpenLandingPage(@Nullable() 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

        Parameters:
        url - the url which gets called on landing page

      • onIndustryIconClick

         void onIndustryIconClick(@Nullable() String url)

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

        Parameters:
        url - the url which gets called on landing page

      • shouldForwardClickEvent

         void shouldForwardClickEvent()

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

      • onDsaInfoIconClick

         void onDsaInfoIconClick()

        Notifies to show the DSA info detail screen

      • onSkip

         void onSkip()

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

      • onClose

         void onClose()

        Callback method which notifies interaction callback to PMHtmlRendererListener reference

      • onVideoStarted

         void onVideoStarted(float duration, float playerVolume)

        Notifies when first frame of video is rendered.

        Parameters:
        duration - selected media file duration
        playerVolume - media player volume

      • setMeasurementProvider

         void setMeasurementProvider(@Nullable() POBVideoMeasurementProvider measurementProvider)

        Set measurement provider to manage video viewability.

        Parameters:
        measurementProvider - the reference of POBVideoMeasurementProvider

      • setExpirationTimeout

         void setExpirationTimeout(long timeOut)

        Sets an Ad expiration time out value in milli seconds.

        Parameters:
        timeOut - Expiration time out value in milli seconds