Constructor Detail

• THEOplayerAdDescription.Builder

  THEOplayerAdDescription.Builder(String source)

  Creates a builder for THEOplayerAdDescription.

  Parameters:

  source - The source which contains the location of ad resources to be scheduled.

Method Detail

• adDescription

  @Deprecated()@NonNull() static THEOplayerAdDescription.Builder adDescription()

  Creates a builder for THEOplayerAdDescription.

  Deprecated: Superseded by Builder, since v4.0.0.

• adDescription

  @Deprecated()@NonNull() static THEOplayerAdDescription.Builder adDescription(@NonNull() String source)

  Creates a builder for THEOplayerAdDescription.

  Deprecated: Superseded by Builder, since v4.0.0.

  Parameters:

  source - The source which contains the location of ad resources to be scheduled.

• source

  @Deprecated()@NonNull() THEOplayerAdDescription.Builder source(@NonNull() String source)

  Sets the source which contains the location of ad resources to be scheduled.

  Deprecated: Superseded by Builder, since v4.0.0.

  Parameters:

  source - The source which contains the location of ad resources to be scheduled.

• skipOffset

  @NonNull() THEOplayerAdDescription.Builder skipOffset(@NonNull() String skipOffset)

  Sets the offset after which the ad break can be skipped.

  • A timestamp which is not in the playback window will result in the ad break being skipped.
  • VMAP resources will ignore this value as they contain an internal offset.

  Possible formats:

  • A number for the offset in seconds.
  • 'start' for a preroll.
  • 'end' for a postroll.
  • 'HH:MM:SS.mm' for a timestamp in the playback window.
  • A percentage string (XX%) for a proportion of the content duration.

  Parameters:

  skipOffset - The offset after which the ad break can be skipped.

• timeOffset

  @NonNull() THEOplayerAdDescription.Builder timeOffset(@NonNull() String timeOffset)

  Sets the offset after which the ad break will start.

  • A timestamp which is not in the playback window will result in the ad break not being started.
  • VMAP resources will ignore this value as they contain an internal offset.

  Possible formats:

  • A number for the offset in seconds.
  • 'start' for a preroll.
  • 'end' for a postroll.
  • 'HH:MM:SS.mm' for a timestamp in the playback window.
  • A percentage string (XX%) for a proportion of the content duration.

  Parameters:

  timeOffset - The offset after which the ad break will start.

• build

  @NonNull() THEOplayerAdDescription build()

  Builds THEOplayerAdDescription.