Package com.jwplayer.pub.api.events

Class AdRequestEvent

java.lang.Object

com.jwplayer.pub.api.events.Event

com.jwplayer.pub.api.events.AdRequestEvent

public class AdRequestEvent
extends Event

Payload that accompanies the onAdRequest() event.

Constructor Summary

Constructors

Constructor	Description
AdRequestEvent(JWPlayer player, AdPosition adPosition, AdClient client, java.lang.String offset, java.lang.String tag)

Method Summary

Modifier and Type	Method	Description
AdPosition	getAdPosition()
AdClient	getClient()
java.lang.String	getOffset()
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

AdRequestEvent

public AdRequestEvent(@NonNull
                      JWPlayer player,
                      @NonNull
                      AdPosition adPosition,
                      @NonNull
                      AdClient client,
                      @NonNull
                      java.lang.String offset,
                      @NonNull
                      java.lang.String tag)

Method Detail

getAdPosition

@NonNull
public AdPosition getAdPosition()

Returns:

An ad's position.

getClient

@NonNull
public AdClient getClient()

Returns:

The client that is currently being used.

getOffset

@NonNull
public java.lang.String getOffset()

Returns:

An ad's position. Will return a number of a midroll's position.

getTag

@NonNull
public java.lang.String getTag()

Returns:

The URL of the ad tag that is being requested.