Package com.theoplayer.android.api.ads.theoads

Class TheoAdsDescription

  • All Implemented Interfaces:
    @ApiStatus.Experimental() 
public final class TheoAdsDescription
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.

    • 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.

      • getUseId3

         final Boolean getUseId3()

        Whether to use the ID3-based operating mode.

        • Only applicable for specific use-cases.

        • Contact THEO Technologies for more information.

      • isDemo

         final Boolean isDemo()

        Set the integration in "demo mode", where it plays a fixed schedule of interstitials instead of parsing interstitials from the stream.