com.longtailvideo.jwplayer.media.ads

Class AdRules

java.lang.Object

com.longtailvideo.jwplayer.media.ads.AdRules

All Implemented Interfaces:

com.longtailvideo.jwplayer.utils.Jsonable

public class AdRules
extends java.lang.Object
implements com.longtailvideo.jwplayer.utils.Jsonable

Ad Rules - Options that control how frequently ads play back.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdRules.Builder
static interface	AdRules.RulesStartOnSeek

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RULES_START_ON_SEEK_NONE
static java.lang.String	RULES_START_ON_SEEK_PRE StartOnSeek StringDef Values

Constructor Summary

Constructors

Constructor and Description
AdRules(AdRules src) Copy constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getFrequency()
java.lang.Integer	getStartOn()
java.lang.String	getStartOnSeek()
java.lang.Integer	getTimeBetweenAds()
static AdRules	parseJson(org.json.JSONObject json)
static AdRules	parseJson(java.lang.String json)
void	setFrequency(java.lang.Integer frequency)
void	setStartOn(java.lang.Integer startOn)
void	setStartOnSeek(java.lang.String startOnSeek)
void	setTimeBetweenAds(java.lang.Integer timeBetweenAds)
org.json.JSONObject	toJson()

Methods inherited from class java.lang.Object

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

Field Detail

RULES_START_ON_SEEK_PRE

public static final java.lang.String RULES_START_ON_SEEK_PRE

StartOnSeek StringDef Values

See Also:

Constant Field Values

RULES_START_ON_SEEK_NONE

public static final java.lang.String RULES_START_ON_SEEK_NONE

See Also:

Constant Field Values

Constructor Detail

AdRules

public AdRules(AdRules src)

Copy constructor.

Parameters:

src - AdRules instance to copy

Method Detail

setStartOn

public void setStartOn(java.lang.Integer startOn)

Parameters:

startOn - The first playlist item that will allow ad playback, index starting at 1.

setFrequency

public void setFrequency(java.lang.Integer frequency)

Parameters:

frequency - Play ads only on every X playlist item. i.e. frequency 3 means only play on ads on every third playlist item. Use 0 to only play ads on the first playlist item.

setTimeBetweenAds

public void setTimeBetweenAds(java.lang.Integer timeBetweenAds)

Parameters:

timeBetweenAds - Minimum time in seconds between ads

setStartOnSeek

public void setStartOnSeek(java.lang.String startOnSeek)

getStartOn

public java.lang.Integer getStartOn()

Returns:

The first playlist item that will allow ad playback, index starting at 1.

getFrequency

public java.lang.Integer getFrequency()

Returns:

Play ads only on every X playlist item. i.e. frequency 3 means only play on ads on every third playlist item. Use 0 to only play ads on the first playlist item.

getTimeBetweenAds

public java.lang.Integer getTimeBetweenAds()

Returns:

Minimum time in seconds between ads

getStartOnSeek

public java.lang.String getStartOnSeek()

parseJson

public static AdRules parseJson(org.json.JSONObject json)
                         throws org.json.JSONException

Throws:

org.json.JSONException

parseJson

public static AdRules parseJson(java.lang.String json)
                         throws org.json.JSONException

Throws:

org.json.JSONException

toJson

public org.json.JSONObject toJson()

Specified by:

toJson in interface com.longtailvideo.jwplayer.utils.Jsonable