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, String adBreakId, String adPlayId, String offset, String id, String tag, AdPosition adPosition, int sequence, int wItem, int wCount, String adSystem, int skipOffset, AdScheduleFromEvent adSchedule, String adTitle, String description, String adId, String creativeId, String creativeAdId, Boolean conditionalAdOptOut, int vastVersion, String clickThroughUrl, String linear, Boolean mediaFileCompliance, String[] nonComplianceReasions, MediaFile mediaFile, boolean viewable, String creativeType, String[] categories, String adMessage, ArrayList<AdCompanion> companions, String skipMessage, String skipText, String type, String universalAdIdRegistry, String universalAdIdValue)

Method Summary

Modifier and Type	Method	Description
String	getAdBreakId()
String	getAdId()
String	getAdMessage()
String	getAdPlayId()
AdPosition	getAdPosition()
AdScheduleFromEvent	getAdSchedule()
String	getAdSystem()
String	getAdTitle()
String[]	getCategories()
String	getClickThroughUrl()
AdClient	getClient()
ArrayList<AdCompanion>	getCompanions()
Boolean	getConditionalAdOptOut()
String	getCreativeAdId()
String	getCreativeId()
String	getCreativeType()
String	getDescription()
String	getId()
String	getLinear()
MediaFile	getMediaFile()
Boolean	getMediaFileCompliance()
String	getMetaType()
String[]	getNonComplianceReasons()
String	getOffset()
int	getSequence()
String	getSkipMessage()
int	getSkipOffset()
String	getSkipText()
String	getTag()
String	getUniversalAdIdRegistry()
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 Details

AdMetaEvent

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

Method Details

getClient

@NonNull
public AdClient getClient()

getAdBreakId

@NonNull
public String getAdBreakId()

getAdPlayId

@NonNull
public String getAdPlayId()

getOffset

@NonNull
public String getOffset()

getId

@Nullable
public String getId()

getTag

@Nullable
public String getTag()

getAdPosition

@NonNull
public AdPosition getAdPosition()

getSequence

public int getSequence()

getWItem

public int getWItem()

getWCount

public int getWCount()

getAdSystem

@Nullable
public String getAdSystem()

getSkipOffset

public int getSkipOffset()

getAdSchedule

@Nullable
public AdScheduleFromEvent getAdSchedule()

getAdTitle

@Nullable
public String getAdTitle()

getDescription

@Nullable
public String getDescription()

getAdId

@Nullable
public String getAdId()

getCreativeId

@Nullable
public String getCreativeId()

getCreativeAdId

@Nullable
public String getCreativeAdId()

getConditionalAdOptOut

@Nullable
public Boolean getConditionalAdOptOut()

getVastVersion

public int getVastVersion()

getClickThroughUrl

@Nullable
public String getClickThroughUrl()

getLinear

@Nullable
public String getLinear()

getMediaFileCompliance

@Nullable
public Boolean getMediaFileCompliance()

getNonComplianceReasons

@Nullable
public String[] getNonComplianceReasons()

getMediaFile

@NonNull
public MediaFile getMediaFile()

isViewable

public boolean isViewable()

getCreativeType

@Nullable
public String getCreativeType()

getCategories

@Nullable
public String[] getCategories()

getAdMessage

@Nullable
public String getAdMessage()

getCompanions

@NonNull
public ArrayList<AdCompanion> getCompanions()

getSkipMessage

@Nullable
public String getSkipMessage()

getSkipText

@Nullable
public String getSkipText()

getMetaType

@NonNull
public String getMetaType()

getUniversalAdIdRegistry

@Nullable
public String getUniversalAdIdRegistry()

getUniversalAdIdValue

@Nullable
public String getUniversalAdIdValue()