Package com.amazonaws.ivs.player

Class AdBreak

java.lang.Object

com.amazonaws.ivs.player.AdBreak

public final class AdBreak
extends Object

Represents an ad break.

Beta: This API may change in future releases.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AdBreak.RollType	Type of ad break.

Method Summary

Modifier and Type	Method	Description
String	getAdBreakId()	Returns the unique identifier for this ad break.
long	getDuration()	Returns the duration of the ad break in milliseconds.
AdBreakMetadata	getMetadata()	Returns the optional metadata that provides additional context about the ad break.
int	getPodLength()	Returns the number of creatives in this ad break.
AdBreak.RollType	getRollType()	Returns the roll type of the ad break.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getAdBreakId

@NonNull
public String getAdBreakId()

Returns the unique identifier for this ad break.

getRollType

@NonNull
public AdBreak.RollType getRollType()

Returns the roll type of the ad break.

getDuration

public long getDuration()

Returns the duration of the ad break in milliseconds.

getPodLength

public int getPodLength()

Returns the number of creatives in this ad break.

getMetadata

@NonNull
public AdBreakMetadata getMetadata()

Returns the optional metadata that provides additional context about the ad break.