- GENERAL_COMPANION_AD_ERROR - Static variable in class com.pubmatic.sdk.video.POBVastError
-
General CompanionAds error.
- GENERAL_LINEAR_ERROR - Static variable in class com.pubmatic.sdk.video.POBVastError
-
General Linear error.
- GENERAL_NONLINEAR_AD_ERROR - Static variable in class com.pubmatic.sdk.video.POBVastError
-
General NonLinearAds error.
- GENERAL_WRAPPER_ERROR - Static variable in class com.pubmatic.sdk.video.POBVastError
-
General Wrapper error.
- getAds() - Method in class com.pubmatic.sdk.video.vastmodels.POBVast
-
List of Inline or Wrapper Ads
- getAdSequence() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
Returns an integer value with sequence values those are part of a pod and are intended to be
played in sequence.
- getAdServingId() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
A unique or pseudo-unique (long enough to be unique when combined with timestamp data) numerical value.
- getAdSystem() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
A string that provides the name of the ad server that returned the ad
- getAdTitle() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
A string that provides a common name for the ad
- getAdType() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
Vast ad type inline or wrapper
- getAdVerification() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
List of the AdVerification objects
- getApiFramework() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
The API necessary to communicate with the creative if available
- getApiFramework() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
The API necessary to communicate with the creative if available
- getAssetHeight() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
The pixel width of the creative.
- getAssetWidth() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
The pixel width of the creative.
- getAttributeValue(String) - Method in class com.pubmatic.sdk.video.xmlserialiser.POBNodeBuilder
-
Returns the value of current node attribute for provided attribute name
- getBitRate(boolean, boolean) - Static method in class com.pubmatic.sdk.video.player.POBVastPlayerUtil
-
Returns the bitrate for device screen scale/resolution and network.
- getBitrate() - Method in class com.pubmatic.sdk.video.vastmodels.POBMediaFile
-
Specifies the average bitrate for the media file
- getClickThroughURL() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
A URI to open when companion ad is clicked.
- getClickThroughURL() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
A URI to open when companion ad is clicked.
- getClickThroughURL() - Method in class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
A URI to open when companion ad is clicked.
- getClickThroughURL() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastCreative
-
A URI to open when companion ad is clicked.
- getClickTrackers() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
A URI to notify the player that ad was clicked.
- getClickTrackers() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
A URI to notify the player that icon view is clicked.
- getClickTrackers() - Method in class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
A URI to notify the player that ad was clicked.
- getClickTrackers() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastCreative
-
A URI to notify the player that ad was clicked.
- getClosestClickThroughURL() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
Returns the closest clickThrough URL from the Linear ad of current Vast ad.
- getClosestIcon() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
Returns the closest Icon from the Linear ad of current Vast ad.
- getCombinedCompanions() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
List of combined companions from all the wrappers
- getCombinedList(POBVastAd.POBVastAdParameter) - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
Returns the list of the Vast tracking URLs for Inline and all level of its wrapper based on
provided parameter
- getCombinedObjectList(POBVastAd.POBVastAdParameter) - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
Returns the list of the Vast Ad nodes for Inline and all level of its wrapper based on
provided parameter
- getCombinedTrackingEventList(POBVastCreative.POBEventTypes) - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
Returns the list of the Vast tracking URLs for Inline and all level of its wrapper, based on
provided event type
- getCombinedVerificationList() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
List of the specified Vast ad parameter
- getCompanions() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
List of companion creatives.
- getContentHeight() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
- getContentHeight() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
Returns the height of the icon.
- getContentWidth() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
- getContentWidth() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
Returns the width of the icon.
- getControllerView() - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayer
-
Returns the player controller view instance
- getControllerView() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
Returns the player controller view instance
- getCreative() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
Creative of type POBVastCreative.
- getCreativeType() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
- getCreativeType() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
- getCreativeType() - Method in class com.pubmatic.sdk.video.vastmodels.POBResource
-
Returns the type of static creative
- getCustomClick() - Method in class com.pubmatic.sdk.video.vastmodels.POBLinear
-
A URI for tracking custom interactions.
- getDelivery() - Method in class com.pubmatic.sdk.video.vastmodels.POBMediaFile
-
Either "progressive" for progressive download protocols (such as HTTP) or "streaming" for streaming protocols.
- getDescription() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
A string value that describes a longer description of the ad
- getDuration() - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- getDuration() - Method in interface com.pubmatic.sdk.video.player.POBPlayer
-
Gets the duration of the media.
- getDuration() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
Returns the duration the icon (in seconds) that should be displayed unless clicked or ad is
finished playing; In VAST, it is provided in the format HH:MM:SS.mmm or HH:MM:SS where .mmm
is milliseconds and optional.
- getDuration() - Method in class com.pubmatic.sdk.video.vastmodels.POBLinear
-
Element to denote the intended playback duration for the video or audio component of the ad.
- getEndCardSkipAfter() - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig
-
Number of seconds a end card must be shown before skipping is
enabled.
- getErrorCode() - Method in class com.pubmatic.sdk.video.POBVastError
-
Returns the integer value of the error code.
- getErrorMessage() - Method in class com.pubmatic.sdk.video.POBVastError
-
Returns the descriptive message for probable fix
- getErrorURLs() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
List of URIs to tracking resource to be used when an error in ad playback occurs.
- getEvent() - Method in class com.pubmatic.sdk.video.vastmodels.POBTracking
-
Returns the name of event
- getExecutableResource() - Method in class com.pubmatic.sdk.video.vastmodels.POBAdVerification
-
A reference to a non-JavaScript or custom-integration resource intended for collecting
verification data
- getExpandedHeight() - Method in class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
The maximum pixel height of the creative in its expanded state
- getExpandedWidth() - Method in class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
The maximum pixel width of the creative in its expanded state
- getExpires() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
An integer value that defines the expiry period (in seconds).
- getFileSize() - Method in class com.pubmatic.sdk.video.vastmodels.POBMediaFile
-
Optional field that helps eliminate the need to calculate the size based on bitrate and duration Units - Bytes
- getHeight() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
Returns the height of placement slot
- getHeight() - Method in class com.pubmatic.sdk.video.vastmodels.POBMediaFile
-
The native height of the video file, in pixels.
- getHeight() - Method in class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
Returns the height of placement slot
- getIconList() - Method in class com.pubmatic.sdk.video.vastmodels.POBLinear
-
List of Icon objects.
- getId() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
Returns null as default implementation
- getId() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
Returns null as default implementation
- getImpressions() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
List of URLs to notify the ad server when the impression occurs.
- getJavaScriptResource() - Method in class com.pubmatic.sdk.video.vastmodels.POBAdVerification
-
Returns a list of URI to the JavaScript file used to collect verification data.
- getMaintainAspectRatio() - Method in class com.pubmatic.sdk.video.vastmodels.POBMediaFile
-
A Boolean value that indicates whether aspect ratio for media file dimensions
should be maintained when scaled to new dimensions.
- getMaintainAspectRatio() - Method in class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
A Boolean value that indicates whether aspect ratio for media file dimensions
should be maintained when scaled to new dimensions.
- getMaxDuration() - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig
-
Maximum video ad duration in seconds
- getMediaDuration() - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayer
-
Gets the duration of the media.
- getMediaDuration() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
Gets the duration of the media.
- getMediaFiles() - Method in class com.pubmatic.sdk.video.vastmodels.POBLinear
-
List of MediaFile objects.
- getMediaFileURL() - Method in class com.pubmatic.sdk.video.vastmodels.POBMediaFile
-
Media file url
- getMediaUriTimeout() - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig
-
Media Uri loading timeout
- getMinDuration() - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig
-
Minimum video ad duration in seconds
- getMinSuggestedDuration() - Method in class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
The minimum suggested duration that the creative should be displayed.
- getNode(String) - Method in class com.pubmatic.sdk.video.xmlserialiser.POBNodeBuilder
-
Retrieves a sub-node at provide xpath and returns it.
- getNodeName() - Method in class com.pubmatic.sdk.video.xmlserialiser.POBNodeBuilder
-
Returns the name of current node
- getNodeObject(String, Class<T>) - Method in class com.pubmatic.sdk.video.xmlserialiser.POBNodeBuilder
-
Creates and returns an instance of provided class type for provided xPath
- getNodeValue() - Method in class com.pubmatic.sdk.video.xmlserialiser.POBNodeBuilder
-
Returns the value of current node
- getNodeValue(String) - Method in class com.pubmatic.sdk.video.xmlserialiser.POBNodeBuilder
-
Returns the value of sub-node
- getNotViewableImpressions() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
A URI that directs the media player to a tracking resource file that the media player
should request if the ad is executed but never meets criteria for a viewable impression.
- getObjectList(String, Class<T>) - Method in class com.pubmatic.sdk.video.xmlserialiser.POBNodeBuilder
-
Creates and returns a list of provided class type for provided xPath
- getOffset() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
Returns the time of delay in seconds from when the associated linear creative begins playing
to when the icon should be displayed; In VAST, it is provided in the format of HH:MM:SS.mmm
or HH:MM:SS
- getOffset() - Method in class com.pubmatic.sdk.video.vastmodels.POBTracking
-
To notify the ad server when the ad's progress has reached the indicated percentage or time value.
- getPlayerState() - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayer
-
- getPlayerState() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
- getPricing() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
A numerical value that represents a price that can be used in real-time bidding systems
- getProgram() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
- getRawBid() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
- getRawBid() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
Not supported for Icon
- getRefreshInterval() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
- getRefreshInterval() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
Not supported for Icon
- getRenderableContent() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
- getRenderableContent() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
Returns the content to be render as an Icon.
- getRenderingMode() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
- getResource() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
Companion resources to be displayed
- getResource() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
Resources to be displayed
- getResource() - Method in class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
List of resources to be displayed
- getResource() - Method in class com.pubmatic.sdk.video.vastmodels.POBResource
-
Returns the content of resource
- getResourceType() - Method in class com.pubmatic.sdk.video.vastmodels.POBResource
-
Returns the type of resource
- getScalable() - Method in class com.pubmatic.sdk.video.vastmodels.POBMediaFile
-
A Boolean value that indicates whether the media file is meant to scale to larger dimensions.
- getScalable() - Method in class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
A Boolean value that indicates whether the media file is meant to scale to larger dimensions.
- getScaleFactor(Context) - Static method in class com.pubmatic.sdk.video.player.POBVastPlayerUtil
-
The scale factor of the display
- getSkip() - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig
-
Indicates if the player will allow the video to be skipped,
where 0 = no, 1 = yes
- getSkipabilityEnabled() - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Returns true if skip is enabled else return false
- getSkipAfter() - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig
-
Number of seconds a video must play before skipping is
enabled; only applicable if the ad is skippable.
- getSkipMin() - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig
-
Videos of total duration greater than this number of seconds
can be skippable; only applicable if the ad is skippable.
- getSkipOffset(double, POBVastPlayerConfig, long) - Static method in class com.pubmatic.sdk.video.player.POBVastPlayerUtil
-
To get best possible skip offset duration for vast player to show skip on it.
- getSkipOffset() - Method in class com.pubmatic.sdk.video.vastmodels.POBLinear
-
Time value that identifies when skip controls are made available to the end user.
- getStatus() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
- getStatus() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
- getStringList(String) - Method in class com.pubmatic.sdk.video.xmlserialiser.POBNodeBuilder
-
Creates and returns a list of node values with provided xPath
- getStringValues() - Static method in enum com.pubmatic.sdk.video.player.POBVideoPlayer.SupportedMediaType
-
To get string array of all the supported media(mime) types
- getSuitableEndCardCompanion(List<POBCompanion>, int, int) - Static method in class com.pubmatic.sdk.video.player.POBVastPlayerUtil
-
To find out best matching companion from list of companion using below steps
Step 1: Select companion ads which have renderingMode="end-card"
Step 2: if there is not companion with renderingMode="end-card" then consider existing companion list
Step 3: Calculate aspect ratio for size of each companion with current vast player size
(in case of video interstitial it will screen size)
Step 4: Pick companion having percent value nearest to 1 or with having correction not
more than +/- 0.3 factor
if any companion with above criteria is present in the provided list then return that companion
else return null
- getTargetingInfo() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
- getTargetingInfo() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
- getTrackingEvents() - Method in class com.pubmatic.sdk.video.vastmodels.POBAdVerification
-
Returns a list of non-JavaScript resources
- getTrackingEvents() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
- getTrackingEvents() - Method in class com.pubmatic.sdk.video.vastmodels.POBLinear
-
- getTrackingEvents() - Method in class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
- getTrackingEvents(POBVastCreative.POBEventTypes) - Method in class com.pubmatic.sdk.video.vastmodels.POBVastCreative
-
List of event specific event tracker URL's
- getTrackingEventUrls(POBVastCreative.POBEventTypes) - Method in class com.pubmatic.sdk.video.vastmodels.POBVastCreative
-
List of event specific event tracker URL's
- getType() - Method in class com.pubmatic.sdk.video.vastmodels.POBMediaFile
-
MIME type for the file container.
- getUniversalAdId() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
A unique creative identifier
- getUniversalAdId() - Method in class com.pubmatic.sdk.video.vastmodels.POBLinear
-
A unique creative identifier
- getUniversalAdId() - Method in class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
A unique creative identifier
- getUrl() - Method in class com.pubmatic.sdk.video.vastmodels.POBTracking
-
Returns the resource or ad server url
- getValue() - Method in enum com.pubmatic.sdk.video.player.POBVideoPlayer.SupportedMediaType
-
- getValue() - Method in enum com.pubmatic.sdk.video.vastmodels.POBVastCreative.POBEventTypes
-
- getVASTAdTagURI() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
A URI to a VAST response that may be another VAST Wrapper or a VAST InLine ad.
- getVastCreativeType() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
- getVastCreativeType() - Method in class com.pubmatic.sdk.video.vastmodels.POBLinear
-
- getVastCreativeType() - Method in class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
- getVastCreativeType() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastCreative
-
Getter method, provides type of creative which is implemented at child classes
specific event type classes
- getVastPlayerConfig() - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
- getVendorKey() - Method in class com.pubmatic.sdk.video.vastmodels.POBAdVerification
-
- getVerificationParameter() - Method in class com.pubmatic.sdk.video.vastmodels.POBAdVerification
-
- getVersion() - Method in class com.pubmatic.sdk.video.vastmodels.POBVast
-
Vast response version
- getVideoHeight() - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- getVideoHeight() - Method in interface com.pubmatic.sdk.video.player.POBPlayer
-
Get video player height
- getVideoWidth() - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- getVideoWidth() - Method in interface com.pubmatic.sdk.video.player.POBPlayer
-
Get video player width
- getView() - Method in interface com.pubmatic.sdk.video.player.POBEndCardRendering
-
Returns the current end card view
- getView() - Method in class com.pubmatic.sdk.video.player.POBEndCardView
-
- getView() - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- getViewableImpressions() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
A URI that directs the media player to a tracking resource file that the media player should
request at the time that criteria is met for a viewable impression.
- getViewTrackers() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
A URI to notify the player that icon is loaded.
- getViewUndeterminedImpressions() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
A URI that directs the media player to a tracking resource file that the media player
should request if the player cannot determine whether criteria is met for a viewable impression.
- getWidth() - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
Returns the width of placement slot
- getWidth() - Method in class com.pubmatic.sdk.video.vastmodels.POBMediaFile
-
The native width of the video file, in pixels.
- getWidth() - Method in class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
Returns the width of placement slot
- getWrapper() - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
Reference of wrapper through which current VastAd is received.
- getWrapperUriTimeout() - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig
-
Wrapper Uri request timeout
- getXPosition() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
Returns the x-coordinate of the top, left corner of the icon asset relative to the ad display
area.
- getYPosition() - Method in class com.pubmatic.sdk.video.vastmodels.POBIcon
-
Returns the y-coordinate of the top left corner of the icon asset relative to the ad display
area; values of "top" or "bottom" also accepted and indicate the topmost or
bottommost available position for the icon asset.
- onAdAboutToSkip() - Method in interface com.pubmatic.sdk.video.renderer.POBVideoSkipEventListener
-
Notify the video is about to skip.
- onAdExpired() - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- onAdInteractionStarted() - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- onAdInteractionStopped() - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- onAdReadyToRefresh(int) - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- onAdRender(View, POBAdDescriptor) - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- onAdRenderingFailed(POBError) - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- onAdUnload() - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- onAutoClickEvent() - Method in interface com.pubmatic.sdk.video.player.POBVastPlayerListener.POBAutoClickEventListener
-
Notifies for Click Event when actt is enabled
- onAutoClickEvent() - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
- onBufferingUpdate(MediaPlayer, int) - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
Called to update status in buffering a media stream received through
progressive HTTP download.
- onBufferUpdate(int) - Method in interface com.pubmatic.sdk.video.player.POBPlayer.POBPlayerListener
-
Provides callback to update buffer status of video content
The received buffering percentage indicates how much of the content has been buffered.
- onBufferUpdate(int) - Method in class com.pubmatic.sdk.video.player.POBPlayerController
-
- onBufferUpdate(int) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Callback method, gets called when media buffer update
- onBufferUpdate(int) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
Callback method to get buffer status also notifies it to reference of POBVideoPlayerListener
- onBufferUpdate(int) - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayerView.POBVideoPlayerListener
-
Provides callback to update buffer status of video content
The received buffering percentage indicates how much of the content has been buffered.
- onClick(View) - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
Click event callbacks for the view which are registered for click listener..
- onClick() - Method in class com.pubmatic.sdk.video.player.POBPlayerController
-
- onClick() - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
- onClick() - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayerView.POBVideoPlayerListener
-
Notifies the video player is clicked
- onClose() - Method in interface com.pubmatic.sdk.video.player.POBVastPlayerListener
-
Notifies when close event occurred
- onClose() - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
Callback method which notifies interaction callback to PMHtmlRendererListener reference
- onCompletion(MediaPlayer) - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
Called when the end of a media source is reached during playback.
- onCompletion() - Method in interface com.pubmatic.sdk.video.player.POBPlayer.POBPlayerListener
-
Called when the end of a media content is reached during playback.
- onCompletion() - Method in class com.pubmatic.sdk.video.player.POBPlayerController
-
- onCompletion() - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Callback method, gets called when media completes its playback.
- onCompletion() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
Callback invoked once the media player has completed it playback
also notifies it to reference of POBVideoPlayerListener
- onCompletion() - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayerView.POBVideoPlayerListener
-
Called when the end of a media content is reached during playback.
- onConfigurationChanged(Configuration) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
Called when the current configuration of the resources being used
by the application have changed.
- onEndCardWillLeaveApp() - Method in interface com.pubmatic.sdk.video.player.POBVastPlayerListener
-
Notifies if end card leaves app
- onEndCardWillLeaveApp() - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
- onError(MediaPlayer, int, int) - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- onFailedToPlay(POBError) - Method in interface com.pubmatic.sdk.video.player.POBVastPlayerListener
-
Notifies when ad is failed to load or failed play the ad
- onFailedToPlay(POBError) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
Callback method, gets called when failed to load/play vast ad
Also notifies it to reference of PMHtmlRendererListener
- onFailure(int, String) - Method in interface com.pubmatic.sdk.video.player.POBPlayer.POBPlayerListener
-
Notifies when ad is failed to load or failed play the ad
- onFailure(int, String) - Method in class com.pubmatic.sdk.video.player.POBPlayerController
-
- onFailure(int, String) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Callback method used to notify error occur while loading or playing the video ad.
- onFailure(int, String) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
- onFailure(int, String) - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayerView.POBVideoPlayerListener
-
Notifies when ad is failed to load or failed play the ad
- onFailure(POBVast, POBVastError) - Method in interface com.pubmatic.sdk.video.vastparser.POBVastParserListener
-
Failure callback called when VAST Parsing in fail or wrapper threshold has been reached with appropriate error.
- onIndustryIconClick(String) - Method in interface com.pubmatic.sdk.video.player.POBVastPlayerListener
-
Notifies when click is happened on industry icon
- onIndustryIconClick(String) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
Callback method, gets called when landing page is about to open on industry icon click.
- onInfo(MediaPlayer, int, int) - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- onLeavingApplication() - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- onMute(boolean) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
- onMute(boolean) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerController
-
- onMute(boolean) - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayerView.POBVideoPlayerListener
-
Notifies Video playback is mute/un-mute, can be used to update mute control
- onOpenLandingPage(String) - Method in interface com.pubmatic.sdk.video.player.POBVastPlayerListener
-
Notifies when click is happened on learn more button
- onOpenLandingPage(String) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
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
- onPause() - Method in interface com.pubmatic.sdk.video.player.POBPlayer.POBPlayerListener
-
Notifies Video playback is paused, can be used to update play/pause controls
- onPause() - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Callback method, gets called when media playback is about to pause
- onPause() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerController
-
Notifies Video playback is paused, can be used to update play/pause controls
- onPause() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
- onPause() - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayerView.POBVideoPlayerListener
-
Notifies Video playback is paused, can be used to update play/pause controls
- onPlaybackCompleted(float) - Method in interface com.pubmatic.sdk.video.player.POBVastPlayerListener
-
Notifies when video content is played completely and end card is about to show.
- onPlaybackCompleted(float) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
- onPrepared(MediaPlayer) - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
Called when the media file is ready for playback.
- onPrepared() - Method in interface com.pubmatic.sdk.video.player.POBPlayer.POBPlayerListener
-
Notifies video content is downloaded and it is ready to play
- onPrepared() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
Called when the media content is available for playback.
- onPrepareTimeout() - Method in interface com.pubmatic.sdk.video.player.POBPlayer.POBPlayerListener
-
Notifies timeout due to prepare/stalling
- onPrepareTimeout() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
- onProgress(int) - Method in class com.pubmatic.sdk.video.player.POBProgressiveEventHandler
-
Called on progress of video ad to check events for that time frame.
- onProgressReached(Map<POBVastCreative.POBEventTypes, List<String>>) - Method in interface com.pubmatic.sdk.video.player.POBProgressiveEventListener
-
Updates the progress of the video playing
- onProgressReached(Map<POBVastCreative.POBEventTypes, List<String>>) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
- onProgressUpdate(int) - Method in interface com.pubmatic.sdk.video.player.POBPlayer.POBPlayerListener
-
Notifies current position of playback
- onProgressUpdate(int) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Callback method provides media playback progress
Used to update skip duration and show skip button once skip offset is reached.
- onProgressUpdate(int) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerController
-
Gets called after specified interval, once video playback onStart and view is created.
- onProgressUpdate(int) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
- onProgressUpdate(int) - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayerView.POBVideoPlayerListener
-
Notifies video playback position once video playback onStart, can be used to update seek
bar
- onReadyToExecuteTrackers() - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- onReadyToPlay(POBVideoPlayerView) - Method in class com.pubmatic.sdk.video.player.POBPlayerController
-
- onReadyToPlay(POBVideoPlayerView) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Callback method, gets called when media content is available to play.
- onReadyToPlay(POBVastAd, float) - Method in interface com.pubmatic.sdk.video.player.POBVastPlayerListener
-
Notifies video content is downloaded and it is ready to play.
- onReadyToPlay(POBVideoPlayerView) - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayerView.POBVideoPlayerListener
-
Notifies video content is downloaded and it is ready to play
- onReadyToPlay(POBVastAd, float) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
Callback method, gets called when content is available and Vast player is ready to ad
Also notifies it to reference of PMHtmlRendererListener
- onRenderAdClick() - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- onResume() - Method in interface com.pubmatic.sdk.video.player.POBPlayer.POBPlayerListener
-
Notifies Video playback is resumed, can be used to update play/pause controls
- onResume() - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
- onResume() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerController
-
- onResume() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
- onResume() - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayerView.POBVideoPlayerListener
-
Notifies Video playback is resumed, can be used to update play/pause controls
- onSkip() - Method in interface com.pubmatic.sdk.video.player.POBVastPlayerListener
-
Notifies when skip event occurred
- onSkip() - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
Callback method, gets called when skip button is about to click
- onSkipOptionUpdate(boolean) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
- onSkipOptionUpdate(boolean) - Method in interface com.pubmatic.sdk.video.renderer.POBVideoRenderingListener
-
Enables the back press when skip duration is reached.
- onStart() - Method in interface com.pubmatic.sdk.video.player.POBPlayer.POBPlayerListener
-
Notifies Video playback is started, can be used to update play/pause controls
- onStart() - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Callback method, gets called when media playback is about to start
- onStart() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerController
-
Notifies Video playback is started/resumed, can be used to update play/pause controls
- onStart() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
- onStart() - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayerView.POBVideoPlayerListener
-
Notifies Video playback is started, can be used to update play/pause controls
- onStop() - Method in interface com.pubmatic.sdk.video.player.POBPlayer.POBPlayerListener
-
Notifies Video playback is stopped, can be used to update play/pause controls
- onStop() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
- onSuccess(POBVast) - Method in interface com.pubmatic.sdk.video.vastparser.POBVastParserListener
-
Success callback called when VAST Parsing in successful and found an Inline Ad
- onSurfaceCreated(Surface) - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- onSurfaceCreated(Surface) - Method in interface com.pubmatic.sdk.video.player.POBPlayer
-
Method to notify surface created
- onSurfaceDestroyed(Surface) - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- onSurfaceDestroyed(Surface) - Method in interface com.pubmatic.sdk.video.player.POBPlayer
-
Method to notify surface destroyed
- onVideoEventOccurred(POBVastCreative.POBEventTypes) - Method in interface com.pubmatic.sdk.video.player.POBVastPlayerListener
-
Notifies all vast event.
- onVideoEventOccurred(POBVastCreative.POBEventTypes) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
- onVideoSizeChanged(MediaPlayer, int, int) - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- onVideoStarted(float, float) - Method in interface com.pubmatic.sdk.video.player.POBVastPlayerListener
-
Notifies when first frame of video is rendered.
- onVideoStarted(float, float) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
- onViewabilityChanged(boolean) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
- onViewClicked(String) - Method in class com.pubmatic.sdk.video.player.POBEndCardView
-
Notify onClick to POBEndCardViewListener reference
- onViewClicked(String) - Method in class com.pubmatic.sdk.video.player.POBIconView
-
Notifies the click event when click event happens on HTML Renderer view.
- onViewRendered(View) - Method in class com.pubmatic.sdk.video.player.POBEndCardView
-
Add rendered html view to End Card
- onViewRendered(View) - Method in class com.pubmatic.sdk.video.player.POBIconView
-
Notifies the view render event of the HTML rendering.
- onViewRenderingFailed(POBError) - Method in class com.pubmatic.sdk.video.player.POBEndCardView
-
Add learn more button and notify error to POBEndCardViewListener reference( vast player)
- onViewRenderingFailed(POBError) - Method in class com.pubmatic.sdk.video.player.POBIconView
-
Notifies the failure cause of the HTML rendering
- onWindowVisibilityChanged(int) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
- parse(String) - Method in class com.pubmatic.sdk.video.vastparser.POBVastParser
-
Parse the vast response.
- parse(String, Class<T>) - Static method in class com.pubmatic.sdk.video.xmlserialiser.POBXMLParser
-
Creates an xml node from provided content and builds model class instance with node values.
- pause() - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- pause() - Method in interface com.pubmatic.sdk.video.player.POBPlayer
-
Pauses current playback.
- pause() - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Pause the video play if already playing.
- pause() - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayer
-
Pauses current playback.
- pause() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
Pauses playback.
- play() - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Starts or Resumes video playback.
- play() - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayer
-
Signals Video player to begin playback.
- play() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
Starts or resumes playback.
- playOnMute(boolean) - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayer
-
Set playOnMute to handle video playback with mute/unmute.
- playOnMute(boolean) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
- POBAdVerification - Class in com.pubmatic.sdk.video.vastmodels
-
Class contains resources and metadata to execute third-party measurement code in order
to verify VAST creative playback.
- POBAdVerification() - Constructor for class com.pubmatic.sdk.video.vastmodels.POBAdVerification
-
- POBCompanion - Class in com.pubmatic.sdk.video.vastmodels
-
Class represent companion ad associated with InLine or Wrapper Ad
- POBCompanion() - Constructor for class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
- POBEndCardRendering - Interface in com.pubmatic.sdk.video.player
-
Interface for End Card rendering
- POBEndCardUtil - Class in com.pubmatic.sdk.video.player
-
Class to handle the redundant code from POBEndCardView and POBMraidEndCardView class.
- POBEndCardUtil() - Constructor for class com.pubmatic.sdk.video.player.POBEndCardUtil
-
- POBEndCardView - Class in com.pubmatic.sdk.video.player
-
End Card Implementation to handle End Card/Companion's/Learn more functionality
- POBEndCardView(Context) - Constructor for class com.pubmatic.sdk.video.player.POBEndCardView
-
Default view constructor.
- POBIcon - Class in com.pubmatic.sdk.video.vastmodels
-
Instance of this modal class saves the data of VAST Icon.
- POBIcon() - Constructor for class com.pubmatic.sdk.video.vastmodels.POBIcon
-
- POBIconView - Class in com.pubmatic.sdk.video.player
-
Icon view Implementation to handle Industry choice icon For example AdChoice icon.
- POBIconView(Context) - Constructor for class com.pubmatic.sdk.video.player.POBIconView
-
Default view constructor.
- POBLinear - Class in com.pubmatic.sdk.video.vastmodels
-
Instance of this modal class saves the data of Linear video ads.
- POBLinear() - Constructor for class com.pubmatic.sdk.video.vastmodels.POBLinear
-
- POBLogConstants - Class in com.pubmatic.sdk.video
-
A class defining the log statements for the video ad workflow
- POBLogConstants() - Constructor for class com.pubmatic.sdk.video.POBLogConstants
-
- POBMediaFile - Class in com.pubmatic.sdk.video.vastmodels
-
Class represents a single Media file in VAST.
- POBMediaFile() - Constructor for class com.pubmatic.sdk.video.vastmodels.POBMediaFile
-
- POBMediaPlayer - Class in com.pubmatic.sdk.video.player
-
Class responsible for native media player handling and provides basic video player functionality
to play video content
- POBMediaPlayer(String, Handler) - Constructor for class com.pubmatic.sdk.video.player.POBMediaPlayer
-
Create a new media player instance and load video in background
- POBMraidEndCardView - Class in com.pubmatic.sdk.video.player
-
End Card Implementation to handle End Card/Companion's/Learn more functionality
- POBMraidEndCardView(Context) - Constructor for class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
Default view constructor.
- POBNodeBuilder - Class in com.pubmatic.sdk.video.xmlserialiser
-
Builder Class containing a Node which is used to build a POBXMLNodeListener model class
- POBNodeBuilder(Node) - Constructor for class com.pubmatic.sdk.video.xmlserialiser.POBNodeBuilder
-
Constructor to instantiate the class object with provided argument
- POBNonLinear - Class in com.pubmatic.sdk.video.vastmodels
-
Instance of this modal class saves the data of Non-Linear video ads.
- POBNonLinear() - Constructor for class com.pubmatic.sdk.video.vastmodels.POBNonLinear
-
- POBPlayer - Interface in com.pubmatic.sdk.video.player
-
Interface, provides methods for basic functionality and events of player like play,pause,etc.
- POBPlayer.POBPlayerListener - Interface in com.pubmatic.sdk.video.player
-
Player Listener to provides callback methods like ad ready to play, failed etc.
- POBPlayerController - Class in com.pubmatic.sdk.video.player
-
An abstract class defining the protocols for the Player controller
- POBPlayerController(Context) - Constructor for class com.pubmatic.sdk.video.player.POBPlayerController
-
Constructor
- POBProgressiveEventHandler - Class in com.pubmatic.sdk.video.player
-
Class to handle quartile and progressive events
- POBProgressiveEventHandler(POBProgressiveEventListener) - Constructor for class com.pubmatic.sdk.video.player.POBProgressiveEventHandler
-
Constructor
- POBProgressiveEventListener - Interface in com.pubmatic.sdk.video.player
-
An interface to update about the progress of the video playing
- POBResource - Class in com.pubmatic.sdk.video.vastmodels
-
Class to represent non video resource associated with Non-Linear or Companion creative.
- POBResource() - Constructor for class com.pubmatic.sdk.video.vastmodels.POBResource
-
- POBTracking - Class in com.pubmatic.sdk.video.vastmodels
-
Class to represent single VAST tracking element.
- POBTracking() - Constructor for class com.pubmatic.sdk.video.vastmodels.POBTracking
-
- POBVast - Class in com.pubmatic.sdk.video.vastmodels
-
Class to represent VAST response.
- POBVast() - Constructor for class com.pubmatic.sdk.video.vastmodels.POBVast
-
- POBVastAd - Class in com.pubmatic.sdk.video.vastmodels
-
Instance of this modal class saves the data of VAST Ad node.
- POBVastAd() - Constructor for class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
- POBVastAd.POBVastAdParameter - Enum in com.pubmatic.sdk.video.vastmodels
-
Enum to specify vast ad parameter type
- POBVastAd.POBVastAdType - Enum in com.pubmatic.sdk.video.vastmodels
-
Vast ad type
- POBVastCreative - Class in com.pubmatic.sdk.video.vastmodels
-
Interface to interact with various types of creatives e.g.
- POBVastCreative() - Constructor for class com.pubmatic.sdk.video.vastmodels.POBVastCreative
-
- POBVastCreative.CreativeType - Enum in com.pubmatic.sdk.video.vastmodels
-
Different types of Creative's
- POBVastCreative.POBEventTypes - Enum in com.pubmatic.sdk.video.vastmodels
-
- POBVastError - Class in com.pubmatic.sdk.video
-
Maintains the VAST error code along with specific error message
- POBVastError(int, String) - Constructor for class com.pubmatic.sdk.video.POBVastError
-
- POBVastErrorHandler - Class in com.pubmatic.sdk.video
-
It handles vast errors.
- POBVastErrorHandler(POBTrackerHandler) - Constructor for class com.pubmatic.sdk.video.POBVastErrorHandler
-
Create instance of POBVastErrorHandler
- POBVastHTMLView<T extends com.pubmatic.sdk.common.base.POBAdDescriptor> - Class in com.pubmatic.sdk.video.player
-
Abstract class defines Custom card implementation.
- POBVastHTMLView(Context) - Constructor for class com.pubmatic.sdk.video.player.POBVastHTMLView
-
Default view constructor.
- POBVastParser - Class in com.pubmatic.sdk.video.vastparser
-
Class is responsible for vast xml parsing.
- POBVastParser(POBNetworkHandler, int, POBVastParserListener) - Constructor for class com.pubmatic.sdk.video.vastparser.POBVastParser
-
Constructor
- POBVastParserListener - Interface in com.pubmatic.sdk.video.vastparser
-
Interface provides callbacks for VAST Parser
- POBVastPlayer - Class in com.pubmatic.sdk.video.player
-
This class is responsible for showing and managing video and it's respective feature like learn more
end-card
- POBVastPlayer(MutableContextWrapper, POBVastPlayerConfig) - Constructor for class com.pubmatic.sdk.video.player.POBVastPlayer
-
Constructor.
- POBVastPlayer.Linearity - Enum in com.pubmatic.sdk.video.player
-
Enum to define the linearity of VAST ad
- POBVastPlayerConfig - Class in com.pubmatic.sdk.video
-
- POBVastPlayerConfig.ConfigBuilder - Class in com.pubmatic.sdk.video
-
An internal builder class for video config
- POBVastPlayerListener - Interface in com.pubmatic.sdk.video.player
-
Interface definition for callbacks to be invoked when POBVastPlayer notifies events
- POBVastPlayerListener.POBAutoClickEventListener - Interface in com.pubmatic.sdk.video.player
-
Interface definition to notify click tracking event
- POBVastPlayerUtil - Class in com.pubmatic.sdk.video.player
-
An utility class for video specific classes
- POBVastPlayerUtil() - Constructor for class com.pubmatic.sdk.video.player.POBVastPlayerUtil
-
- POBVideoConstant - Class in com.pubmatic.sdk.video
-
Constant file defining the constants required for video module
- POBVideoConstant() - Constructor for class com.pubmatic.sdk.video.POBVideoConstant
-
- POBVideoPlayer - Interface in com.pubmatic.sdk.video.player
-
Protocol, provides methods for basic functionality and events of video player like play,pause,etc.
- POBVideoPlayer.SupportedMediaType - Enum in com.pubmatic.sdk.video.player
-
- POBVideoPlayer.VideoPlayerState - Enum in com.pubmatic.sdk.video.player
-
States of Video player
- POBVideoPlayerController - Class in com.pubmatic.sdk.video.player
-
Video player Controller, to provide video control like seek bar, mute/un-mute button on video player
- POBVideoPlayerController(Context) - Constructor for class com.pubmatic.sdk.video.player.POBVideoPlayerController
-
Constructs player controls view, and add UI controls
- POBVideoPlayerView - Class in com.pubmatic.sdk.video.player
-
Video player view follow video player protocol and provides basic video player functionality
to play video content
- POBVideoPlayerView(Context) - Constructor for class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
Constructs Video Player by initializing SurfaceView
- POBVideoPlayerView.POBVideoPlayerListener - Interface in com.pubmatic.sdk.video.player
-
Video Player Listener to provides callback methods like ad ready to play, failed etc.
- POBVideoRenderer - Class in com.pubmatic.sdk.video.renderer
-
Renderer class handles the Video Rendering and provides related callbacks
- POBVideoRenderer(POBVastPlayer, POBViewabilityTracker, String) - Constructor for class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
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
- POBVideoRendering - Interface in com.pubmatic.sdk.video.renderer
-
An interface defining the protocol for video rendering
- POBVideoRenderingListener - Interface in com.pubmatic.sdk.video.renderer
-
Interface definition to notify video rendering events
- POBVideoSkipEventListener - Interface in com.pubmatic.sdk.video.renderer
-
Interface definition to notify when user clicks on skip button and
- POBXMLNodeListener - Interface in com.pubmatic.sdk.video.xmlserialiser
-
Interface provides the method to build model class with POBNodeBuilder.
- POBXMLParser - Class in com.pubmatic.sdk.video.xmlserialiser
-
Class is responsible for xml parsing using DOM parser and create an instance of respective model class.
- proceedAdSkip(boolean) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
- proceedAdSkip(boolean) - Method in interface com.pubmatic.sdk.video.renderer.POBVideoRendering
-
Method to notify video renderer to proceed to skip
depending on skip parameter value.
- PROGRESS_UPDATE_DELAY - Static variable in interface com.pubmatic.sdk.video.player.POBPlayer
-
Time interval to update progress event
- SCHEMA_VALIDATION_ERROR - Static variable in class com.pubmatic.sdk.video.POBVastError
-
VAST schema validation error.
- setAdRendererListener(POBAdRendererListener) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
Registers to POBAdRendererListener
- setAutoClickEventListener(POBVastPlayerListener.POBAutoClickEventListener) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Method to set click tracking listener
- setAutoClickTrackingEnabled(boolean) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Method to set auto click tracking parameter
- setAutoPlayOnForeground(boolean) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Property to auto play the video when comes in background.
- setAutoPlayOnForeground(boolean) - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayer
-
Property to auto-play the video when comes in background
- setAutoPlayOnForeground(boolean) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
Property to auto-play the video when comes in background
- setBackButtonEnabled(boolean) - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig.ConfigBuilder
-
Method to set hardware back button enabled or not
- setBaseContext(Context) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Sets / update the context in runtime.
- setCloseListener(OnCloseListener) - Method in interface com.pubmatic.sdk.video.player.POBEndCardRendering
-
Register to get notification about end card close event.
- setCloseListener(OnCloseListener) - Method in class com.pubmatic.sdk.video.player.POBEndCardView
-
- setCloseListener(OnCloseListener) - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- setControllerView(POBPlayerController, FrameLayout.LayoutParams) - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayer
-
Register to controller view to add controller view on Video Player with layoutParams properties
- setControllerView(POBPlayerController, FrameLayout.LayoutParams) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
Register to controller view to add controller view on Video Player with layoutParams properties
- setDeviceInfo(POBDeviceInfo) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Set the instance of the POBDeviceInfo
- setEnableLearnMoreButton(boolean) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Enable the learn more button in the vast player
default value true
- setEndCardSize(POBAdSize) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Set an ad size of the companion ad or an end card
- setErrorCode(int) - Method in class com.pubmatic.sdk.video.POBVastError
-
(Internal for OpenWrap SDK)
- setErrorMessage(String) - Method in class com.pubmatic.sdk.video.POBVastError
-
(Internal for OpenWrap SDK)
- setExpirationTimeout(long) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
Sets an Ad expiration time out value in milli seconds.
- setLearnMoreTitle(String) - Method in interface com.pubmatic.sdk.video.player.POBEndCardRendering
-
Setter to set title for learn more button
- setLearnMoreTitle(String) - Method in class com.pubmatic.sdk.video.player.POBEndCardView
-
Setter to set title for learn more button
- setLearnMoreTitle(String) - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
Setter to set title for learn more button
- setLinearity(POBVastPlayer.Linearity) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
- setListener(POBEndCardViewListener) - Method in interface com.pubmatic.sdk.video.player.POBEndCardRendering
-
Register listener to get EndCard callbacks
- setListener(POBEndCardViewListener) - Method in class com.pubmatic.sdk.video.player.POBEndCardView
-
Register listener to get EndCard callbacks
- setListener(POBEndCardViewListener) - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
Register listener to get EndCard callbacks
- setListener(POBVideoPlayerView.POBVideoPlayerListener) - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayer
-
Register listener to get Video Player callbacks
- setListener(POBVideoPlayerView.POBVideoPlayerListener) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
Register listener to get Video Player callbacks
- setMaxWrapperThreshold(int) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Property to set maximum wrapper call should be executed
By default the value of maxWrapperThreshold is 3
- setMeasurementProvider(POBVideoMeasurementProvider) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
- setOnSkipOptionUpdateListener(POBOnSkipOptionUpdateListener) - Method in interface com.pubmatic.sdk.video.player.POBEndCardRendering
-
Register to get notification about skip option appear event.
- setOnSkipOptionUpdateListener(POBOnSkipOptionUpdateListener) - Method in class com.pubmatic.sdk.video.player.POBEndCardView
-
- setOnSkipOptionUpdateListener(POBOnSkipOptionUpdateListener) - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- setOnSkipOptionUpdateListener(POBOnSkipOptionUpdateListener) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Sets Skip button appear listener
- setPlacementType(String) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
- setPlayerListener(POBPlayer.POBPlayerListener) - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- setPlayerListener(POBPlayer.POBPlayerListener) - Method in interface com.pubmatic.sdk.video.player.POBPlayer
-
Register listener to get Video Player callbacks
- setPlayOnMute(boolean) - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig.ConfigBuilder
-
Setter method to play media with sound On/Off.
- setPrepareTimeout(int) - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- setPrepareTimeout(int) - Method in interface com.pubmatic.sdk.video.player.POBPlayer
-
Set prepare timeout to handle Player url loading.
- setPrepareTimeout(int) - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayer
-
Set prepare timeout to handle MediaPlayer url loading.
- setPrepareTimeout(int) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
- setRenderingMode(String) - Method in class com.pubmatic.sdk.video.vastmodels.POBCompanion
-
- setShowEndCardOnSkip(boolean) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
Enable EndCard showing when user click on skip button while playing video ads.
- setSkipabilityEnabled(boolean) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
This method is used enable and disable skipability before playback
- setSkipAfter(int) - Method in interface com.pubmatic.sdk.video.player.POBEndCardRendering
-
Number of seconds a end card must be shown before skipping is
enabled
Note: This will be only applicable when skippability is enabled.
- setSkipAfter(int) - Method in class com.pubmatic.sdk.video.player.POBEndCardView
-
- setSkipAfter(int) - Method in class com.pubmatic.sdk.video.player.POBMraidEndCardView
-
- setSkipAfterCompletionEnabled(boolean) - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig.ConfigBuilder
-
Optional setter to set skipAfterCompletion state.
- setStallTimeout(int) - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- setStallTimeout(int) - Method in interface com.pubmatic.sdk.video.player.POBPlayer
-
Set stall timeout to handle Player buffering.
- setVastPlayerListener(POBVastPlayerListener) - Method in class com.pubmatic.sdk.video.player.POBVastPlayer
-
- setVideoPlayerEvents(POBVideoPlayer) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerController
-
Register to POBVideoPlayer events to provide controller events to POBVideoPlayer reference
- setVideoRenderingListener(POBVideoRenderingListener) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
Register to Video rendering listener to get POBVideoRenderingListener callbacks
- setVideoRenderingListener(POBVideoRenderingListener) - Method in interface com.pubmatic.sdk.video.renderer.POBVideoRendering
-
Registers to POBVideoRenderingListener to get video rendering related callbacks
- setVideoSkipEventListener(POBVideoSkipEventListener) - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
- setVideoSkipEventListener(POBVideoSkipEventListener) - Method in interface com.pubmatic.sdk.video.renderer.POBVideoRendering
-
Registers to POBVideoSkipEventListener to get video skip related callbacks
- setVolume(int, int) - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- setVolume(int, int) - Method in interface com.pubmatic.sdk.video.player.POBPlayer
-
Set audio volume of Player
- setWrapper(POBVastAd) - Method in class com.pubmatic.sdk.video.vastmodels.POBVastAd
-
Setter to set wrpper ad on current VAST ad
- setWrapperTimeout(int) - Method in class com.pubmatic.sdk.video.vastparser.POBVastParser
-
Wrapper Url timeout
- shouldForwardClickEvent() - Method in interface com.pubmatic.sdk.video.player.POBVastPlayerListener
-
Notifies whether click should be forwarded or not
Note: This event should be fired in case of MRAID end card click
- shouldForwardClickEvent() - Method in class com.pubmatic.sdk.video.renderer.POBVideoRenderer
-
- skip(int) - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig.ConfigBuilder
-
Value indicates if the ad is skippable ('skip' = 1)
Setter which indicates if the player will allow the video to be skipped,
where 0 = no, 1 = yes
- skipAfter(int) - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig.ConfigBuilder
-
Optional setter to set Skip after config
Number of seconds a video must play before skipping is
enabled; only applicable if the ad is skippable.
- skipMin(int) - Method in class com.pubmatic.sdk.video.POBVastPlayerConfig.ConfigBuilder
-
Optional setter to set Skip min config
Videos of total duration greater than this number of seconds
can be skippable; only applicable if the ad is skippable.
- start() - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- start() - Method in interface com.pubmatic.sdk.video.player.POBPlayer
-
Start current playback.
- STATIC_HTML - Static variable in class com.pubmatic.sdk.video.POBVideoConstant
-
- stop() - Method in class com.pubmatic.sdk.video.player.POBMediaPlayer
-
- stop() - Method in interface com.pubmatic.sdk.video.player.POBPlayer
-
Stops playback after playback has been onStart or onPause.
- stop() - Method in interface com.pubmatic.sdk.video.player.POBVideoPlayer
-
Stops playback after playback has been onStart or onPause.
- stop() - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
Stops playback after playback has been onStart or onPause.
- SUPPORTED_MEDIA_TYPE - Static variable in interface com.pubmatic.sdk.video.player.POBVideoPlayer
-
List of supported media types by MediaPlayer
- surfaceChanged(SurfaceHolder, int, int, int) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
- surfaceCreated(SurfaceHolder) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
This is for internal use
Manages the display be setting holder to it, starts to update seek position
Auto start playing based on autoPlayOnForeground, which pause when surface get destroyed.
- surfaceDestroyed(SurfaceHolder) - Method in class com.pubmatic.sdk.video.player.POBVideoPlayerView
-
This is for internal use
This is called immediately before a surface is being destroyed.