A class that aggregates information about an ad break clip.
Nested Class Summary
class | AdBreakClipInfo.Builder | A builder for AdBreakClipInfo . |
Constant Summary
long | AD_BREAK_CLIP_NOT_SKIPPABLE | Special constant for
getWhenSkippableInMs() to indicate an ad break clip is not skippable. |
Inherited Constant Summary
Public Method Summary
boolean | |
String |
getClickThroughUrl()
Returns this clip's click through URL.
|
String |
getContentId()
Returns this clip's content ID.
|
String |
getContentUrl()
Returns this clip's content URL.
|
JSONObject |
getCustomData()
Returns this clip's custom data.
|
long |
getDurationInMs()
Returns this clip's duration in milliseconds.
|
String |
getHlsSegmentFormat()
Returns
HlsSegmentFormat
of the ad break clip, or empty String if not set.
|
String |
getId()
Returns this clip's ID.
|
String |
getImageUrl()
Returns this clip's image URL.
|
String |
getMimeType()
Returns this clip's mime type.
|
String |
getTitle()
Returns this clip's title.
|
VastAdsRequest |
getVastAdsRequest()
Returns the
VastAdsRequest
representing the VAST ad request configuration.
|
long |
getWhenSkippableInMs()
Returns the time in milliseconds when this break clip becomes skippable.
|
int |
hashCode()
|
void |
writeToParcel(Parcel out, int
flags)
|
Inherited Method Summary
Constants
public static final long AD_BREAK_CLIP_NOT_SKIPPABLE
Special constant for
getWhenSkippableInMs()
to indicate an ad break clip is not skippable.
Public Methods
public boolean equals (Object other)
public String getClickThroughUrl ()
Returns this clip's click through URL.
public String getContentId ()
Returns this clip's content ID. Typically the URL of the break clip (playing on the receiver).
public String getContentUrl ()
Returns this clip's content URL. If contentUrl is provided, the receiver will use it as the content's URL, otherwise contentId will be used to load the clip on the receiver.
public JSONObject getCustomData ()
Returns this clip's custom data.
public long getDurationInMs ()
Returns this clip's duration in milliseconds.
public String getHlsSegmentFormat ()
Returns HlsSegmentFormat
of the ad break clip, or empty String
if not set.
public String getId ()
Returns this clip's ID.
public String getImageUrl ()
Returns this clip's image URL.
public String getMimeType ()
Returns this clip's mime type.
public String getTitle ()
Returns this clip's title.
public VastAdsRequest getVastAdsRequest ()
Returns the VastAdsRequest
representing the VAST ad request configuration. Used if getContentId()
or getContentUrl()
is not provided. Returns null if not a VAST ad break clip.
When the VAST ad is loaded from the server, the information from the ad will
override all other attributes of the AdBreakClipInfo
,
aside from getId()
.
public long getWhenSkippableInMs ()
Returns the time in milliseconds when this break clip becomes skippable. A value of
5000 means that end user can skip this break clip after 5 seconds. A value of
AD_BREAK_CLIP_NOT_SKIPPABLE
means that current break clip is not
skippable.