Package com.castlabs.sdk.ima

Class ImaAdRequest

java.lang.Object

com.castlabs.sdk.ima.ImaAdRequest

public final class ImaAdRequest
extends Object

IMA request implementation allowing to issue IMA Ad requests.

After ImaPlugin is registered and enabled the request can be issued as following:

  // Starting playback with a Bundle
  Bundle bundle = new Bundle();
  bundle.putParcelable(SdkConsts.INTENT_ADVERTS_DATA, new ImaAdRequest("ima_url").toAdRequest())

  // Starting playback with PlayerConfig
  PlayerConfig config = new PlayerConfig.Builder("content_url")
    .adRequest(new ImaAdRequest("url").toAdRequest())
         .get();

 

Since:

3.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImaAdRequest.Builder	Builder for ImaAdRequest

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_STALL_AD_TIMEOUT_MS	Default timeout to consider the ad playback stalled and switch to the main content playback
static long	SCHEDULE_DELAY_DEFAULT_MS	Default time offset that will be added to the current position when manually scheduling ads
static long	SCHEDULE_DELAY_MAXIMUM_MS	Maximum value for scheduleDelayMs
long	scheduleDelayMs	Time offset that will be added to the current position when manually scheduling ads.
int	stallAdTimeoutMs	Timeout in ms to consider the ad playback stalled and switch to the main content playback
String	tagUrl	Ad tag Url

Constructor Summary

Constructors

Constructor	Description
ImaAdRequest(String tagUrl)	Create Ima Ad request with specified tag Url.
ImaAdRequest(String tagUrl, int stallAdTimeoutMs)	Deprecated. Use ImaAdRequest.Builder instead.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
AdRequest	toAdRequest()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_STALL_AD_TIMEOUT_MS

public static final int DEFAULT_STALL_AD_TIMEOUT_MS

Default timeout to consider the ad playback stalled and switch to the main content playback

See Also:

Constant Field Values

SCHEDULE_DELAY_DEFAULT_MS

public static final long SCHEDULE_DELAY_DEFAULT_MS

Default time offset that will be added to the current position when manually scheduling ads

See Also:

Constant Field Values

SCHEDULE_DELAY_MAXIMUM_MS

public static final long SCHEDULE_DELAY_MAXIMUM_MS

Maximum value for scheduleDelayMs

See Also:

Constant Field Values

tagUrl

@Nullable
public final String tagUrl

Ad tag Url

stallAdTimeoutMs

public final int stallAdTimeoutMs

Timeout in ms to consider the ad playback stalled and switch to the main content playback

scheduleDelayMs

public final long scheduleDelayMs

Time offset that will be added to the current position when manually scheduling ads.

Constructor Detail

ImaAdRequest

public ImaAdRequest(@Nullable
                    String tagUrl)

Create Ima Ad request with specified tag Url.

Parameters:

tagUrl - Ad tag Url

ImaAdRequest

public ImaAdRequest(@Nullable
                    String tagUrl,
                    int stallAdTimeoutMs)

Deprecated.

Use ImaAdRequest.Builder instead.

Create Ima Ad request with specified tag Url.

Parameters:

tagUrl - Ad tag Url

stallAdTimeoutMs - Set to non-zero value to enable workaround for stalled ad playbacks and switch to the main content playback after the specified timeout. Set to -1 to disable the workaround

Method Detail

toAdRequest

@NonNull
public AdRequest toAdRequest()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object