Package com.jwplayer.pub.api.events

Class AdMetaEvent

java.lang.Object

com.jwplayer.pub.api.events.Event

com.jwplayer.pub.api.events.AdMetaEvent

public class AdMetaEvent
extends Event

Payload that accompanies the adMeta event. adMeta Event is triggered when metadata is obtained during ad playback.

Constructor Summary

Constructors

Constructor

Description

AdMetaEvent(JWPlayer player, AdClient client, java.lang.String adBreakId, java.lang.String adPlayId, java.lang.String offset, java.lang.String id, java.lang.String tag, AdPosition adPosition, int sequence, int wItem, int wCount, java.lang.String adSystem, int skipOffset, AdScheduleFromEvent adSchedule, java.lang.String adTitle, java.lang.String description, java.lang.String adId, java.lang.String creativeId, java.lang.String creativeAdId, java.lang.Boolean conditionalAdOptOut, int vastVersion, java.lang.String clickThroughUrl, java.lang.String linear, java.lang.Boolean mediaFileCompliance, java.lang.String[] nonComplianceReasions, MediaFile mediaFile, boolean viewable, java.lang.String creativeType, java.lang.String[] categories, java.lang.String adMessage, java.util.ArrayList<AdCompanion> companions, java.lang.String skipMessage, java.lang.String skipText, java.lang.String type, java.lang.String universalAdIdRegistry, java.lang.String universalAdIdValue)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAdBreakId()
java.lang.String	getAdId()
java.lang.String	getAdMessage()
java.lang.String	getAdPlayId()
AdPosition	getAdPosition()
AdScheduleFromEvent	getAdSchedule()
java.lang.String	getAdSystem()
java.lang.String	getAdTitle()
java.lang.String[]	getCategories()
java.lang.String	getClickThroughUrl()
AdClient	getClient()
java.util.ArrayList<AdCompanion>	getCompanions()
java.lang.Boolean	getConditionalAdOptOut()
java.lang.String	getCreativeAdId()
java.lang.String	getCreativeId()
java.lang.String	getCreativeType()
java.lang.String	getDescription()
java.lang.String	getId()
java.lang.String	getLinear()
MediaFile	getMediaFile()
java.lang.Boolean	getMediaFileCompliance()
java.lang.String	getMetaType()
java.lang.String[]	getNonComplianceReasons()
java.lang.String	getOffset()
int	getSequence()
java.lang.String	getSkipMessage()
int	getSkipOffset()
java.lang.String	getSkipText()
java.lang.String	getTag()
java.lang.String	getUniversalAdIdRegistry()
java.lang.String	getUniversalAdIdValue()
int	getVastVersion()
int	getWCount()
int	getWItem()
boolean	isViewable()

Methods inherited from class com.jwplayer.pub.api.events.Event

getPlayer

Methods inherited from class java.lang.Object

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

Constructor Detail

AdMetaEvent

public AdMetaEvent(@NonNull
                   JWPlayer player,
                   @NonNull
                   AdClient client,
                   @NonNull
                   java.lang.String adBreakId,
                   @NonNull
                   java.lang.String adPlayId,
                   @NonNull
                   java.lang.String offset,
                   @Nullable
                   java.lang.String id,
                   @Nullable
                   java.lang.String tag,
                   @NonNull
                   AdPosition adPosition,
                   int sequence,
                   int wItem,
                   int wCount,
                   @Nullable
                   java.lang.String adSystem,
                   int skipOffset,
                   @Nullable
                   AdScheduleFromEvent adSchedule,
                   @Nullable
                   java.lang.String adTitle,
                   @Nullable
                   java.lang.String description,
                   @Nullable
                   java.lang.String adId,
                   @Nullable
                   java.lang.String creativeId,
                   @Nullable
                   java.lang.String creativeAdId,
                   @Nullable
                   java.lang.Boolean conditionalAdOptOut,
                   int vastVersion,
                   @Nullable
                   java.lang.String clickThroughUrl,
                   @Nullable
                   java.lang.String linear,
                   @Nullable
                   java.lang.Boolean mediaFileCompliance,
                   @Nullable
                   java.lang.String[] nonComplianceReasions,
                   @NonNull
                   MediaFile mediaFile,
                   boolean viewable,
                   @Nullable
                   java.lang.String creativeType,
                   @Nullable
                   java.lang.String[] categories,
                   @Nullable
                   java.lang.String adMessage,
                   @NonNull
                   java.util.ArrayList<AdCompanion> companions,
                   @Nullable
                   java.lang.String skipMessage,
                   @Nullable
                   java.lang.String skipText,
                   @NonNull
                   java.lang.String type,
                   @Nullable
                   java.lang.String universalAdIdRegistry,
                   @Nullable
                   java.lang.String universalAdIdValue)

Method Detail

getClient

@NonNull
public AdClient getClient()

getAdBreakId

@NonNull
public java.lang.String getAdBreakId()

getAdPlayId

@NonNull
public java.lang.String getAdPlayId()

getOffset

@NonNull
public java.lang.String getOffset()

getId

@Nullable
public java.lang.String getId()

getTag

@Nullable
public java.lang.String getTag()

getAdPosition

@NonNull
public AdPosition getAdPosition()

getSequence

public int getSequence()

getWItem

public int getWItem()

getWCount

public int getWCount()

getAdSystem

@Nullable
public java.lang.String getAdSystem()

getSkipOffset

public int getSkipOffset()

getAdSchedule

@Nullable
public AdScheduleFromEvent getAdSchedule()

getAdTitle

@Nullable
public java.lang.String getAdTitle()

getDescription

@Nullable
public java.lang.String getDescription()

getAdId

@Nullable
public java.lang.String getAdId()

getCreativeId

@Nullable
public java.lang.String getCreativeId()

getCreativeAdId

@Nullable
public java.lang.String getCreativeAdId()

getConditionalAdOptOut

@Nullable
public java.lang.Boolean getConditionalAdOptOut()

getVastVersion

public int getVastVersion()

getClickThroughUrl

@Nullable
public java.lang.String getClickThroughUrl()

getLinear

@Nullable
public java.lang.String getLinear()

getMediaFileCompliance

@Nullable
public java.lang.Boolean getMediaFileCompliance()

getNonComplianceReasons

@Nullable
public java.lang.String[] getNonComplianceReasons()

getMediaFile

@NonNull
public MediaFile getMediaFile()

isViewable

public boolean isViewable()

getCreativeType

@Nullable
public java.lang.String getCreativeType()

getCategories

@Nullable
public java.lang.String[] getCategories()

getAdMessage

@Nullable
public java.lang.String getAdMessage()

getCompanions

@NonNull
public java.util.ArrayList<AdCompanion> getCompanions()

getSkipMessage

@Nullable
public java.lang.String getSkipMessage()

getSkipText

@Nullable
public java.lang.String getSkipText()

getMetaType

@NonNull
public java.lang.String getMetaType()

getUniversalAdIdRegistry

@Nullable
public java.lang.String getUniversalAdIdRegistry()

getUniversalAdIdValue

@Nullable
public java.lang.String getUniversalAdIdValue()