public class THEOplayerAdDescription extends AdDescription
Modifier and Type | Class and Description |
---|---|
static class |
THEOplayerAdDescription.Builder
The builder for the THEOplayerAdDescription.
|
Constructor and Description |
---|
THEOplayerAdDescription(String sources)
Creates a THEOplayerAdDescription.
|
THEOplayerAdDescription(String sources,
String skipOffset,
String timeOffset)
Creates a THEOplayerAdDescription.
|
Modifier and Type | Method and Description |
---|---|
String |
getSkipOffset()
The offset after which the ad break can be skipped.
|
String |
getSources()
A source which contains the location of ad resources to be scheduled.
|
String |
getTimeOffset()
The offset after which the ad break will start.
|
getIntegration
public THEOplayerAdDescription(String sources)
sources
- The URI which contains the location of the ad resources to be scheduled. (NonNull)- Only supports VAST and VMAP.
public THEOplayerAdDescription(String sources, String skipOffset, String timeOffset)
sources
- The URI which contains the location of ad resources to be scheduled. (NonNull)skipOffset
- The offset after which the ad break can be skipped. (see THEOplayerAdDescription.Builder.skipOffset(String)
for formatting) (Nullable)timeOffset
- The offset after which the ad break will start. (see THEOplayerAdDescription.Builder.timeOffset(String)
for formatting) (Nullable)- Only supports VAST and VMAP.
public String getSources()
- Only supports VAST and VMAP.
public String getSkipOffset()
- 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.
public String getTimeOffset()
- 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.