com.pubmatic.sdk.common.viewability

Interface POBVideoMeasurementProvider

All Superinterfaces:

POBMeasurementProvider

public interface POBVideoMeasurementProvider
extends POBMeasurementProvider

This interface list all methods to be implemented by viewability measurement provider to ensure its compatibility with OpenWrap SDK for measuring video ad formats.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	POBVideoMeasurementProvider.POBOmidSessionListener Listener to notify successful measurement session initialization
static interface	POBVideoMeasurementProvider.POBVerificationScriptResource
static class	POBVideoMeasurementProvider.POBVideoAdErrorType
static class	POBVideoMeasurementProvider.POBVideoPlayerState

Nested classes/interfaces inherited from interface com.pubmatic.sdk.common.viewability.POBMeasurementProvider

POBMeasurementProvider.POBFriendlyObstructionPurpose, POBMeasurementProvider.POBScriptListener

Method Summary

Modifier and Type	Method and Description
void	impressionOccurred() OpenWrap SDK calls this method to notify ad session about impression event
void	loaded(boolean isSkippable, float skipDuration) OpenWrap SDK calls this method to notify ad loaded event
void	signalAdEvent(POBDataType.POBVideoAdEventType event) OpenWrap SDK calls this method to signal POBVideoMeasurementProvider for viewability measurement session.
void	signalError(POBVideoMeasurementProvider.POBVideoAdErrorType errorType, java.lang.String message) OpenWrap SDK calls this method to notify error to ad session
void	signalPlayerStateChange(POBVideoMeasurementProvider.POBVideoPlayerState videoPlayerState) OpenWrap SDK calls this method to notify player state event
void	start(float duration, float playerVolume) OpenWrap SDK calls this method to notify start event
void	startAdSession(android.view.View view, java.util.List<POBVideoMeasurementProvider.POBVerificationScriptResource> resources, POBVideoMeasurementProvider.POBOmidSessionListener omidSessionListener) OpenWrap SDK calls this method to start view-ability measurement session on Ad load.

Methods inherited from interface com.pubmatic.sdk.common.viewability.POBMeasurementProvider

addFriendlyObstructions, finishAdSession, omidJsServiceScript, omSDKVersion, removeFriendlyObstructions, setTrackView

Method Detail

signalAdEvent

void signalAdEvent(@NonNull
                   POBDataType.POBVideoAdEventType event)

OpenWrap SDK calls this method to signal POBVideoMeasurementProvider for viewability measurement session. Use this method to signal different video Ad events like IMPRESSION, FIRST_QUARTILE etc.

Parameters:

event - POBVideoAdEventType of event to signal

startAdSession

void startAdSession(android.view.View view,
                    @NonNull
                    java.util.List<POBVideoMeasurementProvider.POBVerificationScriptResource> resources,
                    @NonNull
                    POBVideoMeasurementProvider.POBOmidSessionListener omidSessionListener)

OpenWrap SDK calls this method to start view-ability measurement session on Ad load. Use this method to initialize measurement provider SDK once and start Ad session.

Parameters:

view - ad view

resources - ad verification resources

impressionOccurred

void impressionOccurred()

OpenWrap SDK calls this method to notify ad session about impression event

signalPlayerStateChange

void signalPlayerStateChange(@NonNull
                             POBVideoMeasurementProvider.POBVideoPlayerState videoPlayerState)

OpenWrap SDK calls this method to notify player state event

Parameters:

videoPlayerState - POBVideoPlayerState of video player

signalError

void signalError(@NonNull
                 POBVideoMeasurementProvider.POBVideoAdErrorType errorType,
                 @NonNull
                 java.lang.String message)

OpenWrap SDK calls this method to notify error to ad session

Parameters:

errorType - type of error to notify

message - error message

loaded

void loaded(boolean isSkippable,
            float skipDuration)

OpenWrap SDK calls this method to notify ad loaded event

Parameters:

isSkippable - true if ad is skippable

start

void start(float duration,
           float playerVolume)

OpenWrap SDK calls this method to notify start event

Parameters:

duration - vast ad duration