Class TheoAdDescription
-
- All Implemented Interfaces:
public class TheoAdDescription extends AdDescription
Describes a THEOads SGAI ad break request.
For THEOads, one configured ad break request suffices to enable THEOads ad playback for the entire stream.
-
-
Field Summary
Fields Modifier and Type Field Description private final String
networkCode
private final String
customAssetKey
private final String
backdropDoubleBox
private final String
backdropLShape
private final TheoAdsLayoutOverride
overrideLayout
private final Map<String, String>
adTagParameters
private final Boolean
useId3
-
Constructor Summary
Constructors Constructor Description TheoAdDescription(String networkCode, String customAssetKey, String backdropDoubleBox, String backdropLShape, TheoAdsLayoutOverride overrideLayout, Map<String, String> adTagParameters, Boolean useId3)
-
Method Summary
Modifier and Type Method Description final String
getNetworkCode()
Default network code to use for ad requests. final String
getCustomAssetKey()
Default custom asset key to use for ad requests. final String
getBackdropDoubleBox()
Default backdrop image URI to be used as a background for ads in double box layout. final String
getBackdropLShape()
Default backdrop image URI to be used as a background for ads in L-shape layout. final TheoAdsLayoutOverride
getOverrideLayout()
Override the layout of all THEOads ad breaks, if set. final Map<String, String>
getAdTagParameters()
The ad tag parameters added to the stream request. final Boolean
getUseId3()
Whether to use the ID3-based operating mode. -
-
Method Detail
-
getNetworkCode
final String getNetworkCode()
Default network code to use for ad requests.
This will be overridden by network codes parsed from THEOads ad cues.
If no network code is configured, and it cannot be parsed from the THEOads ad cue, ads will not be loaded.
-
getCustomAssetKey
final String getCustomAssetKey()
Default custom asset key to use for ad requests.
This will be overridden by custom asset keys parsed from THEOads ad cues.
If no custom asset key is configured, and it cannot be parsed from the THEOads ad cue, ads will not be loaded.
-
getBackdropDoubleBox
final String getBackdropDoubleBox()
Default backdrop image URI to be used as a background for ads in double box layout.
This will be overridden by backdrop image URIs parsed from THEOads ad cues.
If no URI is configured, and it cannot be parsed from the THEOads ad cue, a black screen will be shown as background.
-
getBackdropLShape
final String getBackdropLShape()
Default backdrop image URI to be used as a background for ads in L-shape layout.
This will be overridden by backdrop image URIs parsed from THEOads ad cues.
If no URI is configured, and it cannot be parsed from the THEOads ad cue, a black screen will be shown as background.
-
getOverrideLayout
final TheoAdsLayoutOverride getOverrideLayout()
Override the layout of all THEOads ad breaks, if set.
-
getAdTagParameters
final Map<String, String> getAdTagParameters()
The ad tag parameters added to the stream request.
-
-
-
-