Package com.pubmatic.sdk.video.player

Class POBVastPlayer

  • All Implemented Interfaces:
    android.graphics.drawable.Drawable.Callback , android.view.KeyEvent.Callback , android.view.ViewManager , android.view.ViewParent , android.view.accessibility.AccessibilityEventSource , com.pubmatic.sdk.video.player.POBACTHandling , com.pubmatic.sdk.video.player.POBProgressiveEventListener , com.pubmatic.sdk.video.player.POBVideoPlayerView.POBVideoPlayerListener 
    
public class POBVastPlayer
extends FrameLayout implements POBVideoPlayerView.POBVideoPlayerListener, POBProgressiveEventListener, POBACTHandling

    This class is responsible for showing and managing video and it's respective feature like learn more end-card

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      boolean getSkipabilityEnabled() Returns true if skip is enabled else return false
      void setSkipabilityEnabled(boolean enabled) This method is used enable and disable skipability before playback
      POBVastPlayerConfig getVastPlayerConfig()
      static POBVastPlayer createInstance(@NonNull() Context context, @NonNull() POBVastPlayerConfig config) Creates a new instance of POBVastPlayer with provided context and returns the same.
      void setWatermark(@Nullable() String watermark) Used to set the base64 encoded string of the watermark to be rendered along with the ad.
      void setBaseContext(@NonNull() Context context) Sets / update the context in runtime.
      void setVastPlayerListener(@Nullable() POBVastPlayerListener listener)
      void setEndCardEnabled(boolean enabled) Sets whether end card should be shown after video completion.
      void load(@NonNull() String vastData) Loads give vast string, does parsing and plays compatible media file
      void setAutoPlayOnForeground(boolean flag) Property to auto play the video when comes in background.
      void play() Starts or Resumes video playback.
      void pause() Pause the video play if already playing.
      void destroy() Method to cleanup POBVastPlayer resources
      float getVideoAspectRatio() Returns the aspect ratio of the selected video media file.
      void onReadyToPlay(@NonNull() POBVideoPlayerView player) Callback method, gets called when media content is available to play.
      void onFailure(int errorCode, @NonNull() String errorMessage) Callback method used to notify error occur while loading or playing the video ad.
      void onBufferUpdate(int buffer) Callback method, gets called when media buffer update
      void onCompletion() Callback method, gets called when media completes its playback.
      void onStart() Callback method, gets called when media playback is about to start
      void onPause() Callback method, gets called when media playback is about to pause
      void onResume() Notifies Video playback is resumed, can be used to update play/pause controls
      void onProgressUpdate(int seekPosition) Callback method provides media playback progress Used to update skip duration and show skip button once skip offset is reached.
      void onMute(boolean isMute) Notifies Video playback is mute/un-mute, can be used to update mute control
      void onClick() Notifies the video player is clicked
      void onProgressReached(@NonNull() Map<POBVastCreative.POBEventTypes, List<String>> events) Updates the progress of the video playing
      boolean getACTEnabled() Returns whether ACT is currently enabled.
      void handleDeferredOpenStoreClick() Handles deferred actions after user returns from browser/store when ACT is enabled.
      void setCTAOverlayData(@Nullable() POBCTAOverlayData ctaOverlayData) Sets the CTA overlay data
      void setEndCardSelectionType(@Nullable() POBVastPlayer.EndCardSelectionType endCardSelectionType) Sets the end card selection
      void setBidBundleId(@Nullable() String bidBundleId) Sets bundle id received from bid response
      void setAdomains(@NonNull() JSONArray adomains) Sets advertiser domains from the bid response (OpenWrap bid.adomain).
      void setEndCardSize(@Nullable() POBAdSize adSize) Set an ad size of the companion ad or an end card
      void setPlacementType(@NonNull() String placementType)
      void setEnableLearnMoreButton(boolean enableLearnMoreButton) Enable the learn more button in the vast player default value true
      void setFSCEnabled(boolean isFSCEnabled)
      void setACTEnabled(boolean isACTEnabled) Enables or disables the ACT feature.
      void setShowEndCardOnSkip(boolean showEndCardOnSkip) Enable EndCard showing when user click on skip button while playing video ads.
      void setMaxWrapperThreshold(int maxWrapperThreshold) Property to set maximum wrapper call should be executed By default the value of maxWrapperThreshold is 3
      void setLinearity(POBVastPlayer.Linearity linearity) Setter to set linearity for vast player, The default value of the linearity in Linear see ANY
      void setDeviceInfo(@NonNull() POBDeviceInfo deviceInfo) Set the instance of the POBDeviceInfo
      void setOnSkipOptionUpdateListener(@Nullable() POBOnSkipOptionUpdateListener onSkipOptionUpdateListener) Sets Skip button appear listener

      • Methods inherited from class android.widget.FrameLayout

        generateLayoutParams, getAccessibilityClassName, getConsiderGoneChildrenWhenMeasuring, getMeasureAllChildren, setForegroundGravity, setMeasureAllChildren, shouldDelayChildPressedState

      • Methods inherited from class android.view.ViewGroup

        addChildrenForAccessibility, addExtraDataToAccessibilityNodeInfo, addFocusables, addKeyboardNavigationClusters, addStatesFromChildren, addTouchables, addView, bringChildToFront, childDrawableStateChanged, childHasTransientStateChanged, clearChildFocus, clearDisappearingChildren, clearFocus, dispatchApplyWindowInsets, dispatchCapturedPointerEvent, dispatchConfigurationChanged, dispatchCreateViewTranslationRequest, dispatchDisplayHint, dispatchDragEvent, dispatchDrawableHotspotChanged, dispatchFinishTemporaryDetach, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchPointerCaptureChanged, dispatchProvideAutofillStructure, dispatchProvideStructure, dispatchScrollCaptureSearch, dispatchSetActivated, dispatchSetSelected, dispatchStartTemporaryDetach, dispatchSystemUiVisibilityChanged, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchWindowFocusChanged, dispatchWindowInsetsAnimationEnd, dispatchWindowInsetsAnimationPrepare, dispatchWindowInsetsAnimationProgress, dispatchWindowInsetsAnimationStart, dispatchWindowSystemUiVisiblityChanged, dispatchWindowVisibilityChanged, endViewTransition, findFocus, findOnBackInvokedDispatcherForChild, findViewsWithText, focusSearch, focusableViewAvailable, gatherTransparentRegion, getChildAt, getChildCount, getChildDrawingOrder, getChildMeasureSpec, getChildVisibleRect, getClipChildren, getClipToPadding, getDescendantFocusability, getFocusedChild, getLayoutAnimation, getLayoutAnimationListener, getLayoutMode, getLayoutTransition, getNestedScrollAxes, getOverlay, getPersistentDrawingCache, getTouchscreenBlocksFocus, hasFocus, hasTransientState, indexOfChild, invalidateChild, invalidateChildInParent, isAlwaysDrawnWithCacheEnabled, isAnimationCacheEnabled, isLayoutSuppressed, isMotionEventSplittingEnabled, isTransitionGroup, jumpDrawablesToCurrentState, layout, notifySubtreeAccessibilityStateChanged, offsetDescendantRectToMyCoords, offsetRectIntoDescendantCoords, onDescendantInvalidated, onInterceptHoverEvent, onInterceptTouchEvent, onNestedFling, onNestedPreFling, onNestedPrePerformAccessibilityAction, onNestedPreScroll, onNestedScroll, onNestedScrollAccepted, onRequestSendAccessibilityEvent, onResolvePointerIcon, onStartNestedScroll, onStopNestedScroll, onViewAdded, onViewRemoved, propagateRequestedFrameRate, recomputeViewAttributes, removeAllViews, removeAllViewsInLayout, removeView, removeViewAt, removeViewInLayout, removeViews, removeViewsInLayout, requestChildFocus, requestChildRectangleOnScreen, requestDisallowInterceptTouchEvent, requestFocus, requestSendAccessibilityEvent, requestTransparentRegion, restoreDefaultFocus, scheduleLayoutAnimation, setAddStatesFromChildren, setAlwaysDrawnWithCacheEnabled, setAnimationCacheEnabled, setClipChildren, setClipToPadding, setDescendantFocusability, setLayoutAnimation, setLayoutAnimationListener, setLayoutMode, setLayoutTransition, setMotionEventSplittingEnabled, setOnHierarchyChangeListener, setPersistentDrawingCache, setRequestedFrameRate, setTouchscreenBlocksFocus, setTransitionGroup, setWindowInsetsAnimationCallback, showContextMenuForChild, startActionModeForChild, startLayoutAnimation, startViewTransition, suppressLayout, updateViewLayout

      • Methods inherited from class android.view.View

        addOnAttachStateChangeListener, addOnLayoutChangeListener, addOnUnhandledKeyEventListener, animate, announceForAccessibility, autofill, bringToFront, buildDrawingCache, buildLayer, callOnClick, canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, canScrollHorizontally, canScrollVertically, cancelDragAndDrop, cancelLongPress, cancelPendingInputEvents, checkInputConnectionProxy, clearAnimation, clearPendingCredentialRequest, clearViewTranslationCallback, combineMeasuredStates, computeScroll, computeSystemWindowInsets, createAccessibilityNodeInfo, createContextMenu, destroyDrawingCache, dispatchGenericMotionEvent, dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPrePerformAccessibilityAction, dispatchNestedPreScroll, dispatchNestedScroll, dispatchPopulateAccessibilityEvent, draw, drawableHotspotChanged, findOnBackInvokedDispatcher, findViewById, findViewWithTag, forceHasOverlappingRendering, forceLayout, generateDisplayHash, generateViewId, getAccessibilityDelegate, getAccessibilityLiveRegion, getAccessibilityNodeProvider, getAccessibilityPaneTitle, getAccessibilityTraversalAfter, getAccessibilityTraversalBefore, getAllowedHandwritingDelegatePackageName, getAllowedHandwritingDelegatorPackageName, getAlpha, getAnimation, getAnimationMatrix, getApplicationWindowToken, getAttributeResolutionStack, getAttributeSourceResourceMap, getAutofillHints, getAutofillId, getAutofillType, getAutofillValue, getBackground, getBackgroundTintBlendMode, getBackgroundTintList, getBackgroundTintMode, getBaseline, getBottom, getCameraDistance, getClipBounds, getClipBounds, getClipToOutline, getContentCaptureSession, getContentDescription, getContentSensitivity, getContext, getDefaultFocusHighlightEnabled, getDefaultSize, getDisplay, getDrawableState, getDrawingCache, getDrawingCacheBackgroundColor, getDrawingCacheQuality, getDrawingRect, getDrawingTime, getElevation, getExplicitStyle, getFilterTouchesWhenObscured, getFitsSystemWindows, getFocusable, getFocusables, getFocusedRect, getForeground, getForegroundGravity, getForegroundTintBlendMode, getForegroundTintList, getForegroundTintMode, getFrameContentVelocity, getGlobalVisibleRect, getHandler, getHandwritingBoundsOffsetBottom, getHandwritingBoundsOffsetLeft, getHandwritingBoundsOffsetRight, getHandwritingBoundsOffsetTop, getHandwritingDelegateFlags, getHandwritingDelegatorCallback, getHasOverlappingRendering, getHeight, getHitRect, getHorizontalFadingEdgeLength, getHorizontalScrollbarThumbDrawable, getHorizontalScrollbarTrackDrawable, getId, getImportantForAccessibility, getImportantForAutofill, getImportantForContentCapture, getKeepScreenOn, getKeyDispatcherState, getLabelFor, getLayerType, getLayoutDirection, getLayoutParams, getLeft, getLocalVisibleRect, getLocationInSurface, getLocationInWindow, getLocationOnScreen, getMatrix, getMeasuredHeight, getMeasuredHeightAndState, getMeasuredState, getMeasuredWidth, getMeasuredWidthAndState, getMinimumHeight, getMinimumWidth, getNextClusterForwardId, getNextFocusDownId, getNextFocusForwardId, getNextFocusLeftId, getNextFocusRightId, getNextFocusUpId, getOnFocusChangeListener, getOutlineAmbientShadowColor, getOutlineProvider, getOutlineSpotShadowColor, getOverScrollMode, getOverlay, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getParent, getParentForAccessibility, getPendingCredentialCallback, getPendingCredentialRequest, getPivotX, getPivotY, getPointerIcon, getPreferKeepClearRects, getReceiveContentMimeTypes, getRequestedFrameRate, getResources, getRevealOnFocusHint, getRight, getRootSurfaceControl, getRootView, getRootWindowInsets, getRotation, getRotationX, getRotationY, getScaleX, getScaleY, getScrollBarDefaultDelayBeforeFade, getScrollBarFadeDuration, getScrollBarSize, getScrollBarStyle, getScrollCaptureHint, getScrollIndicators, getScrollX, getScrollY, getSolidColor, getSourceLayoutResId, getStateDescription, getStateListAnimator, getSupplementalDescription, getSystemGestureExclusionRects, getSystemUiVisibility, getTag, getTextAlignment, getTextDirection, getTooltipText, getTop, getTouchDelegate, getTouchables, getTransitionAlpha, getTransitionName, getTranslationX, getTranslationY, getTranslationZ, getUniqueDrawingId, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarThumbDrawable, getVerticalScrollbarTrackDrawable, getVerticalScrollbarWidth, getViewTranslationResponse, getViewTreeObserver, getVisibility, getWidth, getWindowId, getWindowInsetsController, getWindowSystemUiVisibility, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, getZ, hasExplicitFocusable, hasFocusable, hasNestedScrollingParent, hasOnClickListeners, hasOnLongClickListeners, hasOverlappingRendering, hasPointerCapture, hasWindowFocus, inflate, invalidate, invalidateDrawable, invalidateOutline, isAccessibilityDataSensitive, isAccessibilityFocused, isAccessibilityHeading, isActivated, isAttachedToWindow, isAutoHandwritingEnabled, isClickable, isContentSensitive, isContextClickable, isCredential, isDirty, isDrawingCacheEnabled, isDuplicateParentStateEnabled, isEnabled, isFocusable, isFocusableInTouchMode, isFocused, isFocusedByDefault, isForceDarkAllowed, isHandwritingDelegate, isHapticFeedbackEnabled, isHardwareAccelerated, isHorizontalFadingEdgeEnabled, isHorizontalScrollBarEnabled, isHovered, isImportantForAccessibility, isImportantForAutofill, isImportantForContentCapture, isInEditMode, isInLayout, isInTouchMode, isKeyboardNavigationCluster, isLaidOut, isLayoutDirectionResolved, isLayoutRequested, isLongClickable, isNestedScrollingEnabled, isOpaque, isPaddingRelative, isPivotSet, isPreferKeepClear, isPressed, isSaveEnabled, isSaveFromParentEnabled, isScreenReaderFocusable, isScrollContainer, isScrollbarFadingEnabled, isSelected, isShowingLayoutBounds, isShown, isSoundEffectsEnabled, isTemporarilyDetached, isTextAlignmentResolved, isTextDirectionResolved, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, isVisibleToUserForAutofill, keyboardNavigationClusterSearch, measure, offsetLeftAndRight, offsetTopAndBottom, onApplyWindowInsets, onCancelPendingInputEvents, onCapturedPointerEvent, onCheckIsTextEditor, onCreateInputConnection, onCreateViewTranslationRequest, onCreateVirtualViewTranslationRequests, onDragEvent, onDrawForeground, onFilterTouchEventForSecurity, onFinishTemporaryDetach, onGenericMotionEvent, onHoverChanged, onHoverEvent, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyPreIme, onKeyShortcut, onKeyUp, onPointerCaptureChange, onPopulateAccessibilityEvent, onProvideAutofillStructure, onProvideAutofillVirtualStructure, onProvideContentCaptureStructure, onProvideStructure, onProvideVirtualStructure, onReceiveContent, onRtlPropertiesChanged, onScreenStateChanged, onScrollCaptureSearch, onStartTemporaryDetach, onTouchEvent, onTrackballEvent, onViewTranslationResponse, onVirtualViewTranslationResponses, onVisibilityAggregated, onWindowFocusChanged, onWindowSystemUiVisibilityChanged, performAccessibilityAction, performClick, performContextClick, performHapticFeedback, performLongClick, performReceiveContent, playSoundEffect, post, postDelayed, postInvalidate, postInvalidateDelayed, postInvalidateOnAnimation, postOnAnimation, postOnAnimationDelayed, refreshDrawableState, releasePointerCapture, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, removeOnUnhandledKeyEventListener, reportAppJankStats, requestApplyInsets, requestFitSystemWindows, requestFocusFromTouch, requestLayout, requestPointerCapture, requestRectangleOnScreen, requestUnbufferedDispatch, requireViewById, resetPivot, resolveSize, resolveSizeAndState, restoreHierarchyState, saveAttributeDataForStyleable, saveHierarchyState, scheduleDrawable, scrollBy, scrollTo, sendAccessibilityEvent, sendAccessibilityEventUnchecked, setAccessibilityDataSensitive, setAccessibilityDelegate, setAccessibilityHeading, setAccessibilityLiveRegion, setAccessibilityPaneTitle, setAccessibilityTraversalAfter, setAccessibilityTraversalBefore, setActivated, setAllowClickWhenDisabled, setAllowedHandwritingDelegatePackage, setAllowedHandwritingDelegatorPackage, setAlpha, setAnimation, setAnimationMatrix, setAutoHandwritingEnabled, setAutofillHints, setAutofillId, setBackground, setBackgroundColor, setBackgroundDrawable, setBackgroundResource, setBackgroundTintBlendMode, setBackgroundTintList, setBackgroundTintMode, setBottom, setCameraDistance, setClickable, setClipBounds, setClipToOutline, setContentCaptureSession, setContentDescription, setContentSensitivity, setContextClickable, setDefaultFocusHighlightEnabled, setDrawingCacheBackgroundColor, setDrawingCacheEnabled, setDrawingCacheQuality, setDuplicateParentStateEnabled, setElevation, setEnabled, setFadingEdgeLength, setFilterTouchesWhenObscured, setFitsSystemWindows, setFocusable, setFocusableInTouchMode, setFocusedByDefault, setForceDarkAllowed, setForeground, setForegroundTintBlendMode, setForegroundTintList, setForegroundTintMode, setFrameContentVelocity, setHandwritingBoundsOffsets, setHandwritingDelegateFlags, setHandwritingDelegatorCallback, setHapticFeedbackEnabled, setHasTransientState, setHorizontalFadingEdgeEnabled, setHorizontalScrollBarEnabled, setHorizontalScrollbarThumbDrawable, setHorizontalScrollbarTrackDrawable, setHovered, setId, setImportantForAccessibility, setImportantForAutofill, setImportantForContentCapture, setIsCredential, setIsHandwritingDelegate, setKeepScreenOn, setKeyboardNavigationCluster, setLabelFor, setLayerPaint, setLayerType, setLayoutDirection, setLayoutParams, setLeft, setLeftTopRightBottom, setLongClickable, setMinimumHeight, setMinimumWidth, setNestedScrollingEnabled, setNextClusterForwardId, setNextFocusDownId, setNextFocusForwardId, setNextFocusLeftId, setNextFocusRightId, setNextFocusUpId, setOnApplyWindowInsetsListener, setOnCapturedPointerListener, setOnClickListener, setOnContextClickListener, setOnCreateContextMenuListener, setOnDragListener, setOnFocusChangeListener, setOnGenericMotionListener, setOnHoverListener, setOnKeyListener, setOnLongClickListener, setOnReceiveContentListener, setOnScrollChangeListener, setOnSystemUiVisibilityChangeListener, setOnTouchListener, setOutlineAmbientShadowColor, setOutlineProvider, setOutlineSpotShadowColor, setOverScrollMode, setPadding, setPaddingRelative, setPendingCredentialRequest, setPivotX, setPivotY, setPointerIcon, setPreferKeepClear, setPreferKeepClearRects, setPressed, setRenderEffect, setRevealOnFocusHint, setRight, setRotation, setRotationX, setRotationY, setSaveEnabled, setSaveFromParentEnabled, setScaleX, setScaleY, setScreenReaderFocusable, setScrollBarDefaultDelayBeforeFade, setScrollBarFadeDuration, setScrollBarSize, setScrollBarStyle, setScrollCaptureCallback, setScrollCaptureHint, setScrollContainer, setScrollIndicators, setScrollX, setScrollY, setScrollbarFadingEnabled, setSelected, setSoundEffectsEnabled, setStateDescription, setStateListAnimator, setSupplementalDescription, setSystemGestureExclusionRects, setSystemUiVisibility, setTag, setTextAlignment, setTextDirection, setTooltipText, setTop, setTouchDelegate, setTransitionAlpha, setTransitionName, setTransitionVisibility, setTranslationX, setTranslationY, setTranslationZ, setVerticalFadingEdgeEnabled, setVerticalScrollBarEnabled, setVerticalScrollbarPosition, setVerticalScrollbarThumbDrawable, setVerticalScrollbarTrackDrawable, setViewTranslationCallback, setVisibility, setWillNotCacheDrawing, setWillNotDraw, setX, setY, setZ, showContextMenu, startActionMode, startAnimation, startDrag, startDragAndDrop, startNestedScroll, stopNestedScroll, toString, transformMatrixToGlobal, transformMatrixToLocal, unscheduleDrawable, updateDragShadow, willNotCacheDrawing, willNotDraw

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getSkipabilityEnabled

         boolean getSkipabilityEnabled()

        Returns true if skip is enabled else return false

        Returns:

        Skip behavior

      • setSkipabilityEnabled

         void setSkipabilityEnabled(boolean enabled)

        This method is used enable and disable skipability before playback

        Parameters:
        enabled - boolean flag

      • setWatermark

         void setWatermark(@Nullable() String watermark)

        Used to set the base64 encoded string of the watermark to be rendered along with the ad.

        Parameters:
        watermark - Base64 encoded image string

      • setBaseContext

         void setBaseContext(@NonNull() Context context)

        Sets / update the context in runtime.

        Parameters:
        context - Context instance

      • setEndCardEnabled

         void setEndCardEnabled(boolean enabled)

        Sets whether end card should be shown after video completion.

        Parameters:
        enabled - true to show end card (default), false to skip end card rendering

      • load

         void load(@NonNull() String vastData)

        Loads give vast string, does parsing and plays compatible media file

        Parameters:
        vastData - vast xml data

      • setAutoPlayOnForeground

         void setAutoPlayOnForeground(boolean flag)

        Property to auto play the video when comes in background. SeesetAutoPlayOnForeground By default this property is false

        Parameters:
        flag - set to true if you want play video when app comes to foreground else set to false

      • play

         void play()

        Starts or Resumes video playback. See play

      • pause

         void pause()

        Pause the video play if already playing. See pause

      • destroy

         void destroy()

        Method to cleanup POBVastPlayer resources

      • getVideoAspectRatio

         float getVideoAspectRatio()

        Returns the aspect ratio of the selected video media file. Calculated as width/height from the VAST MediaFile's dimensions.

        Returns:

        aspect ratio as float, or 0f if not available

      • onFailure

         void onFailure(int errorCode, @NonNull() String errorMessage)

        Callback method used to notify error occur while loading or playing the video ad. also shows the skip button if error occur while playing the video ad. See onFailure

        Parameters:
        errorCode - standard media player error code
        errorMessage - specific to the error code

      • onBufferUpdate

         void onBufferUpdate(int buffer)

        Callback method, gets called when media buffer update

        Parameters:
        buffer - the percent of content(0-100) that has been buffered

      • onCompletion

         void onCompletion()

        Callback method, gets called when media completes its playback. See @{} Used to maintain completion flag

      • onStart

         void onStart()

        Callback method, gets called when media playback is about to start

      • onPause

         void onPause()

        Callback method, gets called when media playback is about to pause

      • onResume

         void onResume()

        Notifies Video playback is resumed, can be used to update play/pause controls

      • onProgressUpdate

         void onProgressUpdate(int seekPosition)

        Callback method provides media playback progress Used to update skip duration and show skip button once skip offset is reached.

        Parameters:
        seekPosition - current playback position in milliseconds

      • onMute

         void onMute(boolean isMute)

        Notifies Video playback is mute/un-mute, can be used to update mute control

        Parameters:
        isMute - true if mute else false

      • onClick

         void onClick()

        Notifies the video player is clicked

      • getACTEnabled

         boolean getACTEnabled()

        Returns whether ACT is currently enabled.

        Returns:

        true if ACT is enabled, false otherwise

      • handleDeferredOpenStoreClick

         void handleDeferredOpenStoreClick()

        Handles deferred actions after user returns from browser/store when ACT is enabled.

      • setCTAOverlayData

         void setCTAOverlayData(@Nullable() POBCTAOverlayData ctaOverlayData)

        Sets the CTA overlay data

        Parameters:
        ctaOverlayData - CTA overlay data instance of POBCTAOverlayData

      • setBidBundleId

         void setBidBundleId(@Nullable() String bidBundleId)

        Sets bundle id received from bid response

        Parameters:
        bidBundleId - bundle id

      • setAdomains

         void setAdomains(@NonNull() JSONArray adomains)

        Sets advertiser domains from the bid response (OpenWrap bid.adomain). Used when rendering VAST companions as MRAID end cards.

        Parameters:
        adomains - domains from the winning bid, or null

      • setEndCardSize

         void setEndCardSize(@Nullable() POBAdSize adSize)

        Set an ad size of the companion ad or an end card

        Parameters:
        adSize - An ad size of the end card

      • setEnableLearnMoreButton

         void setEnableLearnMoreButton(boolean enableLearnMoreButton)

        Enable the learn more button in the vast player default value true

        Parameters:
        enableLearnMoreButton - boolean to enable/disable learn more button

      • setFSCEnabled

         void setFSCEnabled(boolean isFSCEnabled)
        Parameters:
        isFSCEnabled - boolean to enable/disable the FSC

      • setACTEnabled

         void setACTEnabled(boolean isACTEnabled)

        Enables or disables the ACT feature.

        Parameters:
        isACTEnabled - true to enable ACT, false to disable

      • setShowEndCardOnSkip

         void setShowEndCardOnSkip(boolean showEndCardOnSkip)

        Enable EndCard showing when user click on skip button while playing video ads. Default value is false

        Parameters:
        showEndCardOnSkip - the values of boolean type.

      • setMaxWrapperThreshold

         void setMaxWrapperThreshold(int maxWrapperThreshold)

        Property to set maximum wrapper call should be executed By default the value of maxWrapperThreshold is 3

        Parameters:
        maxWrapperThreshold - the value maxWrapperThreshold of integer type

      • setLinearity

         void setLinearity(POBVastPlayer.Linearity linearity)

        Setter to set linearity for vast player, The default value of the linearity in Linear see ANY

        Parameters:
        linearity - the linearity for the vast player

      • setDeviceInfo

         void setDeviceInfo(@NonNull() POBDeviceInfo deviceInfo)

        Set the instance of the POBDeviceInfo

        Parameters:
        deviceInfo - Instance of the POBDeviceInfo

      • setOnSkipOptionUpdateListener

         void setOnSkipOptionUpdateListener(@Nullable() POBOnSkipOptionUpdateListener onSkipOptionUpdateListener)

        Sets Skip button appear listener

        Parameters:
        onSkipOptionUpdateListener - listener