Interface THEOLiveConfig

  • All Implemented Interfaces:

    
    public interface THEOLiveConfig
    
                        

    The THEOLive Configuration API.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public final class THEOLiveConfig.Builder
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract String getExternalSessionId() An id used to report usage analytics.
      abstract Boolean getAnalyticsDisabled() Whether OptiView Live analytics is disabled.
      abstract String getDiscoveryUrl() A discovery URL that is tried before the built-in discovery URLs.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getExternalSessionId

         abstract String getExternalSessionId()

        An id used to report usage analytics.

        If both this field and THEOplayerConfig.cmcd.externalSessionId are set, the value from cmcd.externalSessionId will take precedence. This field will be removed in the next major release.

      • getDiscoveryUrl

         abstract String getDiscoveryUrl()

        A discovery URL that is tried before the built-in discovery URLs. Defaults to null.

        The API version is derived from the URL: a URL that contains /v3/ is V3, a URL that contains /v2/distributions/ is V2, and any other URL is V1.