AdBreakStatus.Builder

  • AdBreakStatus.Builder is a utility class used to construct instances of AdBreakStatus, providing information about the current state of an ad break.

  • It offers methods to set details like the ad break and clip IDs, current positions within the break and clip, and when the ad becomes skippable.

  • Developers can utilize the build() method to create an immutable AdBreakStatus object after setting the desired properties.

  • The builder pattern simplifies the process of creating AdBreakStatus objects by offering a chainable API for setting various attributes.
public static class AdBreakStatus.Builder extends Object

Builder class for AdBreakStatus.

Public Constructor Summary

Builder()

Public Method Summary

AdBreakStatus
build()
Builds an AdBreakStatus.
AdBreakStatus.Builder
setBreakClipId(String breakClipId)
Sets the ID of the current ad break clip.
AdBreakStatus.Builder
setBreakId(String breakId)
Sets the ID of the current ad break.
AdBreakStatus.Builder
setCurrentBreakClipTimeInMs(long currentBreakClipTimeInMs)
Sets the current position of the ad break clip, in milliseconds, from the start of the ad break clip.
AdBreakStatus.Builder
setCurrentBreakTimeInMs(long currentBreakTimeInMs)
Sets the current position of the ad break, in milliseconds, from the start of the ad break.
AdBreakStatus.Builder
setWhenSkippableInMs(long whenSkippableInMs)
Sets the number of milliseconds after the ad break clip starts when the user can skip the ad break clip.

Inherited Method Summary

Public Constructors

public Builder ()

Public Methods

public AdBreakStatus build ()

Builds an AdBreakStatus.

public AdBreakStatus.Builder setBreakClipId (String breakClipId)

Sets the ID of the current ad break clip.

public AdBreakStatus.Builder setBreakId (String breakId)

Sets the ID of the current ad break.

public AdBreakStatus.Builder setCurrentBreakClipTimeInMs (long currentBreakClipTimeInMs)

Sets the current position of the ad break clip, in milliseconds, from the start of the ad break clip.

public AdBreakStatus.Builder setCurrentBreakTimeInMs (long currentBreakTimeInMs)

Sets the current position of the ad break, in milliseconds, from the start of the ad break.

public AdBreakStatus.Builder setWhenSkippableInMs (long whenSkippableInMs)

Sets the number of milliseconds after the ad break clip starts when the user can skip the ad break clip.

If set as AdBreakClipInfo.AD_BREAK_CLIP_NOT_SKIPPABLE, then the ad break cannot be skipped.

The default value is AdBreakClipInfo.AD_BREAK_CLIP_NOT_SKIPPABLE.