AdTimeUpdate (player API)

java.lang.Object

com.amazonaws.ivs.player.AdTimeUpdate

public final class AdTimeUpdate extends Object

Represents ad playback progress information.

Beta: This API may change in future releases.

Method Summary

Modifier and Type

Method

Description

String

getAdBreakId()

String

getAssetId()

long

getBreakDuration()

long

getBreakElapsed()

long

getCreativeDuration()

long

getCreativeElapsed()

int

getPodIndex()

int

getPodLength()

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:
  
  unique identifier for the ad break
- getAssetId
  
  @NonNull public String getAssetId()
  
  Returns:
  
  unique identifier for the current creative
- getBreakElapsed
  
  public long getBreakElapsed()
  
  Returns:
  
  elapsed time within the ad break in milliseconds
- getBreakDuration
  
  public long getBreakDuration()
  
  Returns:
  
  total duration of the ad break in milliseconds
- getCreativeElapsed
  
  public long getCreativeElapsed()
  
  Returns:
  
  elapsed time within the current creative in milliseconds
- getCreativeDuration
  
  public long getCreativeDuration()
  
  Returns:
  
  total duration of the current creative in milliseconds
- getPodIndex
  
  public int getPodIndex()
  
  Returns:
  
  1-based index of the current creative within the ad break
- getPodLength
  
  public int getPodLength()
  
  Returns:
  
  total number of creatives in the ad break