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.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

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 String`	`streamActivityMonitorId`
`private final String`	`sseEndpoint`
`private final String`	`retrievePodIdURI`
`private final Boolean`	`useId3`
`private final Boolean`	`useEMSG`
`private final Double`	`initializationDelay`
`private final String`	`daiAssetKey`
`private final AdIntegration`	`integration`

Constructor Summary

Constructors
Constructor	Description
`TheoAdDescription(String networkCode, String customAssetKey, String backdropDoubleBox, String backdropLShape, TheoAdsLayoutOverride overrideLayout, Map<String, String> adTagParameters, String streamActivityMonitorId, String sseEndpoint, String retrievePodIdURI, Boolean useId3, Boolean useEMSG, Double initializationDelay, String daiAssetKey)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

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 String`	`getStreamActivityMonitorId()`	The streamActivityMonitorId added to the GAM Pod stream request.
`final String`	`getSseEndpoint()`	The endpoint from where to retrieve the server-sent events.
`final String`	`getRetrievePodIdURI()`	The URI from where to retrieve the PodID's as returned from the EABN service from Google.
`final Boolean`	`getUseId3()`	Whether to use the ID3-based operating mode.
`final Boolean`	`getUseEMSG()`	Whether to use the EMSG-based operating mode.
`final Double`	`getInitializationDelay()`	The amount of seconds we wait to initialize THEOads.
`final String`	`getDaiAssetKey()`	The Google DAI asset key which will be used as a fallback source when THEOads is not supported.

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
  - TheoAdDescription
```
TheoAdDescription(String networkCode, String customAssetKey, String backdropDoubleBox, String backdropLShape, TheoAdsLayoutOverride overrideLayout, Map<String, String> adTagParameters, String streamActivityMonitorId, String sseEndpoint, String retrievePodIdURI, Boolean useId3, Boolean useEMSG, Double initializationDelay, String daiAssetKey)
```
- 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.
  - getStreamActivityMonitorId
```
 final String getStreamActivityMonitorId()
```
    The streamActivityMonitorId added to the GAM Pod stream request.
  - getSseEndpoint
```
 final String getSseEndpoint()
```
    The endpoint from where to retrieve the server-sent events.
  - getRetrievePodIdURI
```
 final String getRetrievePodIdURI()
```
    The URI from where to retrieve the PodID's as returned from the EABN service from Google.
  - getUseId3
```
 final Boolean getUseId3()
```
    Whether to use the ID3-based operating mode.
    Only applicable for specific use-cases.
    Contact Dolby Optiview for more information.
  - getUseEMSG
```
 final Boolean getUseEMSG()
```
    Whether to use the EMSG-based operating mode.
    Only applicable for specific use-cases.
    Contact Dolby Optiview for more information.
  - getInitializationDelay
```
 final Double getInitializationDelay()
```
    The amount of seconds we wait to initialize THEOads.
  - getDaiAssetKey
```
 final String getDaiAssetKey()
```
    The Google DAI asset key which will be used as a fallback source when THEOads is not supported.

Class TheoAdDescription

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.theoplayer.android.api.source.addescription.AdDescription

Methods inherited from class java.lang.Object

Constructor Detail

TheoAdDescription

Method Detail

getNetworkCode

getCustomAssetKey

getBackdropDoubleBox

getBackdropLShape

getOverrideLayout

getAdTagParameters

getStreamActivityMonitorId

getSseEndpoint

getRetrievePodIdURI

getUseId3

getUseEMSG

getInitializationDelay

getDaiAssetKey