THEOplayerAdDescription

All Implemented Interfaces:


public class THEOplayerAdDescription
extends AdDescription

Describes an ad break request.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`THEOplayerAdDescription.Builder`	The builder for the THEOplayerAdDescription.

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`sources`
`private final String`	`skipOffset`
`private final String`	`timeOffset`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`getSources()`	A source which contains the location of ad resources to be scheduled.
`String`	`getSkipOffset()`	The offset after which the ad break can be skipped.
`String`	`getTimeOffset()`	The offset after which the ad break will start.

Methods inherited from class com.theoplayer.android.api.source.addescription.AdDescription
getIntegration
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getSources
```
@NonNull() String getSources()
```
    A source which contains the location of ad resources to be scheduled.
    Only supports VAST and VMAP.
  - getSkipOffset
```
@Nullable() String getSkipOffset()
```
    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 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.
  - getTimeOffset
```
@Nullable() String getTimeOffset()
```
    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.