com.pubmatic.sdk.video

Class POBVastPlayerConfig.ConfigBuilder

java.lang.Object

com.pubmatic.sdk.video.POBVastPlayerConfig.ConfigBuilder

Enclosing class:

POBVastPlayerConfig

public static class POBVastPlayerConfig.ConfigBuilder
extends java.lang.Object

An internal builder class for video config

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MEDIA_URI_TIMEOUT
static boolean	DEFAULT_PLAY_ON_MUTE
static int	DEFAULT_SKIP
static int	DEFAULT_SKIP_AFTER
static int	DEFAULT_WRAPPER_URI_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ConfigBuilder(int minDuration, int maxDuration) Builder class constructor with recommended params

Method Summary

Modifier and Type	Method and Description
POBVastPlayerConfig	build(boolean isSkipabilityEnabled) Build POBVastPlayerConfig with provided params
static POBVastPlayerConfig	createVastConfig(org.json.JSONObject rawBid, boolean isSkipabilityEnabled, boolean skipAfterCompletion, boolean playOnMute, java.lang.String placementType) Builds the VastPlayer config from raw bid Json response or returns default VastPlayer config
POBVastPlayerConfig.ConfigBuilder	mediaUriTimeout(int mediaFileUriTimeout) Optional setter to set media file Uri timeout
POBVastPlayerConfig.ConfigBuilder	setPlayOnMute(boolean playOnMute) Setter method to play media with sound On/Off.
POBVastPlayerConfig.ConfigBuilder	skip(int skip) 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
POBVastPlayerConfig.ConfigBuilder	skipAfter(int skipAfter) 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.
POBVastPlayerConfig.ConfigBuilder	skipMin(int skipMin) 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.
POBVastPlayerConfig.ConfigBuilder	wrapperUriTimeout(int wrapperTagUriTimeout) Optional setter to set wrapper Uri timeout

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WRAPPER_URI_TIMEOUT

public static final int DEFAULT_WRAPPER_URI_TIMEOUT

See Also:

Constant Field Values

DEFAULT_MEDIA_URI_TIMEOUT

public static final int DEFAULT_MEDIA_URI_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SKIP_AFTER

public static final int DEFAULT_SKIP_AFTER

See Also:

Constant Field Values

DEFAULT_SKIP

public static final int DEFAULT_SKIP

See Also:

Constant Field Values

DEFAULT_PLAY_ON_MUTE

public static final boolean DEFAULT_PLAY_ON_MUTE

See Also:

Constant Field Values

Constructor Detail

ConfigBuilder

public ConfigBuilder(int minDuration,
                     int maxDuration)

Builder class constructor with recommended params

Parameters:

minDuration - Minimum video ad duration in seconds

maxDuration - Maximum video ad duration in seconds

Method Detail

createVastConfig

@NonNull
public static POBVastPlayerConfig createVastConfig(@Nullable
                                                            org.json.JSONObject rawBid,
                                                            boolean isSkipabilityEnabled,
                                                            boolean skipAfterCompletion,
                                                            boolean playOnMute,
                                                            @NonNull
                                                            java.lang.String placementType)

Builds the VastPlayer config from raw bid Json response or returns default VastPlayer config

Parameters:

rawBid - the raw bid of JSONObject type

isSkipabilityEnabled - State of skip behavior

skipAfterCompletion - Parameter to indicate default skip is after completion

playOnMute - Sound on/off value by default

Returns:

if Video is present and not empty in bid then method returns new VastPlayerConfig object else returns default VastPlayer config

skipAfter

public POBVastPlayerConfig.ConfigBuilder skipAfter(int skipAfter)

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. Default value is 16

Parameters:

skipAfter - the skipAfter value in int

Returns:

ConfigBuilder for POBVastPlayerConfig

skipMin

public POBVastPlayerConfig.ConfigBuilder skipMin(int skipMin)

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. Default value is 0

Parameters:

skipMin - the skipMin value in int

Returns:

ConfigBuilder for POBVastPlayerConfig

skip

public POBVastPlayerConfig.ConfigBuilder skip(int skip)

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

Parameters:

skip - the skipable value 0 = no, 1 = yes

Returns:

ConfigBuilder for POBVastPlayerConfig

setPlayOnMute

public POBVastPlayerConfig.ConfigBuilder setPlayOnMute(boolean playOnMute)

Setter method to play media with sound On/Off.

Parameters:

playOnMute - should play on mute

Returns:

Updated instance of config builder.

wrapperUriTimeout

public POBVastPlayerConfig.ConfigBuilder wrapperUriTimeout(int wrapperTagUriTimeout)

Optional setter to set wrapper Uri timeout

Parameters:

wrapperTagUriTimeout - the wrapperUriTimeout in millisecond's

Returns:

configBuilder for POBVastPlayerConfig

mediaUriTimeout

public POBVastPlayerConfig.ConfigBuilder mediaUriTimeout(int mediaFileUriTimeout)

Optional setter to set media file Uri timeout

Parameters:

mediaFileUriTimeout - the mediaUriTimeout in millisecond's

Returns:

configBuilder for POBVastPlayerConfig

build

public POBVastPlayerConfig build(boolean isSkipabilityEnabled)

Build POBVastPlayerConfig with provided params

Parameters:

isSkipabilityEnabled - State of skip behavior

Returns:

instance of POBVastPlayerConfig