Package com.longtailvideo.jwplayer.media.ads

Class Advertising

java.lang.Object

com.longtailvideo.jwplayer.media.ads.AdvertisingBase

com.longtailvideo.jwplayer.media.ads.Advertising

All Implemented Interfaces:

com.longtailvideo.jwplayer.utils.Jsonable

Direct Known Subclasses:

ImaAdvertising

public class Advertising
extends AdvertisingBase

A VAST Advertising.

Constructor Summary

Constructors

Constructor	Description
Advertising(AdSource client, java.util.List<AdBreak> schedule)
Advertising(Advertising src)

Method Summary

Modifier and Type	Method	Description
AdvertisingBase	copy()
java.lang.Boolean	getConditionalAdOptOut()
java.lang.Integer	getCreativeTimeout()
java.lang.String	getPodMessage()
java.util.List<AdBreak>	getSchedule()
void	setConditionalAdOptOut(java.lang.Boolean conditionalAdOptOut)
void	setCreativeTimeout(java.lang.Integer creativeTimeout)
void	setPodMessage(java.lang.String podMessage)
void	setSchedule(java.util.List<AdBreak> schedule)
org.json.JSONObject	toJson()

Methods inherited from class com.longtailvideo.jwplayer.media.ads.AdvertisingBase

getAdMessage, getAdRules, getClient, getCueText, getRequestTimeout, getSkipMessage, getSkipOffset, getSkipText, getVpaidControls, setAdMessage, setAdRules, setClient, setCueText, setRequestTimeout, setSkipMessage, setSkipOffset, setSkipText, setVpaidControls

Methods inherited from class java.lang.Object

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

Constructor Detail

Advertising

public Advertising(AdSource client,
                   @Nullable
                   java.util.List<AdBreak> schedule)

Advertising

public Advertising(Advertising src)

Method Detail

getSchedule

@Nullable
public java.util.List<AdBreak> getSchedule()

getPodMessage

public java.lang.String getPodMessage()

Returns:

Text that displays during playback of an ad pod. Use __AD_POD_CURRENT__ to denote the currently playing item in the pod and __AD_POD_LENGTH__ for the total number of ads in the pod.

getConditionalAdOptOut

public java.lang.Boolean getConditionalAdOptOut()

Returns:

(VPAID-only) Used to tell the player to not play ads with the conditionalAd attribute inside of the VAST response.

getCreativeTimeout

public java.lang.Integer getCreativeTimeout()

Returns:

In milliseconds, the maximum amount of time between the VAST XML being returned and the adStart event before timing out.

setSchedule

public void setSchedule(java.util.List<AdBreak> schedule)

setPodMessage

public void setPodMessage(java.lang.String podMessage)

Parameters:

podMessage - Text that displays during playback of an ad pod. Use __AD_POD_CURRENT__ to denote the currently playing item in the pod and __AD_POD_LENGTH__ for the total number of ads in the pod.

setConditionalAdOptOut

public void setConditionalAdOptOut(java.lang.Boolean conditionalAdOptOut)

Parameters:

conditionalAdOptOut - (VPAID-only) Used to tell the player to not play ads with the conditionalAd attribute inside of the VAST response.

setCreativeTimeout

public void setCreativeTimeout(java.lang.Integer creativeTimeout)

Parameters:

creativeTimeout - In milliseconds, the maximum amount of time between the VAST XML being returned and the adStart event before timing out.

copy

public AdvertisingBase copy()

Specified by:

copy in class AdvertisingBase

toJson

public org.json.JSONObject toJson()

Specified by:

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

Overrides:

toJson in class AdvertisingBase