Package com.jwplayer.pub.api.events

Class AdPlayEvent

java.lang.Object

com.jwplayer.pub.api.events.Event

com.jwplayer.pub.api.events.AdPlayEvent

public class AdPlayEvent
extends Event

Payload that accompanies the onAdPlay() event.

Constructor Summary

Constructors

Constructor	Description
AdPlayEvent(JWPlayer player, java.lang.String creativeType, PlayerState newState, PlayerState oldState, java.lang.String tag, AdScheduleFromEvent adScheduleFromEvent, AdPlayReason adPlayReason)

Method Summary

Modifier and Type	Method	Description
AdPlayReason	getAdPlayReason()
AdScheduleFromEvent	getAdSchedule()
java.lang.String	getCreativeType()
PlayerState	getNewState()
PlayerState	getOldState()
java.lang.String	getTag()

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

AdPlayEvent

public AdPlayEvent(@NonNull
                   JWPlayer player,
                   @Nullable
                   java.lang.String creativeType,
                   @NonNull
                   PlayerState newState,
                   @NonNull
                   PlayerState oldState,
                   @NonNull
                   java.lang.String tag,
                   AdScheduleFromEvent adScheduleFromEvent,
                   @NonNull
                   AdPlayReason adPlayReason)

Method Detail

getCreativeType

@Nullable
public java.lang.String getCreativeType()

Returns:

VAST-only The MIME type of the current media file specified in the VAST XML.

getNewState

@NonNull
public PlayerState getNewState()

Returns:

The new state of the player.

getOldState

@NonNull
public PlayerState getOldState()

Returns:

The state of the player prior to ad playback.

getTag

@NonNull
public java.lang.String getTag()

Returns:

The URL of the ad tag that is currently playing.

getAdSchedule

public AdScheduleFromEvent getAdSchedule()

getAdPlayReason

@NonNull
public AdPlayReason getAdPlayReason()

Returns:

The reason adPlay occurs.