Interface THEOplayerConfig
-
- All Implemented Interfaces:
public interface THEOplayerConfigThe THEOplayer Configuration API.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classTHEOplayerConfig.BuilderThe builder for THEOplayerConfig.
-
Method Summary
Modifier and Type Method Description BooleanuseSystemCaptionStyle()Whether captions should automatically apply a system-defined style. abstract BooleanisMultiSession()Returns whether the player supports multi-key content when the license server doesn't respond with all keys at once. abstract StringgetLicense()The license. abstract StringgetLicenseUrl()The licenseUrl. abstract PipConfigurationgetPip()The Picture in Picture configuration of the player. PipConfigurationgetPipConfiguration()abstract NetworkConfigurationgetNetwork()The network and retry configuration of the player. NetworkConfigurationgetNetworkConfiguration()abstract THEOLiveConfiggetTheoLive()The THEOlive configuration of the player. THEOLiveConfiggetTHEOLiveConfiguration()abstract BooleanisAutoIntegrations()Whether all available integrations should be automatically added on the created Player. abstract BooleanisTunnelingEnabled()Whether multimedia tunneling is enabled for the player or not. abstract BooleangetUseSystemCaptionStyle()Whether captions should automatically apply a system-defined style. abstract CMCDConfigurationgetCmcd()The CMCD configuration for the player. abstract BooleangetHlsDateRange()Whether date ranges will be parsed from HLS manifests. BooleanisHlsDateRange()-
-
Method Detail
-
useSystemCaptionStyle
@Deprecated(message = "use useSystemCaptionStyle instead", replaceWith = @ReplaceWith(imports = {}, expression = "useSystemCaptionStyle")) Boolean useSystemCaptionStyle()
Whether captions should automatically apply a system-defined style.
Default:
falseAny user-defined overrides are still respected.
-
isMultiSession
@Deprecated(message = "use DRMConfiguration.multiSession instead") abstract Boolean isMultiSession()
Returns whether the player supports multi-key content when the license server doesn't respond with all keys at once.
Set to
falsewhen a single key request will obtain all keys required to decrypt the stream.Set to
truewhen a different key request is needed for different qualities of the stream, or when the stream uses key rotation.
Default: false
-
getLicense
abstract String getLicense()
The license.
- Returns:
Returns the license. (Nullable)
-
getLicenseUrl
abstract String getLicenseUrl()
The licenseUrl.
- Returns:
Returns the licenseUrl. (Nullable)
-
getPip
abstract PipConfiguration getPip()
The Picture in Picture configuration of the player.
- Returns:
The PiP configuration. (Nullable)
-
getPipConfiguration
@Deprecated(message = "use pip instead", replaceWith = @ReplaceWith(imports = {}, expression = "pip")) PipConfiguration getPipConfiguration()
-
getNetwork
abstract NetworkConfiguration getNetwork()
The network and retry configuration of the player.
- Returns:
The network and retry configuration. (Nullable)
-
getNetworkConfiguration
@Deprecated(message = "use network instead", replaceWith = @ReplaceWith(imports = {}, expression = "network")) NetworkConfiguration getNetworkConfiguration()
-
getTheoLive
abstract THEOLiveConfig getTheoLive()
The THEOlive configuration of the player.
- Returns:
The THEOlive configuration.
-
getTHEOLiveConfiguration
@Deprecated(message = "use theoLive instead", replaceWith = @ReplaceWith(imports = {}, expression = "theoLive")) THEOLiveConfig getTHEOLiveConfiguration()
-
isAutoIntegrations
abstract Boolean isAutoIntegrations()
Whether all available integrations should be automatically added on the created Player.
- Returns:
True if integrations should be automatically added.
-
isTunnelingEnabled
abstract Boolean isTunnelingEnabled()
Whether multimedia tunneling is enabled for the player or not.
Only supported with the Media3 integration.
Only supported if Player.setRenderingTarget is set to RenderingTarget.SURFACE_VIEW.
Only supported if the media being played includes both audio and video.
Only supported on limited number of video codecs and devices.
- Returns:
True if multimedia tunneling is enabled.
-
getUseSystemCaptionStyle
abstract Boolean getUseSystemCaptionStyle()
Whether captions should automatically apply a system-defined style.
Default:
falseAny user-defined overrides are still respected.
-
getCmcd
abstract CMCDConfiguration getCmcd()
The CMCD configuration for the player.
-
getHlsDateRange
abstract Boolean getHlsDateRange()
Whether date ranges will be parsed from HLS manifests.
Default:
falseCan be overridden per source using com.theoplayer.android.api.source.TypedSource.hlsDateRange.
- Returns:
Whether date range parsing is enabled.
-
isHlsDateRange
Boolean isHlsDateRange()
-
-
-
-