static IntegrationType
valueOf(String name)
+ valueOf(String name)
static IntegrationType valueOf(String name)+
static IntegrationType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
final THEOplayerConfig.Builder
multiSession(Boolean multiSession)
+ multiSession(Boolean multiSession)
final THEOplayerConfig.Builder
license(String license)
+ license(String license)
final THEOplayerConfig.Builder
licenseUrl(String licenseUrl)
+ licenseUrl(String licenseUrl)
final THEOplayerConfig.Builder
integrationConfiguration(IntegrationType integrationType, Object configuration)
+ integrationConfiguration(IntegrationType integrationType, Object configuration)
final THEOplayerConfig.Builder
autoIntegrations(Boolean autoIntegrations)
+ autoIntegrations(Boolean autoIntegrations)
final THEOplayerConfig.Builder
tunnelingEnabled(Boolean tunnelingEnabled)
+ tunnelingEnabled(Boolean tunnelingEnabled)
final THEOplayerConfig.Builder
useSystemCaptionStyle(Boolean useSystemCaptionStyle)
+ useSystemCaptionStyle(Boolean useSystemCaptionStyle)
final THEOplayerConfig.Builder
hlsDateRange(Boolean hlsDateRange)
+ hlsDateRange(Boolean hlsDateRange)
@Deprecated(message = "use {@link DRMConfiguration.Builder#multiSession(boolean)}") final THEOplayerConfig.Builder multiSession(Boolean multiSession)+
@Deprecated(message = "use {@link DRMConfiguration.Builder#multiSession(boolean)}") final THEOplayerConfig.Builder multiSession(Boolean multiSession)
Sets whether the player supports multi-key content when the license server doesn't respond with all keys at once.
Default: false
final THEOplayerConfig.Builder license(String license)+
final THEOplayerConfig.Builder license(String license)
Sets the license to string loaded before the player is constructed.
final THEOplayerConfig.Builder licenseUrl(String licenseUrl)+
final THEOplayerConfig.Builder licenseUrl(String licenseUrl)
Sets licenseUrl to string loaded before the player is constructed.
@ApiStatus.Internal() final THEOplayerConfig.Builder integrationConfiguration(IntegrationType integrationType, Object configuration)+
@ApiStatus.Internal() final THEOplayerConfig.Builder integrationConfiguration(IntegrationType integrationType, Object configuration)
final THEOplayerConfig.Builder autoIntegrations(Boolean autoIntegrations)+
final THEOplayerConfig.Builder autoIntegrations(Boolean autoIntegrations)
Sets whether all available integrations should be automatically added.
Default: true
final THEOplayerConfig.Builder tunnelingEnabled(Boolean tunnelingEnabled)+
final THEOplayerConfig.Builder tunnelingEnabled(Boolean tunnelingEnabled)
Whether multimedia tunneling is enabled for the player or not.
Default: false
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.
final THEOplayerConfig.Builder useSystemCaptionStyle(Boolean useSystemCaptionStyle)+
final THEOplayerConfig.Builder useSystemCaptionStyle(Boolean useSystemCaptionStyle)
Sets whether captions should automatically apply a system-defined style.
Default: false
Any user-defined overrides are still respected.
final THEOplayerConfig.Builder hlsDateRange(Boolean hlsDateRange)+
final THEOplayerConfig.Builder hlsDateRange(Boolean hlsDateRange)
Sets whether date ranges should be parsed from HLS manifests.
Default: false
Can be overridden per source using com.theoplayer.android.api.source.TypedSource.Builder.hlsDateRange.
Boolean
+ Boolean
useSystemCaptionStyle()
abstract Boolean
+ abstract Boolean
isMultiSession()
abstract String
+ abstract String
getLicense()
abstract String
+ abstract String
getLicenseUrl()
abstract Boolean
+ abstract Boolean
isAutoIntegrations()
abstract Boolean
+ abstract Boolean
isTunnelingEnabled()
abstract Boolean
+ abstract Boolean
getUseSystemCaptionStyle()
abstract Boolean
+ abstract Boolean
getHlsDateRange()
Boolean
+ Boolean
isHlsDateRange()
@Deprecated(message = "use useSystemCaptionStyle instead", replaceWith = @ReplaceWith(imports = {}, expression = "useSystemCaptionStyle")) Boolean useSystemCaptionStyle()+
@Deprecated(message = "use useSystemCaptionStyle instead", replaceWith = @ReplaceWith(imports = {}, expression = "useSystemCaptionStyle")) Boolean useSystemCaptionStyle()
Whether captions should automatically apply a system-defined style.
Default: false
Any user-defined overrides are still respected.
@Deprecated(message = "use DRMConfiguration.multiSession instead") abstract Boolean 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 false when a single key request will obtain all keys required to decrypt the stream.
Set to true when a different key request is needed for different qualities of the stream, or when the stream uses key rotation.
Default: false
abstract String getLicense()+
abstract String getLicense()
The license.
abstract String getLicenseUrl()+
abstract String getLicenseUrl()
The licenseUrl.
abstract Boolean isAutoIntegrations()+
abstract Boolean isAutoIntegrations()
Whether all available integrations should be automatically added on the created Player.
abstract Boolean 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.
abstract Boolean getUseSystemCaptionStyle()+
abstract Boolean getUseSystemCaptionStyle()
Whether captions should automatically apply a system-defined style.
Default: false
Any user-defined overrides are still respected.
abstract Boolean getHlsDateRange()+
abstract Boolean getHlsDateRange()
Whether date ranges will be parsed from HLS manifests.
Default: false
Can be overridden per source using com.theoplayer.android.api.source.TypedSource.hlsDateRange.
Boolean isHlsDateRange()+
Boolean isHlsDateRange()
public class THEOplayerDestroyedException -extends RuntimeException +extends RuntimeException
The THEOplayerDestroyedException is thrown when trying to use a method of a THEOplayerView on which the onDestroy was called.
abstract void
registerContentProtectionIntegration(@NonNull() String integrationId, @NonNull() KeySystemId keySystemId, @NonNull() ContentProtectionIntegrationFactory integrationFactory)
+ registerContentProtectionIntegration(@NonNull() String integrationId, @NonNull() KeySystemId keySystemId, @NonNull() ContentProtectionIntegrationFactory integrationFactory)
static String
+ static String
getVersion()
abstract void registerContentProtectionIntegration(@NonNull() String integrationId, @NonNull() KeySystemId keySystemId, @NonNull() ContentProtectionIntegrationFactory integrationFactory)+
abstract void registerContentProtectionIntegration(@NonNull() String integrationId, @NonNull() KeySystemId keySystemId, @NonNull() ContentProtectionIntegrationFactory integrationFactory)
Register a ContentProtectionIntegrationFactory for a specific integration id and a specific keySystem.
static String getVersion()+
static String getVersion()
The THEOplayer version used.
Example:
public final static Stringpublic final static StringTHEOPLAYERVIEW_TAGpublic final static Property<View, Float>public final static Property<View, Float>ALPHApublic final static Stringpublic final static StringAUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATEpublic final static Stringpublic final static StringAUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAYpublic final static Stringpublic final static StringAUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTHpublic final static Stringpublic final static StringAUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEARpublic final static Stringpublic final static StringAUTOFILL_HINT_CREDIT_CARD_NUMBERpublic final static Stringpublic final static StringAUTOFILL_HINT_CREDIT_CARD_SECURITY_CODEpublic final static Stringpublic final static StringAUTOFILL_HINT_EMAIL_ADDRESSpublic final static Stringpublic final static StringAUTOFILL_HINT_NAMEpublic final static Stringpublic final static StringAUTOFILL_HINT_PASSWORDpublic final static Stringpublic final static StringAUTOFILL_HINT_PHONEpublic final static Stringpublic final static StringAUTOFILL_HINT_POSTAL_ADDRESSpublic final static Stringpublic final static StringAUTOFILL_HINT_POSTAL_CODEpublic final static Stringpublic final static StringAUTOFILL_HINT_USERNAMEpublic final static Property<View, Float>public final static Property<View, Float>ROTATIONpublic final static Property<View, Float>public final static Property<View, Float>ROTATION_Xpublic final static Property<View, Float>public final static Property<View, Float>ROTATION_Ypublic final static Property<View, Float>public final static Property<View, Float>SCALE_Xpublic final static Property<View, Float>public final static Property<View, Float>SCALE_Ypublic final static Property<View, Float>public final static Property<View, Float>TRANSLATION_Xpublic final static Property<View, Float>public final static Property<View, Float>TRANSLATION_Ypublic final static Property<View, Float>public final static Property<View, Float>TRANSLATION_Zprotected final static Stringprotected final static StringVIEW_LOG_TAGpublic final static Property<View, Float>public final static Property<View, Float>Xpublic final static Property<View, Float>public final static Property<View, Float>Ypublic final static Property<View, Float>public final static Property<View, Float>ZString
+ String
getVersion()
String getVersion()+
String getVersion()
final AbrStrategyMetadata.Builder
setBitrate(Integer bitrate)
+ setBitrate(Integer bitrate)
final AbrStrategyMetadata.Builder setBitrate(Integer bitrate)+
final AbrStrategyMetadata.Builder setBitrate(Integer bitrate)
Sets the initial bitrate.
private final Integerprivate final IntegerbitrateAbrStrategyMetadata(Integer bitrate)final Integer
+ final Integer
getBitrate()
AbrStrategyMetadata(Integer bitrate)+
AbrStrategyMetadata(Integer bitrate)
final Integer getBitrate()+
final Integer getBitrate()
The initial bitrate, in bits per second. (Nullable)
static AbrStrategyType
valueOf(String name)
+ valueOf(String name)
static AbrStrategyType valueOf(String name)+
static AbrStrategyType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
abstract String
+ abstract String
getId()
abstract List<CompanionAd>
+ abstract List<CompanionAd>
getCompanions()
abstract String
+ abstract String
getType()
abstract String
+ abstract String
getCustomIntegration()
Object
+ Object
getCustomData()
@NonNull() abstract String getId()+
@NonNull() abstract String getId()
The identifier of the creative, provided in the VAST-file.
Default: Empty string.
@NonNull() abstract List<CompanionAd> getCompanions()+
@NonNull() abstract List<CompanionAd> getCompanions()
The List of CompanionAds associated to the ad, if available within the same Creatives element.
@Nullable() abstract String getType()+
@Nullable() abstract String getType()
The type of the Ad.
@Nullable() abstract String getCustomIntegration()+
@Nullable() abstract String getCustomIntegration()
The type of custom ad integration.
@Nullable() Object getCustomData()+
@Nullable() Object getCustomData()
The additional integration-specific data associated with this ad.
abstract List<Ad>
+ abstract List<Ad>
getAds()
abstract String
+ abstract String
getCustomIntegration()
abstract String
+ abstract String
getId()
String
+ String
getIdAsString()
Object
+ Object
getCustomData()
@NonNull() abstract List<Ad> getAds()+
@NonNull() abstract List<Ad> getAds()
The list of all the ads which will be played sequentially at the ad break's time offset.
@Nullable() abstract String getCustomIntegration()+
@Nullable() abstract String getCustomIntegration()
The type of custom ad integration.
@Nullable() abstract String getId()+
@Nullable() abstract String getId()
The identifier of the ad break.
null. @Nullable() String getIdAsString()+
@Nullable() String getIdAsString()
The identifier of the ad break.
This is identical to getId.
@Nullable() Object getCustomData()+
@Nullable() Object getCustomData()
The additional integration-specific data associated with this ad break.
private final Integerprivate final IntegertimeOffsetprivate final Stringprivate final Stringidprivate final Integerprivate final IntegermaxDurationprivate Objectprivate ObjectcustomDataAdBreakInit(Integer timeOffset, String id, Integer maxDuration, Object customData)AdBreakInit(Integer timeOffset, String id, Integer maxDuration)AdBreakInit(Integer timeOffset, String id)AdBreakInit(Integer timeOffset)final Integer
+ final Integer
getTimeOffset()
final String
+ final String
getId()
final Integer
+ final Integer
getMaxDuration()
final Object
+ final Object
getCustomData()
final Unit
setCustomData(Object customData)
+ setCustomData(Object customData)
AdBreakInit(Integer timeOffset, String id, Integer maxDuration, Object customData)+
AdBreakInit(Integer timeOffset, String id, Integer maxDuration, Object customData)
AdBreakInit(Integer timeOffset, String id, Integer maxDuration)+
AdBreakInit(Integer timeOffset, String id, Integer maxDuration)
AdBreakInit(Integer timeOffset, String id)+
AdBreakInit(Integer timeOffset, String id)
AdBreakInit(Integer timeOffset)+
AdBreakInit(Integer timeOffset)
final Integer getTimeOffset()+
final Integer getTimeOffset()
The time offset at which content will be paused to play the ad break, in seconds.
Required when used in ServerSideAdIntegrationController.createAdBreak.
Ignored when used in ServerSideAdIntegrationController.updateAdBreak.
final String getId()+
final String getId()
The identifier of the ad break.
final Integer getMaxDuration()+
final Integer getMaxDuration()
The duration of the ad break, in seconds.
final Object getCustomData()+
final Object getCustomData()
Additional integration-specific data associated with this ad break.
final Unit setCustomData(Object customData)+
final Unit setCustomData(Object customData)
Additional integration-specific data associated with this ad break.
private Stringprivate Stringtypeprivate Integerprivate IntegertimeOffsetprivate Integerprivate IntegerskipOffsetprivate Stringprivate Stringidprivate Integerprivate Integerdurationprivate Stringprivate StringclickThroughprivate Stringprivate StringresourceURIprivate List<MediaFile>private List<MediaFile>mediaFilesprivate Objectprivate ObjectcustomDataAdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI, List<MediaFile> mediaFiles, Object customData)AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI, List<MediaFile> mediaFiles)AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI)AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough)AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration)AdInit(String type, Integer timeOffset, Integer skipOffset, String id)AdInit(String type, Integer timeOffset, Integer skipOffset)AdInit(String type, Integer timeOffset)AdInit(String type)final String
+ final String
getType()
final Unit
setType(String type)
+ setType(String type)
final Integer
+ final Integer
getTimeOffset()
final Unit
setTimeOffset(Integer timeOffset)
+ setTimeOffset(Integer timeOffset)
final Integer
+ final Integer
getSkipOffset()
final Unit
setSkipOffset(Integer skipOffset)
+ setSkipOffset(Integer skipOffset)
final String
+ final String
getId()
final Unit
setId(String id)
+ setId(String id)
final Integer
+ final Integer
getDuration()
final Unit
setDuration(Integer duration)
+ setDuration(Integer duration)
final String
+ final String
getClickThrough()
final Unit
setClickThrough(String clickThrough)
+ setClickThrough(String clickThrough)
final String
+ final String
getResourceURI()
final Unit
setResourceURI(String resourceURI)
+ setResourceURI(String resourceURI)
final List<MediaFile>
+ final List<MediaFile>
getMediaFiles()
final Unit
setMediaFiles(List<MediaFile> mediaFiles)
+ setMediaFiles(List<MediaFile> mediaFiles)
final Object
+ final Object
getCustomData()
final Unit
setCustomData(Object customData)
+ setCustomData(Object customData)
AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI, List<MediaFile> mediaFiles, Object customData)+
AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI, List<MediaFile> mediaFiles, Object customData)
AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI, List<MediaFile> mediaFiles)+
AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI, List<MediaFile> mediaFiles)
AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI)+
AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI)
AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough)+
AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough)
AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration)+
AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration)
AdInit(String type, Integer timeOffset, Integer skipOffset, String id)+
AdInit(String type, Integer timeOffset, Integer skipOffset, String id)
AdInit(String type, Integer timeOffset, Integer skipOffset)+
AdInit(String type, Integer timeOffset, Integer skipOffset)
AdInit(String type, Integer timeOffset)+
AdInit(String type, Integer timeOffset)
AdInit(String type)+
AdInit(String type)
final String getType()+
final String getType()
The type of the ad.
Can be either 'linear' or 'nonlinear'.
final Unit setType(String type)+
final Unit setType(String type)
The type of the ad.
Can be either 'linear' or 'nonlinear'.
final Integer getTimeOffset()+
final Integer getTimeOffset()
The time offset at which content will be paused to play the ad, in seconds.
Optional when used in ServerSideAdIntegrationController.createAd with an existing AdBreak.
final Unit setTimeOffset(Integer timeOffset)+
final Unit setTimeOffset(Integer timeOffset)
The time offset at which content will be paused to play the ad, in seconds.
Optional when used in ServerSideAdIntegrationController.createAd with an existing AdBreak.
final Integer getSkipOffset()+
final Integer getSkipOffset()
The number of seconds after which the ad can be skipped, in seconds.
final Unit setSkipOffset(Integer skipOffset)+
final Unit setSkipOffset(Integer skipOffset)
The number of seconds after which the ad can be skipped, in seconds.
final String getId()+
final String getId()
The identifier of the ad.
final Unit setId(String id)+
final Unit setId(String id)
The identifier of the ad.
final Integer getDuration()+
final Integer getDuration()
The duration of the ad, in seconds.
Only applicable to linear ads.
final Unit setDuration(Integer duration)+
final Unit setDuration(Integer duration)
The duration of the ad, in seconds.
Only applicable to linear ads.
final String getClickThrough()+
final String getClickThrough()
The website of the advertiser.
final Unit setClickThrough(String clickThrough)+
final Unit setClickThrough(String clickThrough)
The website of the advertiser.
final String getResourceURI()+
final String getResourceURI()
The URI of the the ad content.
final Unit setResourceURI(String resourceURI)+
final Unit setResourceURI(String resourceURI)
The URI of the the ad content.
final List<MediaFile> getMediaFiles()+
final List<MediaFile> getMediaFiles()
The list of media files which contain metadata about ad video files.
Only applicable to linear ads.
final Unit setMediaFiles(List<MediaFile> mediaFiles)+
final Unit setMediaFiles(List<MediaFile> mediaFiles)
The list of media files which contain metadata about ad video files.
Only applicable to linear ads.
final Object getCustomData()+
final Object getCustomData()
Additional integration-specific data associated with this ad.
final Unit setCustomData(Object customData)+
final Unit setCustomData(Object customData)
Additional integration-specific data associated with this ad.
abstract List<Ad>
+ abstract List<Ad>
getCurrentAds()
abstract List<Ad>
+ abstract List<Ad>
getScheduledAds()
abstract void
registerServerSideIntegration(@NonNull() String integrationId, @NonNull() ServerSideAdIntegrationFactory integrationFactory)
+ registerServerSideIntegration(@NonNull() String integrationId, @NonNull() ServerSideAdIntegrationFactory integrationFactory)
@MainThread()@NonNull() abstract List<Ad> getCurrentAds()+
@MainThread()@NonNull() abstract List<Ad> getCurrentAds()
Returns a list of the currently active Ad (linear and/or non linear).
@MainThread()@NonNull() abstract List<Ad> getScheduledAds()+
@MainThread()@NonNull() abstract List<Ad> getScheduledAds()
Returns a list of Ads that still needs to be played.
abstract void registerServerSideIntegration(@NonNull() String integrationId, @NonNull() ServerSideAdIntegrationFactory integrationFactory)+
abstract void registerServerSideIntegration(@NonNull() String integrationId, @NonNull() ServerSideAdIntegrationFactory integrationFactory)
Register a custom advertisement integration.
This allows you to integrate with third-party advertisement providers, and have them report their ads and ad-related events through the THEOplayer Ads API.
abstract String
+ abstract String
getAdSlotId()
abstract String
+ abstract String
getAltText()
abstract String
+ abstract String
getClickThrough()
abstract String
+ abstract String
getResourceURI()
abstract String
+ abstract String
getType()
@NonNull() abstract String getAdSlotId()+
@NonNull() abstract String getAdSlotId()
An identifier of the element in which the companion ad should be appended, if available.
Default: Empty String.
@NonNull() abstract String getAltText()+
@NonNull() abstract String getAltText()
An alternative description for ad.
@NonNull() abstract String getClickThrough()+
@NonNull() abstract String getClickThrough()
The website of the advertisement.
@NonNull() abstract String getResourceURI()+
@NonNull() abstract String getResourceURI()
The URI of the ad content.
@NonNull() abstract String getType()+
@NonNull() abstract String getType()
The type of the companion ad.
abstract List<MediaFile>
+ abstract List<MediaFile>
getMediaFiles()
@NonNull() abstract List<MediaFile> getMediaFiles()+
@NonNull() abstract List<MediaFile> getMediaFiles()
The list of media files which contain metadata about ad video files.
final <Error class: unknown class>
resourceURI(String resourceURI)
+ resourceURI(String resourceURI)
final <Error class: unknown class>
type(String type)
+ type(String type)
final <Error class: unknown class>
delivery(String delivery)
+ delivery(String delivery)
final <Error class: unknown class>
width(Integer width)
+ width(Integer width)
final <Error class: unknown class>
height(Integer height)
+ height(Integer height)
final <Error class: unknown class> resourceURI(String resourceURI)+
final <Error class: unknown class> resourceURI(String resourceURI)
Sets the URI of the VAST content.
final <Error class: unknown class> type(String type)+
final <Error class: unknown class> type(String type)
Sets the MIME type for the file container.
final <Error class: unknown class> delivery(String delivery)+
final <Error class: unknown class> delivery(String delivery)
Sets the delivery type.
final <Error class: unknown class> width(Integer width)+
final <Error class: unknown class> width(Integer width)
Sets the native width of the video file, in pixels.
final <Error class: unknown class> height(Integer height)+
final <Error class: unknown class> height(Integer height)
Sets the native height of the video file, in pixels.
abstract String
+ abstract String
getDelivery()
abstract String
+ abstract String
getResourceURI()
abstract String
+ abstract String
getType()
abstract Integer
+ abstract Integer
getHeight()
abstract Integer
+ abstract Integer
getWidth()
abstract String getDelivery()+
abstract String getDelivery()
The delivery type.
Currently we only support progressive.
It should be either 'progressive' or 'streaming'.
Default: Empty string.
abstract String getResourceURI()+
abstract String getResourceURI()
The URI of the VAST content.
Default: Empty string.
abstract String getType()+
abstract String getType()
The MIME type for the file container.
Default: Empty string.
abstract Integer getHeight()+
abstract Integer getHeight()
The native height of the video file, in pixels.
abstract Integer getWidth()+
abstract Integer getWidth()
The native width of the video file, in pixels.
abstract String
+ abstract String
getClickThrough()
abstract String
+ abstract String
getResourceURI()
@NonNull() abstract String getClickThrough()+
@NonNull() abstract String getClickThrough()
The website of the advertiser.
Default: Empty string.
@NonNull() abstract String getResourceURI()+
@NonNull() abstract String getResourceURI()
The URI of the the ad content.
Default: Empty string.
OmidFriendlyObstruction(View view, OmidFriendlyObstructionPurpose purpose, String reason)String
+ String
getReasonString()
OmidFriendlyObstruction(View view, OmidFriendlyObstructionPurpose purpose, String reason)+
OmidFriendlyObstruction(View view, OmidFriendlyObstructionPurpose purpose, String reason)
@Nullable() String getReasonString()+
@Nullable() String getReasonString()
The reason for the friendly obstruction.
static OmidFriendlyObstructionPurpose
valueOf(String name)
+ valueOf(String name)
static OmidFriendlyObstructionPurpose valueOf(String name)+
static OmidFriendlyObstructionPurpose valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
abstract Unit
updateAdProgress(Ad ad, Double progress)
+ updateAdProgress(Ad ad, Double progress)
abstract Unit
error(Throwable error)
+ error(Throwable error)
abstract Unit
fatalError(Throwable error, ErrorCode code)
+ fatalError(Throwable error, ErrorCode code)
abstract String
+ abstract String
getIntegration()
abstract List<Ad>
+ abstract List<Ad>
getAds()
abstract List<AdBreak>
+ abstract List<AdBreak>
getAdBreaks()
abstract Unit updateAdProgress(Ad ad, Double progress)+
abstract Unit updateAdProgress(Ad ad, Double progress)
Update the playback progression of the given ad.
The player will fire progression events such as AdFirstQuartileEvent, AdMidpointEvent and AdThirdQuartileEvent.
abstract Unit error(Throwable error)+
abstract Unit error(Throwable error)
Fire an AdErrorEvent on the player.
This does not stop playback.
abstract Unit fatalError(Throwable error, ErrorCode code)+
abstract Unit fatalError(Throwable error, ErrorCode code)
Fire a fatal ErrorEvent on the player.
This stops playback immediately. Use Player.setSource to load a new source.
abstract String getIntegration()+
abstract String getIntegration()
The identifier for this integration, as it was passed to Ads.registerServerSideIntegration.
abstract List<Ad> getAds()+
abstract List<Ad> getAds()
abstract List<AdBreak> getAdBreaks()+
abstract List<AdBreak> getAdBreaks()
The scheduled ad breaks managed by this integration.
Use createAdBreak and removeAdBreak to add or remove ad breaks.
abstract String
+ abstract String
getUniversalAdIdRegistry()
abstract String
+ abstract String
getUniversalAdIdValue()
@NonNull() abstract String getUniversalAdIdRegistry()+
@NonNull() abstract String getUniversalAdIdRegistry()
The registry associated with cataloging the UniversalAdId of the selected creative for the ad.
@NonNull() abstract String getUniversalAdIdValue()+
@NonNull() abstract String getUniversalAdIdValue()
The Universal Ad identifier of the selected creative for the ad.
abstract Double
+ abstract Double
contentTimeForStreamTime(Double streamTime)
+ contentTimeForStreamTime(Double streamTime)
abstract Double
+ abstract Double
streamTimeForContentTime(Double contentTime)
+ streamTimeForContentTime(Double contentTime)
abstract List<CuePoint>
+ abstract List<CuePoint>
getCuePoints()
abstract Boolean
+ abstract Boolean
getEnableSnapback()
abstract Unit
setEnableSnapback(Boolean enableSnapback)
+ setEnableSnapback(Boolean enableSnapback)
abstract Double contentTimeForStreamTime(Double streamTime)+
abstract Double contentTimeForStreamTime(Double streamTime)
Returns the content time without ads for a given stream time. Returns the given stream time for live streams.
If the time entered is 15 seconds, after a pre-roll of 10 seconds, it will return 5 seconds.
Used to determine part of content, starting from total stream time.
abstract Double streamTimeForContentTime(Double contentTime)+
abstract Double streamTimeForContentTime(Double contentTime)
Returns the stream time with ads for a given content time. Returns the given content time for live streams.
If the time entered is 5 seconds, after a pre-roll of 10 seconds, it will return 15 seconds.
Used to determine total stream time, starting from content time only.
abstract List<CuePoint> getCuePoints()+
abstract List<CuePoint> getCuePoints()
Returns a list of CuePoint where ads will be played.
abstract Boolean getEnableSnapback()+
abstract Boolean getEnableSnapback()
Whether snapback is enabled. When enabled and the user seeks over multiple ad breaks, the last ad break that was seeked past will be played, if it has not been played yet.
abstract Unit setEnableSnapback(Boolean enableSnapback)+
abstract Unit setEnableSnapback(Boolean enableSnapback)
Whether snapback is enabled. When enabled and the user seeks over multiple ad breaks, the last ad break that was seeked past will be played, if it has not been played yet.
abstract String
+ abstract String
getAdSystem()
abstract String
+ abstract String
getCreativeId()
abstract List<String>
+ abstract List<String>
getWrapperAdIds()
abstract List<String>
+ abstract List<String>
getWrapperAdSystems()
abstract List<String>
+ abstract List<String>
getWrapperCreativeIds()
abstract Integer
+ abstract Integer
getVastMediaBitrate()
abstract List<UniversalAdId>
+ abstract List<UniversalAdId>
getUniversalAdIds()
abstract String
+ abstract String
getTraffickingParameters()
abstract String getAdSystem()+
abstract String getAdSystem()
The source ad server information included in the ad response.
abstract String getCreativeId()+
abstract String getCreativeId()
The identifier of the selected creative for the ad.
abstract List<String> getWrapperAdIds()+
abstract List<String> getWrapperAdIds()
The list of wrapper ad identifiers as specified in the VAST response.
abstract List<String> getWrapperAdSystems()+
abstract List<String> getWrapperAdSystems()
The list of wrapper ad systems as specified in the VAST response.
abstract List<String> getWrapperCreativeIds()+
abstract List<String> getWrapperCreativeIds()
The list of wrapper creative identifiers.
Starts with the first wrapper ad.
abstract Integer getVastMediaBitrate()+
abstract Integer getVastMediaBitrate()
The bitrate of the currently playing creative as listed in the VAST response.
abstract List<UniversalAdId> getUniversalAdIds()+
abstract List<UniversalAdId> getUniversalAdIds()
The list of universal ad ID information of the selected creative for the ad.
abstract String getTraffickingParameters()+
abstract String getTraffickingParameters()
A string with custom parameters associated with the ad at the time of ad trafficking.
Empty string if this information is not available.
abstract Map<String, String>
+ abstract Map<String, String>
getAdData()
abstract Map<String, String> getAdData()+
abstract Map<String, String> getAdData()
A Map<String, String> containing any extra ad data for the event, if needed.
The event types of GoogleImaAdEvent.
private final Stringprivate final Stringnameprivate final Integerprivate final IntegerordinalString
+ String
getName()
final GoogleImaAdEventType
valueOf(String value)
+ valueOf(String value)
String getName()+
String getName()
Function to get the name (textual representation) of an IMA related event.
final GoogleImaAdEventType valueOf(String value)+
final GoogleImaAdEventType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
abstract Double
+ abstract Double
getDuration()
abstract Integer
+ abstract Integer
getStartTime()
abstract List<MediaTailorTrackingEvent>
+ abstract List<MediaTailorTrackingEvent>
getTrackingEvents()
abstract Double getDuration()+
abstract Double getDuration()
The duration of the MediaTailor ad.
abstract Integer getStartTime()+
abstract Integer getStartTime()
The start time of the MediaTailor ad.
abstract List<MediaTailorTrackingEvent> getTrackingEvents()+
abstract List<MediaTailorTrackingEvent> getTrackingEvents()
The list of MediaTailorTrackingEvents for this particular ad.
abstract String
+ abstract String
getId()
abstract Double
+ abstract Double
getDuration()
abstract Integer
+ abstract Integer
getStartTime()
abstract String getId()+
abstract String getId()
The unique identifier of this MediaTailor adBreak.
abstract Double getDuration()+
abstract Double getDuration()
The duration of the MediaTailor adBreak.
abstract Integer getStartTime()+
abstract Integer getStartTime()
The start time of the MediaTailor adBreak.
public enum MediaTailorAdBreakEventType -extends Enum<MediaTailorAdBreakEventType> implements EventType<MediaTailorAdBreakEvent> +extends Enum<MediaTailorAdBreakEventType> implements EventType<MediaTailorAdBreakEvent>@@ -186,13 +186,13 @@
private final Stringprivate final Stringnameprivate final Integerprivate final IntegerordinalString
+ String
getName()
final MediaTailorAdBreakEventType
valueOf(String value)
+ valueOf(String value)
String getName()+
String getName()
Function to get the name (textual representation) of a MediaTailor adbreak related event.
final MediaTailorAdBreakEventType valueOf(String value)+
final MediaTailorAdBreakEventType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
public enum MediaTailorAdEventType -extends Enum<MediaTailorAdEventType> implements EventType<MediaTailorAdEvent> +extends Enum<MediaTailorAdEventType> implements EventType<MediaTailorAdEvent>@@ -186,13 +186,13 @@
private final Stringprivate final Stringnameprivate final Integerprivate final IntegerordinalString
+ String
getName()
final MediaTailorAdEventType
valueOf(String value)
+ valueOf(String value)
String getName()+
String getName()
Function to get the name (textual representation) of a MediaTailor ad related event.
final MediaTailorAdEventType valueOf(String value)+
final MediaTailorAdEventType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
abstract String
+ abstract String
getBackdropUri()
abstract List<Ad>
+ abstract List<Ad>
getAds()
abstract String getBackdropUri()+
abstract String getBackdropUri()
abstract List<Ad> getAds()+
abstract List<Ad> getAds()
abstract String
+ abstract String
getId()
abstract Double
+ abstract Double
getStartTime()
abstract Double
+ abstract Double
getDuration()
abstract Map<String, String>
+ abstract Map<String, String>
getAdTagParameters()
abstract Unit
setAdTagParameters(Map<String, String> adTagParameters)
+ setAdTagParameters(Map<String, String> adTagParameters)
abstract String getId()+
abstract String getId()
abstract Double getStartTime()+
abstract Double getStartTime()
abstract Double getDuration()+
abstract Double getDuration()
abstract Map<String, String> getAdTagParameters()+
abstract Map<String, String> getAdTagParameters()
The ad tag parameters that are used for this specific ad break.
abstract Unit setAdTagParameters(Map<String, String> adTagParameters)+
abstract Unit setAdTagParameters(Map<String, String> adTagParameters)
The ad tag parameters that are used for this specific ad break.
public enum InterstitialType -extends Enum<InterstitialType> +extends Enum<InterstitialType>
The type of the interstitial.
private final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal InterstitialType
valueOf(String value)
+ valueOf(String value)
final InterstitialType valueOf(String value)+
final InterstitialType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
abstract String
+ abstract String
getImageUrl()
abstract String
+ abstract String
getClickThrough()
abstract String getImageUrl()+
abstract String getImageUrl()
abstract String getClickThrough()+
abstract String getClickThrough()
private final Doubleprivate final Doubleleftprivate final Doubleprivate final Doublerightprivate final Doubleprivate final Doubletopprivate final Doubleprivate final DoublebottomOverlayPosition(Double left, Double right, Double top, Double bottom)final Double
+ final Double
getLeft()
final Double
+ final Double
getRight()
final Double
+ final Double
getTop()
final Double
+ final Double
getBottom()
OverlayPosition(Double left, Double right, Double top, Double bottom)+
OverlayPosition(Double left, Double right, Double top, Double bottom)
final Double getLeft()+
final Double getLeft()
final Double getRight()+
final Double getRight()
final Double getTop()+
final Double getTop()
final Double getBottom()+
final Double getBottom()
private final Doubleprivate final Doublewidthprivate final Doubleprivate final DoubleheightOverlaySize(Double width, Double height)final Double
+ final Double
getWidth()
final Double
+ final Double
getHeight()
OverlaySize(Double width, Double height)+
OverlaySize(Double width, Double height)
final Double getWidth()+
final Double getWidth()
final Double getHeight()+
final Double getHeight()
private final Stringprivate final StringcreativeIdprivate final Stringprivate final StringadSystemTHEOAd(String id, THEOAdBreak adBreak, Double duration, List<CompanionAd> companionAds, String creativeId, String adSystem)final String
+ final String
getCreativeId()
final String
+ final String
getAdSystem()
String
+ String
getId()
List<CompanionAd>
+ List<CompanionAd>
getCompanions()
String
+ String
getType()
Integer
+ Integer
getSkipOffset()
String
+ String
getCustomIntegration()
Object
+ Object
getCustomData()
Double
+ Double
getDurationAsDouble()
Integer
+ Integer
getDuration()
List<MediaFile>
+ List<MediaFile>
getMediaFiles()
THEOAd(String id, THEOAdBreak adBreak, Double duration, List<CompanionAd> companionAds, String creativeId, String adSystem)+
THEOAd(String id, THEOAdBreak adBreak, Double duration, List<CompanionAd> companionAds, String creativeId, String adSystem)
final String getCreativeId()+
final String getCreativeId()
The identifier of the selected creative for the ad.
final String getAdSystem()+
final String getAdSystem()
The source ad server information included in the ad response.
String getId()+
String getId()
List<CompanionAd> getCompanions()+
List<CompanionAd> getCompanions()
String getType()+
String getType()
Integer getSkipOffset()+
Integer getSkipOffset()
String getCustomIntegration()+
String getCustomIntegration()
Object getCustomData()+
Object getCustomData()
Double getDurationAsDouble()+
Double getDurationAsDouble()
Integer getDuration()+
Integer getDuration()
List<MediaFile> getMediaFiles()+
List<MediaFile> getMediaFiles()
THEOAdBreak(String id, Integer timeOffset, Integer duration)List<Ad>
+ List<Ad>
getAds()
Integer
+ Integer
getMaxDuration()
Double
+ Double
getMaxRemainingDuration()
Integer
+ Integer
getTimeOffset()
String
+ String
getCustomIntegration()
String
+ String
getId()
Object
+ Object
getCustomData()
THEOAdBreak(String id, Integer timeOffset, Integer duration)+
THEOAdBreak(String id, Integer timeOffset, Integer duration)
List<Ad> getAds()+
List<Ad> getAds()
Integer getMaxDuration()+
Integer getMaxDuration()
Double getMaxRemainingDuration()+
Double getMaxRemainingDuration()
Integer getTimeOffset()+
Integer getTimeOffset()
String getCustomIntegration()+
String getCustomIntegration()
String getId()+
String getId()
Object getCustomData()+
Object getCustomData()
private final Stringprivate final StringnetworkCodeprivate final Stringprivate final StringcustomAssetKeyprivate final Stringprivate final StringbackdropDoubleBoxprivate final Stringprivate final StringbackdropLShapeprivate final Map<String, String>private final Map<String, String>adTagParametersprivate final Stringprivate final StringstreamActivityMonitorIdprivate final Stringprivate final StringsseEndpointprivate final Stringprivate final StringretrievePodIdURIprivate final Booleanprivate final BooleanuseId3private final Booleanprivate final BooleanuseEMSGprivate final Doubleprivate final DoubleinitializationDelayprivate final Stringprivate final StringdaiAssetKeyprivate final Stringprivate final StringbreakManifestUrlTheoAdDescription(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, String breakManifestUrl)final String
+ final String
getNetworkCode()
final String
+ final String
getCustomAssetKey()
final String
+ final String
getBackdropDoubleBox()
final String
+ final String
getBackdropLShape()
final Map<String, String>
+ final Map<String, String>
getAdTagParameters()
final String
+ final String
getStreamActivityMonitorId()
final String
+ final String
getSseEndpoint()
final String
+ final String
getRetrievePodIdURI()
final Boolean
+ final Boolean
getUseId3()
final Boolean
+ final Boolean
getUseEMSG()
final Double
+ final Double
getInitializationDelay()
final String
+ final String
getDaiAssetKey()
final String
+ final String
getBreakManifestUrl()
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, String breakManifestUrl)+
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, String breakManifestUrl)
final String 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.
final String 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.
final String 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.
final String 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.
final Map<String, String> getAdTagParameters()+
final Map<String, String> getAdTagParameters()
The ad tag parameters added to the stream request.
final String getStreamActivityMonitorId()+
final String getStreamActivityMonitorId()
The streamActivityMonitorId added to the GAM Pod stream request.
final String getSseEndpoint()+
final String getSseEndpoint()
The endpoint from where to retrieve the server-sent events.
final String getRetrievePodIdURI()+
final String getRetrievePodIdURI()
The URI from where to retrieve the PodID's as returned from the EABN service from Google.
final Boolean getUseId3()+
final Boolean getUseId3()
Whether to use the ID3-based operating mode.
Only applicable for specific use-cases.
Contact Dolby Optiview for more information.
final Boolean getUseEMSG()+
final Boolean getUseEMSG()
Whether to use the EMSG-based operating mode.
Only applicable for specific use-cases.
Contact Dolby Optiview for more information.
final Double getInitializationDelay()+
final Double getInitializationDelay()
The amount of seconds we wait to initialize THEOads.
final String getDaiAssetKey()+
final String getDaiAssetKey()
The Google DAI asset key which will be used as a fallback source when THEOads is not supported.
final String getBreakManifestUrl()+
final String getBreakManifestUrl()
URL of a Break Manifest from which ad breaks are scheduled.
abstract Unit
replaceAdTagParameters(Map<String, String> adTagParameters)
+ replaceAdTagParameters(Map<String, String> adTagParameters)
abstract List<Interstitial>
+ abstract List<Interstitial>
getCurrentInterstitials()
abstract List<Interstitial>
+ abstract List<Interstitial>
getScheduledInterstitials()
abstract Unit replaceAdTagParameters(Map<String, String> adTagParameters)+
abstract Unit replaceAdTagParameters(Map<String, String> adTagParameters)
Replaces all of the ad tag parameters used for upcoming ad requests for a live stream.
If set, this value overrides any parameters set on the TheoAdDescription.adTagParameters.
abstract List<Interstitial> getCurrentInterstitials()+
abstract List<Interstitial> getCurrentInterstitials()
The currently playing interstitials.
abstract List<Interstitial> getScheduledInterstitials()+
abstract List<Interstitial> getScheduledInterstitials()
List of interstitials which still need to be played.
public enum TheoAdsLayout -extends Enum<TheoAdsLayout> +extends Enum<TheoAdsLayout>
The layout of the THEOad.
private final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal TheoAdsLayout
valueOf(String value)
+ valueOf(String value)
final TheoAdsLayout valueOf(String value)+
final TheoAdsLayout valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
public enum TheoAdsLayoutOverride -extends Enum<TheoAdsLayoutOverride> +extends Enum<TheoAdsLayoutOverride>
Override config for the THEOads ad layout.
private final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal TheoAdsLayoutOverride
valueOf(String value)
+ valueOf(String value)
final TheoAdsLayoutOverride valueOf(String value)+
final TheoAdsLayoutOverride valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
abstract String
+ abstract String
getMessage()
abstract String getMessage()+
abstract String getMessage()
An optional message describing the error that occurred.
public final static Stringpublic final static StringADD_INTERSTITIALpublic final static Stringpublic final static StringINTERSTITIAL_BEGINpublic final static Stringpublic final static StringINTERSTITIAL_ENDpublic final static Stringpublic final static StringINTERSTITIAL_ERRORpublic final static Stringpublic final static StringINTERSTITIAL_UPDATEpublic final static Stringpublic final static StringFALLBACKNotificationCompat.Builder
createSummaryNotificationBuilder(Integer size, NotificationCompat.Builder builder)
+ createSummaryNotificationBuilder(Integer size, NotificationCompat.Builder builder)
NotificationCompat.Builder createSummaryNotificationBuilder(Integer size, NotificationCompat.Builder builder)+
NotificationCompat.Builder createSummaryNotificationBuilder(Integer size, NotificationCompat.Builder builder)
Creates a custom summary notification builder.
static CacheStatus
valueOf(String name)
+ valueOf(String name)
static CacheStatus valueOf(String name)+
static CacheStatus valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
public enum CacheStorageType -extends Enum<CacheStorageType> +extends Enum<CacheStorageType>
The types of cache storage supported by THEOplayer.
As of version 10.0, only CacheStorageType.MEDIA3 is supported.
private final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal CacheStorageType
valueOf(String value)
+ valueOf(String value)
final CacheStorageType valueOf(String value)+
final CacheStorageType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
CachingParameters.Builder
amount(@Nullable() String amount)
+ amount(@Nullable() String amount)
CachingParameters.Builder
expirationDate(@Nullable() Date expirationDate)
+ expirationDate(@Nullable() Date expirationDate)
CachingParameters.Builder
bandwidth(@Nullable() Long bandwidth)
+ bandwidth(@Nullable() Long bandwidth)
CachingParameters.Builder amount(@Nullable() String amount)+
CachingParameters.Builder amount(@Nullable() String amount)
Sets the amount of data to cache for the given stream. Will be ignored for progressive media caching. Possible formats:
Default: "100%"
CachingParameters.Builder expirationDate(@Nullable() Date expirationDate)+
CachingParameters.Builder expirationDate(@Nullable() Date expirationDate)
Sets the expiration date of the cached data.
Default: 30 minutes after starting the caching task.
CachingParameters.Builder bandwidth(@Nullable() Long bandwidth)-
Sets the upper bandwidth limit of the quality to cache.
CachingParameters.Builder bandwidth(@Nullable() Long bandwidth)+
Sets the upper bandwidth limit of the quality to cache.
bandwidth - The bandwidth between one and MAX_VALUE or null.bandwidth - The bandwidth between one and MAX_VALUE or null.public final Stringpublic final Stringamountpublic final Datepublic final DateexpirationDatepublic final Longpublic final LongbandwidthString
+ String
getAmount()
Date
+ Date
getExpirationDate()
Long
+ Long
getBandwidth()
@NonNull() String getAmount()+
@NonNull() String getAmount()
The amount of data to cache for the given stream.
Possible formats:
Default: "100%"
@NonNull() Date getExpirationDate()+
@NonNull() Date getExpirationDate()
The expiration date of the cached data.
Default: 30 minutes after starting the caching task.
@NonNull() Long getBandwidth()-
The upper bandwidth limit of the quality to cache.
Default: MAX_VALUE
@NonNull() Long getBandwidth()+
The upper bandwidth limit of the quality to cache.
Default: MAX_VALUE
CachingPreferredTrackSelection.Builder
audioTrackSelection(@Nullable() Array<String> audioTrackSelection)
+ audioTrackSelection(@Nullable() Array<String> audioTrackSelection)
CachingPreferredTrackSelection.Builder
textTrackSelection(@Nullable() Array<String> textTrackSelection)
+ textTrackSelection(@Nullable() Array<String> textTrackSelection)
CachingPreferredTrackSelection.Builder audioTrackSelection(@Nullable() Array<String> audioTrackSelection)+
CachingPreferredTrackSelection.Builder audioTrackSelection(@Nullable() Array<String> audioTrackSelection)
The list of language tags that indicates the preferred audio tracks to be cached.
Default: An empty String[].
CachingPreferredTrackSelection.Builder textTrackSelection(@Nullable() Array<String> textTrackSelection)+
CachingPreferredTrackSelection.Builder textTrackSelection(@Nullable() Array<String> textTrackSelection)
The list of language tags that indicates the preferred text tracks to be cached.
Default: An empty String[].
public final Array<String>public final Array<String>audioTrackSelectionpublic final Array<String>public final Array<String>textTrackSelectionArray<String>
+ Array<String>
getAudioTrackSelection()
Array<String>
+ Array<String>
getTextTrackSelection()
String
+ String
toString()
@NonNull() Array<String> getAudioTrackSelection()+
@NonNull() Array<String> getAudioTrackSelection()
The list of language tags that indicates the preferred audio tracks to be cached.
Default: An empty String[].
@NonNull() Array<String> getTextTrackSelection()+
@NonNull() Array<String> getTextTrackSelection()
The list of language tags that indicates the preferred text tracks to be cached.
Default: An empty String[].
@NonNull() String toString()+
@NonNull() String toString()
abstract String
+ abstract String
getId()
abstract Integer
+ abstract Integer
getStatusNotificationId()
abstract Integer
+ abstract Integer
getProgressNotificationId()
@NonNull() abstract String getId()+
@NonNull() abstract String getId()
The identifier of the task. (NonNull)
@Nullable() abstract Integer getStatusNotificationId()+
@Nullable() abstract Integer getStatusNotificationId()
The notification identifier of the task when showing its status notification.
@Nullable() abstract Integer getProgressNotificationId()+
@Nullable() abstract Integer getProgressNotificationId()
The notification identifier of the task when showing its progress notification.
public final class CachingTaskError -extends Exception +extends Exception
The caching task error.
private final Stringprivate final Stringdescriptionprivate final Throwableprivate final Throwablecauseprivate final Stringprivate final StringmessageCachingTaskError(ErrorCode errorCode, String description, Throwable cause)CachingTaskError(ErrorCode errorCode, String description)final String
+ final String
getDescription()
CachingTaskError(ErrorCode errorCode, String description, Throwable cause)+
CachingTaskError(ErrorCode errorCode, String description, Throwable cause)
CachingTaskError(ErrorCode errorCode, String description)+
CachingTaskError(ErrorCode errorCode, String description)
final String getDescription()+
final String getDescription()
The description of the caching task error. (NonNull)
abstract CachingTask
getTaskById(String id)
+ getTaskById(String id)
@Nullable() abstract CachingTask getTaskById(String id)+
@Nullable() abstract CachingTask getTaskById(String id)
The CachingTask with the specified id, if available.
static CachingTaskStatus
valueOf(String name)
+ valueOf(String name)
static CachingTaskStatus valueOf(String name)+
static CachingTaskStatus valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
abstract Boolean
+ abstract Boolean
isCasting()
abstract String
+ abstract String
getReceiverName()
abstract Boolean isCasting()+
abstract Boolean isCasting()
Returns whether THEOplayer is casting to a Chromecast.
abstract String getReceiverName()+
abstract String getReceiverName()
The name of the Chromecast device that the player is casting to, if any.
static CastStrategy
valueOf(String name)
+ valueOf(String name)
static CastStrategy valueOf(String name)+
static CastStrategy valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
public final Stringpublic final StringdescriptionCastError(ErrorCode errorCode, String description)String
+ String
getDescription()
String
+ String
toString()
CastError(ErrorCode errorCode, String description)+
CastError(ErrorCode errorCode, String description)
@NonNull() String getDescription()+
@NonNull() String getDescription()
The description of the cast error.
@NonNull() String toString()+
@NonNull() String toString()
abstract String
+ abstract String
getReceiverName()
@MainThread()@Nullable() abstract String getReceiverName()+
@MainThread()@Nullable() abstract String getReceiverName()
The name of the Chromecast device that the player is casting to, if any.
public static Stringpublic static StringDEFAULT_APP_IDList<SessionProvider>
+ List<SessionProvider>
getAdditionalSessionProviders(Context context)
List<SessionProvider> getAdditionalSessionProviders(Context context)+
List<SessionProvider> getAdditionalSessionProviders(Context context)
static ErrorCode
valueOf(String name)
+ valueOf(String name)
static ErrorCode valueOf(String name)+
static ErrorCode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
static PlayerCastState
valueOf(String name)
+ valueOf(String name)
static PlayerCastState valueOf(String name)+
static PlayerCastState valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
private final Stringprivate final StringexternalSessionIdprivate final Stringprivate final StringuserIdprivate final List<CMCDEndpointConfiguration>private final List<CMCDEndpointConfiguration>eventEndpointsCMCDConfiguration(String externalSessionId, String userId, Boolean requestMode, List<CMCDEndpointConfiguration> eventEndpoints)final String
+ final String
getExternalSessionId()
final String
+ final String
getUserId()
final List<CMCDEndpointConfiguration>
+ final List<CMCDEndpointConfiguration>
getEventEndpoints()
CMCDConfiguration(String externalSessionId, String userId, Boolean requestMode, List<CMCDEndpointConfiguration> eventEndpoints)+
CMCDConfiguration(String externalSessionId, String userId, Boolean requestMode, List<CMCDEndpointConfiguration> eventEndpoints)
final String getExternalSessionId()+
final String getExternalSessionId()
An external session ID that can be used to identify the current playback session.
final String getUserId()+
final String getUserId()
A user ID that can be used to identify the user.
final List<CMCDEndpointConfiguration> getEventEndpoints()+
final List<CMCDEndpointConfiguration> getEventEndpoints()
A list of CMCD endpoints to which events should be sent.
private final Stringprivate final StringurlCMCDEndpointConfiguration(String url)final String
+ final String
getUrl()
CMCDEndpointConfiguration(String url)+
CMCDEndpointConfiguration(String url)
final String getUrl()+
final String getUrl()
The URL of the CMCD endpoint.
private final Stringprivate final StringsessionIdprivate final Stringprivate final StringexternalSessionIdprivate final Stringprivate final StringuserIdprivate final List<CMCDEndpointConfiguration>private final List<CMCDEndpointConfiguration>eventEndpointsCMCDSourceConfiguration(String sessionId, String externalSessionId, String userId, Boolean requestMode, List<CMCDEndpointConfiguration> eventEndpoints)final String
+ final String
getSessionId()
final String
+ final String
getExternalSessionId()
final String
+ final String
getUserId()
final List<CMCDEndpointConfiguration>
+ final List<CMCDEndpointConfiguration>
getEventEndpoints()
CMCDSourceConfiguration(String sessionId, String externalSessionId, String userId, Boolean requestMode, List<CMCDEndpointConfiguration> eventEndpoints)+
CMCDSourceConfiguration(String sessionId, String externalSessionId, String userId, Boolean requestMode, List<CMCDEndpointConfiguration> eventEndpoints)
final String getSessionId()+
final String getSessionId()
A GUID identifying the current playback session.
A playback session typically consists of the playback of a single media asset along with accompanying content such as advertisements. The maximum length is 64 characters. It is RECOMMENDED to conform to the UUID specification (https://tools.ietf.org/html/rfc4122).
If null, a fresh UUID is generated each time this configuration is applied to the player.
final String getExternalSessionId()+
final String getExternalSessionId()
An external session ID that can be used to identify the current playback session.
Overrides the player-level CMCDConfiguration.externalSessionId when non-null.
final String getUserId()+
final String getUserId()
A user ID that can be used to identify the user.
Overrides the player-level CMCDConfiguration.userId when non-null.
final List<CMCDEndpointConfiguration> getEventEndpoints()+
final List<CMCDEndpointConfiguration> getEventEndpoints()
A list of CMCD endpoints to which events should be sent.
Merged with the player-level CMCDConfiguration.eventEndpoints.
static CMCDTransmissionMode
valueOf(String name)
+ valueOf(String name)
static CMCDTransmissionMode valueOf(String name)+
static CMCDTransmissionMode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
abstract void
error(Throwable exception)
+ error(Throwable exception)
abstract void error(Throwable exception)+
abstract void error(Throwable exception)
static KeySystemId
valueOf(String name)
+ valueOf(String name)
static KeySystemId valueOf(String name)+
static KeySystemId valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
abstract void
error(Throwable exception)
+ error(Throwable exception)
abstract void error(Throwable exception)+
abstract void error(Throwable exception)
public Stringpublic Stringurlpublic Map<String, String>public Map<String, String>headersRequest(String url)String
+ String
getUrl()
void
setUrl(@NonNull() String url)
+ setUrl(@NonNull() String url)
Map<String, String>
+ Map<String, String>
getHeaders()
void
setHeaders(@NonNull() Map<String, String> headers)
+ setHeaders(@NonNull() Map<String, String> headers)
Request(String url)+
Request(String url)
@NonNull() String getUrl()+
@NonNull() String getUrl()
The URL of the license or certificate server. By default, this will equal the license / certificate URL configured in the KeySystemConfiguration.
void setUrl(@NonNull() String url)+
void setUrl(@NonNull() String url)
Sets the URL of the license or certificate server
@NonNull() Map<String, String> getHeaders()+
@NonNull() Map<String, String> getHeaders()
The HTTP request headers to be sent to the server.
void setHeaders(@NonNull() Map<String, String> headers)+
void setHeaders(@NonNull() Map<String, String> headers)
Sets the HTTP request headers to be sent to the server.
static RequestMethod
valueOf(String name)
+ valueOf(String name)
static RequestMethod valueOf(String name)+
static RequestMethod valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
abstract String
+ abstract String
getUrl()
abstract String
+ abstract String
getStatusText()
abstract Map<String, String>
+ abstract Map<String, String>
getHeaders()
@NonNull() abstract String getUrl()+
@NonNull() abstract String getUrl()
The URL from which the response was returned. This might have been redirected transparently.
@NonNull() abstract String getStatusText()+
@NonNull() abstract String getStatusText()
The status text as returned in the HTTP response.
@NonNull() abstract Map<String, String> getHeaders()+
@NonNull() abstract Map<String, String> getHeaders()
The HTTP headers as returned by the server.
private final Stringprivate final Stringurlprivate final Integerprivate final Integerstatusprivate final Stringprivate final StringstatusTextprivate final Stringprivate final Stringresponseprivate final Integerprivate final IntegersystemCodeprivate final Throwableprivate final Throwablecauseprivate final Stringprivate final StringmessageContentProtectionException(ErrorCode code, String message, String url, Integer status, String statusText, String response, Integer systemCode)ContentProtectionException(ErrorCode code, String message, Throwable cause, String url, Integer status, String statusText, String response, Integer systemCode)final String
+ final String
getUrl()
final Integer
+ final Integer
getStatus()
final String
+ final String
getStatusText()
final String
+ final String
getResponse()
final Integer
+ final Integer
getSystemCode()
ContentProtectionException(ErrorCode code, String message, String url, Integer status, String statusText, String response, Integer systemCode)+
ContentProtectionException(ErrorCode code, String message, String url, Integer status, String statusText, String response, Integer systemCode)
ContentProtectionException(ErrorCode code, String message, Throwable cause, String url, Integer status, String statusText, String response, Integer systemCode)+
ContentProtectionException(ErrorCode code, String message, Throwable cause, String url, Integer status, String statusText, String response, Integer systemCode)
final String getUrl()+
final String getUrl()
The URL that was used in the request.
Only available when code is ErrorCode.CONTENT_PROTECTION_CERTIFICATE_ERROR or ErrorCode.CONTENT_PROTECTION_LICENSE_ERROR.
final Integer getStatus()+
final Integer getStatus()
The status code from the HTTP response.
Only available when code is ErrorCode.CONTENT_PROTECTION_CERTIFICATE_ERROR or ErrorCode.CONTENT_PROTECTION_LICENSE_ERROR.
final String getStatusText()+
final String getStatusText()
A textual description regarding the status from the HTTP response.
Only available when code is ErrorCode.CONTENT_PROTECTION_CERTIFICATE_ERROR or ErrorCode.CONTENT_PROTECTION_LICENSE_ERROR.
final String getResponse()+
final String getResponse()
A textual representation of the body of the HTTP response.
Only available when code is ErrorCode.CONTENT_PROTECTION_CERTIFICATE_ERROR or ErrorCode.CONTENT_PROTECTION_LICENSE_ERROR.
final Integer getSystemCode()+
final Integer getSystemCode()
The internal error code from the CDM.
Only available when code is ErrorCode.CONTENT_PROTECTION_INTERNAL_ERROR.
static ErrorCategory
valueOf(String name)
+ valueOf(String name)
static ErrorCategory valueOf(String name)+
static ErrorCategory valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
static ErrorCode
valueOf(String name)
+ valueOf(String name)
static ErrorCode valueOf(String name)+
static ErrorCode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
A THEOplayer exception that gives an informative description of the error that occurred.
private final Throwableprivate final Throwablecauseprivate final Stringprivate final StringmessageTHEOplayerException(ErrorCode code, String message, Throwable cause)THEOplayerException(ErrorCode code, String message)THEOplayerException(ErrorCode code, String message, Throwable cause)+
THEOplayerException(ErrorCode code, String message, Throwable cause)
THEOplayerException(ErrorCode code, String message)+
THEOplayerException(ErrorCode code, String message)
-public interface Event<E extends Event<out Object>> +public interface Event<E extends Event<out Object>>
The base Event.
abstract Date
+ abstract Date
getDate()
@NonNull() abstract Date getDate()+
@NonNull() abstract Date getDate()
The Date when the event occurred.
-public interface EventDispatcher<E extends Event<out Object>> +public interface EventDispatcher<E extends Event<out Object>>
The Event Dispatcher.
-public interface EventListener<E extends Event<out Object>> +public interface EventListener<E extends Event<out Object>>
The Event Listener.
abstract String
+ abstract String
getName()
abstract String getName()+
abstract String getName()
The name of this EventType.
abstract String
+ abstract String
getError()
@Nullable() abstract String getError()+
@Nullable() abstract String getError()
The error message of the given AdErrorEvent.
public final Stringpublic final Stringtypestatic AdIntegrationKind
from(@Nullable() String type)
+ from(@Nullable() String type)
String
+ String
toString()
static AdIntegrationKind
valueOf(String name)
+ valueOf(String name)
String
+ String
getType()
@Nullable() static AdIntegrationKind from(@Nullable() String type)+
@Nullable() static AdIntegrationKind from(@Nullable() String type)
Converts a textual representation of the integration to an actual AdIntegrationKind instance.
@NonNull() String toString()+
@NonNull() String toString()
static AdIntegrationKind valueOf(String name)+
static AdIntegrationKind valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
@NonNull() String getType()-
The kind of the integration.
@NonNull() String getType()+
The kind of the integration.
public final static Stringpublic final static StringAD_BEGINpublic final static Stringpublic final static StringAD_ENDpublic final static Stringpublic final static StringAD_SKIPpublic final static Stringpublic final static StringAD_ERRORpublic final static Stringpublic final static StringAD_BREAK_BEGINpublic final static Stringpublic final static StringAD_BREAK_ENDpublic final static Stringpublic final static StringAD_LOADEDpublic final static Stringpublic final static StringAD_IMPRESSIONpublic final static Stringpublic final static StringAD_FIRST_QUARTILEpublic final static Stringpublic final static StringAD_THIRD_QUARTILEpublic final static Stringpublic final static StringAD_MIDPOINTpublic final static Stringpublic final static StringADD_ADpublic final static Stringpublic final static StringADD_AD_BREAKpublic final static Stringpublic final static StringAD_BREAK_CHANGEpublic final static Stringpublic final static StringREMOVE_AD_BREAKpublic final static Stringpublic final static StringAD_TAPPEDpublic final static Stringpublic final static StringAD_CLICKEDpublic final Stringpublic final StringnameCacheEventTypes(String name)String
+ String
getName()
CacheEventTypes(String name)+
CacheEventTypes(String name)
String getName()+
String getName()
The name of this EventType.
public final Stringpublic final StringnameString
+ String
getName()
String getName()+
String getName()
The name of this EventType.
public final Stringpublic final StringnameString
+ String
getName()
String getName()+
String getName()
The name of this EventType.
-public interface ChromecastEvent<E extends Event<out Object>> +public interface ChromecastEvent<E extends Event<out Object>> implements Event<E>
The Chromecast Event.
abstract String
+ abstract String
getMediaTrackType()
@NonNull() abstract String getMediaTrackType()+
@NonNull() abstract String getMediaTrackType()
The textual representation of the media-track type.
abstract Double
+ abstract Double
getDuration()
@NonNull() abstract Double getDuration()+
@NonNull() abstract Double getDuration()
The new duration of the content.
abstract String
+ abstract String
getInitData()
abstract String
+ abstract String
getInitDataType()
@NonNull() abstract String getInitData()+
@NonNull() abstract String getInitData()
Get a textual representation of the data that was encrypted.
@NonNull() abstract String getInitDataType()+
@NonNull() abstract String getInitDataType()
Get a textual representation of the type of data that was encrypted.
public final static Stringpublic final static StringPLAYpublic final static Stringpublic final static StringPAUSEpublic final static Stringpublic final static StringRATECHANGEpublic final static Stringpublic final static StringVOLUMECHANGEpublic final static Stringpublic final static StringPROGRESSpublic final static Stringpublic final static StringDURATIONCHANGEpublic final static Stringpublic final static StringSOURCECHANGEpublic final static Stringpublic final static StringCURRENTSOURCECHANGEpublic final static Stringpublic final static StringREADYSTATECHANGEpublic final static Stringpublic final static StringTIMEUPDATEpublic final static Stringpublic final static StringWAITINGpublic final static Stringpublic final static StringPLAYINGpublic final static Stringpublic final static StringENDEDpublic final static Stringpublic final static StringLOADEDMETADATApublic final static Stringpublic final static StringLOADEDDATApublic final static Stringpublic final static StringCANPLAYpublic final static Stringpublic final static StringCANPLAYTHROUGHpublic final static Stringpublic final static StringSEGMENTNOTFOUNDpublic final static Stringpublic final static StringERRORpublic final static Stringpublic final static StringENCRYPTEDpublic final static Stringpublic final static StringCONTENTPROTECTIONERRORpublic final static Stringpublic final static StringCONTENTPROTECTIONSUCCESSpublic final static Stringpublic final static StringLICENSEREQUESTGENERATEDpublic final static Stringpublic final static StringNOSUPPORTEDREPRESENTATIONFOUNDpublic final static Stringpublic final static StringSEEKINGpublic final static Stringpublic final static StringSEEKEDpublic final static Stringpublic final static StringPRESENTATIONMODECHANGEpublic final static Stringpublic final static StringDESTROYpublic final static Stringpublic final static StringLOADSTARTpublic final static Stringpublic final static StringRESIZEabstract String
+ abstract String
getError()
@NonNull() abstract String getError()+
@NonNull() abstract String getError()
The error message to indicate why the segment was not found.
abstract Date
+ abstract Date
getCurrentProgramDateTime()
@Nullable() abstract Date getCurrentProgramDateTime()+
@Nullable() abstract Date getCurrentProgramDateTime()
The program date time associated with the player.
abstract String
+ abstract String
getDistributionId()
abstract String getDistributionId()+
abstract String getDistributionId()
The new distribution of the player.
abstract String
+ abstract String
getDistributionId()
abstract String getDistributionId()+
abstract String getDistributionId()
The new distribution of the player.
public final static Stringpublic final static StringINTENTTOFALLBACKpublic final static Stringpublic final static StringENTERBADNETWORKMODEpublic final static Stringpublic final static StringEXITBADNETWORKMODEpublic final static Stringpublic final static StringENDPOINTLOADEDpublic final static Stringpublic final static StringDISTRIBUTIONLOADSTARTpublic final static Stringpublic final static StringDISTRIBUTIONLOADEDpublic final static Stringpublic final static StringDISTRIBUTIONOFFLINEThe FullScreenActivity of the player.
Warning: In a future major version, this activity will no longer extend androidx.appcompat.app.AppCompatActivity. If your application overrides this activity or depends on AppCompat-specific behavior, ensure you do not rely on such functionality.
The FullScreenActivity of the player.
Warning: In a future major version, this activity will no longer extend androidx.appcompat.app.AppCompatActivity. If your application overrides this activity or depends on AppCompat-specific behavior, ensure you do not rely on such functionality.
public final static Stringpublic final static StringACCESSIBILITY_SERVICEpublic final static Stringpublic final static StringACCOUNT_SERVICEpublic final static Stringpublic final static StringACTIVITY_SERVICEpublic final static Stringpublic final static StringADVANCED_PROTECTION_SERVICEpublic final static Stringpublic final static StringALARM_SERVICEpublic final static Stringpublic final static StringAPPWIDGET_SERVICEpublic final static Stringpublic final static StringAPP_FUNCTION_SERVICEpublic final static Stringpublic final static StringAPP_OPS_SERVICEpublic final static Stringpublic final static StringAPP_SEARCH_SERVICEpublic final static Stringpublic final static StringAUDIO_SERVICEpublic final static Stringpublic final static StringBATTERY_SERVICEpublic final static Stringpublic final static StringBIOMETRIC_SERVICEpublic final static Stringpublic final static StringBLOB_STORE_SERVICEpublic final static Stringpublic final static StringBLUETOOTH_SERVICEpublic final static Stringpublic final static StringBUGREPORT_SERVICEpublic final static Stringpublic final static StringCAMERA_SERVICEpublic final static Stringpublic final static StringCAPTIONING_SERVICEpublic final static Stringpublic final static StringCARRIER_CONFIG_SERVICEpublic final static Stringpublic final static StringCLIPBOARD_SERVICEpublic final static Stringpublic final static StringCOMPANION_DEVICE_SERVICEpublic final static Stringpublic final static StringCONNECTIVITY_DIAGNOSTICS_SERVICEpublic final static Stringpublic final static StringCONNECTIVITY_SERVICEpublic final static Stringpublic final static StringCONSUMER_IR_SERVICEpublic final static Stringpublic final static StringCONTACT_KEYS_SERVICEpublic final static Stringpublic final static StringCREDENTIAL_SERVICEpublic final static Stringpublic final static StringCROSS_PROFILE_APPS_SERVICEpublic final static Stringpublic final static StringDEVICE_LOCK_SERVICEpublic final static Stringpublic final static StringDEVICE_POLICY_SERVICEpublic final static Stringpublic final static StringDISPLAY_HASH_SERVICEpublic final static Stringpublic final static StringDISPLAY_SERVICEpublic final static Stringpublic final static StringDOMAIN_VERIFICATION_SERVICEpublic final static Stringpublic final static StringDOWNLOAD_SERVICEpublic final static Stringpublic final static StringDROPBOX_SERVICEpublic final static Stringpublic final static StringEUICC_SERVICEpublic final static Stringpublic final static StringFILE_INTEGRITY_SERVICEpublic final static Stringpublic final static StringFINGERPRINT_SERVICEpublic final static Stringpublic final static StringGAME_SERVICEpublic final static Stringpublic final static StringGRAMMATICAL_INFLECTION_SERVICEpublic final static Stringpublic final static StringHARDWARE_PROPERTIES_SERVICEpublic final static Stringpublic final static StringHEALTHCONNECT_SERVICEpublic final static Stringpublic final static StringINPUT_METHOD_SERVICEpublic final static Stringpublic final static StringINPUT_SERVICEpublic final static Stringpublic final static StringIPSEC_SERVICEpublic final static Stringpublic final static StringJOB_SCHEDULER_SERVICEpublic final static Stringpublic final static StringKEYGUARD_SERVICEpublic final static Stringpublic final static StringKEYSTORE_SERVICEpublic final static Stringpublic final static StringLAUNCHER_APPS_SERVICEpublic final static Stringpublic final static StringLAYOUT_INFLATER_SERVICEpublic final static Stringpublic final static StringLOCALE_SERVICEpublic final static Stringpublic final static StringLOCATION_SERVICEpublic final static Stringpublic final static StringMEDIA_COMMUNICATION_SERVICEpublic final static Stringpublic final static StringMEDIA_METRICS_SERVICEpublic final static Stringpublic final static StringMEDIA_PROJECTION_SERVICEpublic final static Stringpublic final static StringMEDIA_QUALITY_SERVICEpublic final static Stringpublic final static StringMEDIA_ROUTER_SERVICEpublic final static Stringpublic final static StringMEDIA_SESSION_SERVICEpublic final static Stringpublic final static StringMIDI_SERVICEpublic final static Stringpublic final static StringNETWORK_STATS_SERVICEpublic final static Stringpublic final static StringNFC_SERVICEpublic final static Stringpublic final static StringNOTIFICATION_SERVICEpublic final static Stringpublic final static StringNSD_SERVICEpublic final static Stringpublic final static StringOVERLAY_SERVICEpublic final static Stringpublic final static StringPEOPLE_SERVICEpublic final static Stringpublic final static StringPERFORMANCE_HINT_SERVICEpublic final static Stringpublic final static StringPERSISTENT_DATA_BLOCK_SERVICEpublic final static Stringpublic final static StringPOWER_SERVICEpublic final static Stringpublic final static StringPRINT_SERVICEpublic final static Stringpublic final static StringPROFILING_SERVICEpublic final static Stringpublic final static StringRESTRICTIONS_SERVICEpublic final static Stringpublic final static StringROLE_SERVICEpublic final static Stringpublic final static StringSATELLITE_SERVICEpublic final static Stringpublic final static StringSEARCH_SERVICEpublic final static Stringpublic final static StringSECURITY_STATE_SERVICEpublic final static Stringpublic final static StringSENSOR_SERVICEpublic final static Stringpublic final static StringSHORTCUT_SERVICEpublic final static Stringpublic final static StringSTATUS_BAR_SERVICEpublic final static Stringpublic final static StringSTORAGE_SERVICEpublic final static Stringpublic final static StringSTORAGE_STATS_SERVICEpublic final static Stringpublic final static StringSYSTEM_HEALTH_SERVICEpublic final static Stringpublic final static StringTELECOM_SERVICEpublic final static Stringpublic final static StringTELEPHONY_IMS_SERVICEpublic final static Stringpublic final static StringTELEPHONY_SERVICEpublic final static Stringpublic final static StringTELEPHONY_SUBSCRIPTION_SERVICEpublic final static Stringpublic final static StringTETHERING_SERVICEpublic final static Stringpublic final static StringTEXT_CLASSIFICATION_SERVICEpublic final static Stringpublic final static StringTEXT_SERVICES_MANAGER_SERVICEpublic final static Stringpublic final static StringTV_AD_SERVICEpublic final static Stringpublic final static StringTV_INPUT_SERVICEpublic final static Stringpublic final static StringTV_INTERACTIVE_APP_SERVICEpublic final static Stringpublic final static StringUI_MODE_SERVICEpublic final static Stringpublic final static StringUSAGE_STATS_SERVICEpublic final static Stringpublic final static StringUSB_SERVICEpublic final static Stringpublic final static StringUSER_SERVICEpublic final static Stringpublic final static StringVIBRATOR_MANAGER_SERVICEpublic final static Stringpublic final static StringVIBRATOR_SERVICEpublic final static Stringpublic final static StringVIRTUAL_DEVICE_SERVICEpublic final static Stringpublic final static StringVPN_MANAGEMENT_SERVICEpublic final static Stringpublic final static StringWALLPAPER_SERVICEpublic final static Stringpublic final static StringWIFI_AWARE_SERVICEpublic final static Stringpublic final static StringWIFI_P2P_SERVICEpublic final static Stringpublic final static StringWIFI_RTT_RANGING_SERVICEpublic final static Stringpublic final static StringWIFI_SERVICEpublic final static Stringpublic final static StringWINDOW_SERVICEabstract void
setFullscreenActivity(@NonNull() Class<out FullScreenActivity> fullscreenActivityClass)
+ setFullscreenActivity(@NonNull() Class<out FullScreenActivity> fullscreenActivityClass)
abstract Class<out FullScreenActivity>
+ abstract Class<out FullScreenActivity>
getFullscreenActivity()
abstract void setFullscreenActivity(@NonNull() Class<out FullScreenActivity> fullscreenActivityClass)+
abstract void setFullscreenActivity(@NonNull() Class<out FullScreenActivity> fullscreenActivityClass)
Sets the FullScreenActivity class to be used.
@NonNull() abstract Class<out FullScreenActivity> getFullscreenActivity()+
@NonNull() abstract Class<out FullScreenActivity> getFullscreenActivity()
The class which is set as the FullScreenActivity class.
Default: The FullScreenActivity class.
-@Retention(value = RetentionPolicy.SOURCE) +@Retention(value = RetentionPolicy.SOURCE) public @interface ScreenOrientationdiff --git a/theoplayer/static/theoplayer/v11/api-reference/android/com/theoplayer/android/api/latency/LatencyConfiguration.Builder.html b/theoplayer/static/theoplayer/v11/api-reference/android/com/theoplayer/android/api/latency/LatencyConfiguration.Builder.html index c144f2450a9c..2d8b3def3955 100644 --- a/theoplayer/static/theoplayer/v11/api-reference/android/com/theoplayer/android/api/latency/LatencyConfiguration.Builder.html +++ b/theoplayer/static/theoplayer/v11/api-reference/android/com/theoplayer/android/api/latency/LatencyConfiguration.Builder.html @@ -254,7 +254,7 @@
final LatencyConfiguration.Builder
setMinimumOffset(Double minimumOffset)
+ setMinimumOffset(Double minimumOffset)
final LatencyConfiguration.Builder
setMaximumOffset(Double maximumOffset)
+ setMaximumOffset(Double maximumOffset)
final LatencyConfiguration.Builder
setTargetOffset(Double targetOffset)
+ setTargetOffset(Double targetOffset)
final LatencyConfiguration.Builder
setForceSeekOffset(Double forceSeekOffset)
+ setForceSeekOffset(Double forceSeekOffset)
final LatencyConfiguration.Builder
setMinimumPlaybackRate(Double minimumPlaybackRate)
+ setMinimumPlaybackRate(Double minimumPlaybackRate)
final LatencyConfiguration.Builder
setMaximumPlaybackRate(Double maximumPlaybackRate)
+ setMaximumPlaybackRate(Double maximumPlaybackRate)
final LatencyConfiguration.Builder setMinimumOffset(Double minimumOffset)+
final LatencyConfiguration.Builder setMinimumOffset(Double minimumOffset)
The start of the target live window. If the live offset becomes smaller than this value, the player will slow down in order to increase the latency.
Default: 0.66 times the targetOffset.
final LatencyConfiguration.Builder setMaximumOffset(Double maximumOffset)+
final LatencyConfiguration.Builder setMaximumOffset(Double maximumOffset)
The end of the target live window. If the live offset becomes higher than this value, the player will speed up in order to decrease the latency.
Default: Value 1.5 times the targetOffset.
final LatencyConfiguration.Builder setTargetOffset(Double targetOffset)+
final LatencyConfiguration.Builder setTargetOffset(Double targetOffset)
The live offset that the player will aim for. When correcting the offset by tuning the playbackRate, the player will stop correcting when it reaches this value.
This will override the TypedSource.liveOffset value.
final LatencyConfiguration.Builder setForceSeekOffset(Double forceSeekOffset)+
final LatencyConfiguration.Builder setForceSeekOffset(Double forceSeekOffset)
The live offset at which the player will automatically trigger a live seek.
Default: Value 3 times the targetOffset.
final LatencyConfiguration.Builder setMinimumPlaybackRate(Double minimumPlaybackRate)+
final LatencyConfiguration.Builder setMinimumPlaybackRate(Double minimumPlaybackRate)
Indicates the minimum playbackRate used to slow down the player.
Default: Value 0.92
final LatencyConfiguration.Builder setMaximumPlaybackRate(Double maximumPlaybackRate)+
final LatencyConfiguration.Builder setMaximumPlaybackRate(Double maximumPlaybackRate)
Indicates the maximum playbackRate used to speed up the player.
Default: Value 1.08
private final Doubleprivate final DoubletargetOffsetprivate final Doubleprivate final DoubleminimumOffsetprivate final Doubleprivate final DoublemaximumOffsetprivate final Doubleprivate final DoubleforceSeekOffsetprivate final Doubleprivate final DoubleminimumPlaybackRateprivate final Doubleprivate final DoublemaximumPlaybackRateLatencyConfiguration(Double targetOffset, Double minimumOffset, Double maximumOffset, Double forceSeekOffset, Double minimumPlaybackRate, Double maximumPlaybackRate)final Double
+ final Double
getTargetOffset()
final Double
+ final Double
getMinimumOffset()
final Double
+ final Double
getMaximumOffset()
final Double
+ final Double
getForceSeekOffset()
final Double
+ final Double
getMinimumPlaybackRate()
final Double
+ final Double
getMaximumPlaybackRate()
LatencyConfiguration(Double targetOffset, Double minimumOffset, Double maximumOffset, Double forceSeekOffset, Double minimumPlaybackRate, Double maximumPlaybackRate)+
LatencyConfiguration(Double targetOffset, Double minimumOffset, Double maximumOffset, Double forceSeekOffset, Double minimumPlaybackRate, Double maximumPlaybackRate)
final Double getTargetOffset()+
final Double getTargetOffset()
The live offset that the player will aim for. When correcting the offset by tuning the playbackRate, the player will stop correcting when it reaches this value.
This will override the TypedSource.liveOffset value.
final Double getMinimumOffset()+
final Double getMinimumOffset()
The start of the target live window. If the live offset becomes smaller than this value, the player will slow down in order to increase the latency.
Default: 0.66 times the targetOffset.
final Double getMaximumOffset()+
final Double getMaximumOffset()
The end of the target live window. If the live offset becomes higher than this value, the player will speed up in order to decrease the latency.
Default: Value 1.5 times the targetOffset.
final Double getForceSeekOffset()+
final Double getForceSeekOffset()
The live offset at which the player will automatically trigger a live seek.
Default: Value 3 times the targetOffset.
final Double getMinimumPlaybackRate()+
final Double getMinimumPlaybackRate()
Indicates the minimum playbackRate used to slow down the player.
Default: Value 0.92
final Double getMaximumPlaybackRate()+
final Double getMaximumPlaybackRate()
Indicates the maximum playbackRate used to speed up the player.
Default: Value 1.08
abstract Boolean
+ abstract Boolean
isEnabled()
abstract Unit
setEnabled(Boolean isEnabled)
+ setEnabled(Boolean isEnabled)
abstract Boolean
+ abstract Boolean
isMonitoringLivePlayback()
abstract Double
+ abstract Double
getCurrentLatency()
@MainThread() abstract Boolean isEnabled()+
@MainThread() abstract Boolean isEnabled()
Whether the latency manager is enabled.
With the Media3 backend, this value is automatically set to true when TypedSource.latencyConfiguration is set.
@MainThread() abstract Unit setEnabled(Boolean isEnabled)+
@MainThread() abstract Unit setEnabled(Boolean isEnabled)
Whether the latency manager is enabled.
With the Media3 backend, this value is automatically set to true when TypedSource.latencyConfiguration is set.
@MainThread() abstract Boolean isMonitoringLivePlayback()+
@MainThread() abstract Boolean isMonitoringLivePlayback()
Whether the latency manager is monitoring to stay within the live playback configuration.
Can only be monitored for live playback.
With the Media3 backend, this value is true if the manager is enabled and a TypedSource.latencyConfiguration was set.
@MainThread() abstract Double getCurrentLatency()+
@MainThread() abstract Double getCurrentLatency()
The current latency.
Only available during live playback.
public final static Stringpublic final static StringDEFAULT_API_URLprivate final Stringprivate final StringstreamAccountIdprivate final Stringprivate final StringapiUrlprivate final Stringprivate final StringsubscriberTokenprivate final Map<String, String>private final Map<String, String>headersprivate final Booleanprivate final BooleanhlsDateRangeprivate final Doubleprivate final DoubleliveOffsetprivate final Booleanprivate final BooleanlowLatencyprivate final Stringprivate final Stringsrcprivate final Stringprivate final StringtimeServerMillicastSource(String src, String streamAccountId, String apiUrl, String subscriberToken, Option connectOptions)final String
+ final String
getStreamAccountId()
final String
+ final String
getApiUrl()
final String
+ final String
getSubscriberToken()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
final MillicastSource
copy(String src, String streamAccountId, String apiUrl, String subscriberToken, Option connectOptions)
+ copy(String src, String streamAccountId, String apiUrl, String subscriberToken, Option connectOptions)
MillicastSource
copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
+ copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
MillicastSource(String src, String streamAccountId, String apiUrl, String subscriberToken, Option connectOptions)+
MillicastSource(String src, String streamAccountId, String apiUrl, String subscriberToken, Option connectOptions)
final String getStreamAccountId()+
final String getStreamAccountId()
The account identifier.
final String getApiUrl()+
final String getApiUrl()
The URL of the API endpoint that the SDK communicates with for authentication.
final String getSubscriberToken()+
final String getSubscriberToken()
The subscribing token.
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
final MillicastSource copy(String src, String streamAccountId, String apiUrl, String subscriberToken, Option connectOptions)+
final MillicastSource copy(String src, String streamAccountId, String apiUrl, String subscriberToken, Option connectOptions)
Creates a new MillicastSource with the same properties as this source, optionally replacing specific properties with the given values.
MillicastSource copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)+
MillicastSource copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
private final URLprivate final URLurlprivate final Map<String, String>private final Map<String, String>headersprivate final Integerprivate final Integerstatusprivate final Stringprivate final StringstatusTextCompleteHTTPResponse(HTTPRequest request, URL url, Map<String, String> headers, Integer status, String statusText, ByteArray body)URL
+ URL
getUrl()
Map<String, String>
+ Map<String, String>
getHeaders()
Integer
+ Integer
getStatus()
String
+ String
getStatusText()
CompleteHTTPResponse(HTTPRequest request, URL url, Map<String, String> headers, Integer status, String statusText, ByteArray body)+
CompleteHTTPResponse(HTTPRequest request, URL url, Map<String, String> headers, Integer status, String statusText, ByteArray body)
URL getUrl()+
URL getUrl()
The URL which was used to do the request to.
Note that, in case of redirects it can be different from the original request URL.
Map<String, String> getHeaders()+
Map<String, String> getHeaders()
The response headers received from the request.
In case of multiple values per key, the values are comma separated.
Integer getStatus()+
Integer getStatus()
The status code from the HTTP response message received from the request.
From responses like HTTP/1.0 200 OK, extracts the number 200.
String getStatusText()+
String getStatusText()
The HTTP response message, if any, returned from a server.
From responses like HTTP/1.0 200 OK, extracts the Strings "OK".
Returns null if none could be discerned from the responses (the result was not valid HTTP).
abstract String
+ abstract String
getMethod()
abstract URL
+ abstract URL
getUrl()
abstract Map<String, String>
+ abstract Map<String, String>
getHeaders()
abstract Integer
+ abstract Integer
getConnectTimeout()
abstract Integer
+ abstract Integer
getReadTimeout()
abstract String getMethod()+
abstract String getMethod()
The method for the URL request, one of:
"GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE"
abstract URL getUrl()+
abstract URL getUrl()
The URL to perform the request to.
abstract Map<String, String> getHeaders()+
abstract Map<String, String> getHeaders()
The request headers to be used during the request.
In case of multiple values per key, the values are comma separated.
abstract Integer getConnectTimeout()+
abstract Integer getConnectTimeout()
The connection timeout in milliseconds. This timeout is used when establishing a connection to a remote server. If the connection cannot be established within this timeout period, a connection timeout error will be thrown.
abstract Integer getReadTimeout()+
abstract Integer getReadTimeout()
The read timeout in milliseconds. This timeout is used when reading data from an established connection with a remote server. If no data is received within this timeout period, a read timeout error will be thrown.
abstract URL
+ abstract URL
getUrl()
abstract Map<String, String>
+ abstract Map<String, String>
getHeaders()
abstract Integer
+ abstract Integer
getStatus()
abstract String
+ abstract String
getStatusText()
abstract URL getUrl()+
abstract URL getUrl()
The URL which was used to do the request to.
Note that, in case of redirects it can be different from the original request URL.
abstract Map<String, String> getHeaders()+
abstract Map<String, String> getHeaders()
The response headers received from the request.
In case of multiple values per key, the values are comma separated.
abstract Integer getStatus()+
abstract Integer getStatus()
The status code from the HTTP response message received from the request.
From responses like HTTP/1.0 200 OK, extracts the number 200.
abstract String getStatusText()+
abstract String getStatusText()
The HTTP response message, if any, returned from a server.
From responses like HTTP/1.0 200 OK, extracts the Strings "OK".
Returns null if none could be discerned from the responses (the result was not valid HTTP).
abstract String
+ abstract String
getMethod()
abstract Unit
setMethod(String method)
+ setMethod(String method)
abstract URL
+ abstract URL
getUrl()
abstract Unit
setUrl(URL url)
+ setUrl(URL url)
abstract Map<String, String>
+ abstract Map<String, String>
getHeaders()
abstract Unit
setHeaders(Map<String, String> headers)
+ setHeaders(Map<String, String> headers)
abstract Integer
+ abstract Integer
getConnectTimeout()
abstract Unit
setConnectTimeout(Integer connectTimeout)
+ setConnectTimeout(Integer connectTimeout)
abstract Integer
+ abstract Integer
getReadTimeout()
abstract Unit
setReadTimeout(Integer readTimeout)
+ setReadTimeout(Integer readTimeout)
abstract String getMethod()+
abstract String getMethod()
The mutable method for the URL request, one of:
"GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE"
abstract Unit setMethod(String method)+
abstract Unit setMethod(String method)
The mutable method for the URL request, one of:
"GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE"
abstract URL getUrl()+
abstract URL getUrl()
The mutable URL to perform the request to.
abstract Unit setUrl(URL url)+
abstract Unit setUrl(URL url)
The mutable URL to perform the request to.
abstract Map<String, String> getHeaders()+
abstract Map<String, String> getHeaders()
The mutable request headers to be used during the request.
In case of multiple values per key, the values are comma separated.
Adding or overriding headers can be done by:
headers["newKey"] = "newValue"
abstract Unit setHeaders(Map<String, String> headers)+
abstract Unit setHeaders(Map<String, String> headers)
The mutable request headers to be used during the request.
In case of multiple values per key, the values are comma separated.
Adding or overriding headers can be done by:
headers["newKey"] = "newValue"
abstract Integer getConnectTimeout()+
abstract Integer getConnectTimeout()
The connection timeout in milliseconds. This timeout is used when establishing a connection to a remote server. If the connection cannot be established within this timeout period, a connection timeout error will be thrown.
abstract Unit setConnectTimeout(Integer connectTimeout)+
abstract Unit setConnectTimeout(Integer connectTimeout)
The connection timeout in milliseconds. This timeout is used when establishing a connection to a remote server. If the connection cannot be established within this timeout period, a connection timeout error will be thrown.
abstract Integer getReadTimeout()+
abstract Integer getReadTimeout()
The read timeout in milliseconds. This timeout is used when reading data from an established connection with a remote server. If no data is received within this timeout period, a read timeout error will be thrown.
abstract Unit setReadTimeout(Integer readTimeout)+
abstract Unit setReadTimeout(Integer readTimeout)
The read timeout in milliseconds. This timeout is used when reading data from an established connection with a remote server. If no data is received within this timeout period, a read timeout error will be thrown.
abstract URL
+ abstract URL
getUrl()
abstract Unit
setUrl(URL url)
+ setUrl(URL url)
abstract Map<String, String>
+ abstract Map<String, String>
getHeaders()
abstract Unit
setHeaders(Map<String, String> headers)
+ setHeaders(Map<String, String> headers)
abstract Integer
+ abstract Integer
getStatus()
abstract Unit
setStatus(Integer status)
+ setStatus(Integer status)
abstract String
+ abstract String
getStatusText()
abstract Unit
setStatusText(String statusText)
+ setStatusText(String statusText)
abstract URL getUrl()+
abstract URL getUrl()
The mutable URL which was used to do the request to.
Note that, in case of redirects it can be different from the original request URL.
abstract Unit setUrl(URL url)+
abstract Unit setUrl(URL url)
The mutable URL which was used to do the request to.
Note that, in case of redirects it can be different from the original request URL.
abstract Map<String, String> getHeaders()+
abstract Map<String, String> getHeaders()
The mutable response headers received from the request.
In case of multiple values per key, the values are comma separated.
Adding or overriding headers can be done by:
headers"newKey" = "newValue"
abstract Unit setHeaders(Map<String, String> headers)+
abstract Unit setHeaders(Map<String, String> headers)
The mutable response headers received from the request.
In case of multiple values per key, the values are comma separated.
Adding or overriding headers can be done by:
headers"newKey" = "newValue"
abstract Integer getStatus()+
abstract Integer getStatus()
The mutable status code from the HTTP response message received from the request.
From responses like HTTP/1.0 200 OK, extracts the number 200.
abstract Unit setStatus(Integer status)+
abstract Unit setStatus(Integer status)
The mutable status code from the HTTP response message received from the request.
From responses like HTTP/1.0 200 OK, extracts the number 200.
abstract String getStatusText()+
abstract String getStatusText()
The mutable HTTP response message, if any, returned from a server.
From responses like HTTP/1.0 200 OK, extracts the Strings "OK".
Returns null if none could be discerned from the responses (the result was not valid HTTP).
abstract Unit setStatusText(String statusText)+
abstract Unit setStatusText(String statusText)
The mutable HTTP response message, if any, returned from a server.
From responses like HTTP/1.0 200 OK, extracts the Strings "OK".
Returns null if none could be discerned from the responses (the result was not valid HTTP).
abstract Unit
onRequestAsync(InterceptableHTTPRequest request, JavaCallback<Void> callback)
+ onRequestAsync(InterceptableHTTPRequest request, JavaCallback<Void> callback)
abstract Unit
onResponseAsync(InterceptableHTTPResponse response, JavaCallback<Void> callback)
+ onResponseAsync(InterceptableHTTPResponse response, JavaCallback<Void> callback)
abstract Unit onRequestAsync(InterceptableHTTPRequest request, JavaCallback<Void> callback)+
abstract Unit onRequestAsync(InterceptableHTTPRequest request, JavaCallback<Void> callback)
Intercepts an HTTP request before opening the connection, optionally modifying the request.
After the given callback is called, the given request can no longer be modified.
abstract Unit onResponseAsync(InterceptableHTTPResponse response, JavaCallback<Void> callback)+
abstract Unit onResponseAsync(InterceptableHTTPResponse response, JavaCallback<Void> callback)
Intercepts an HTTP response before receiving the response bode, optionally modifying the response.
After the given callback is called, the given response can no longer be modified.
public enum RequestMediaType -extends Enum<RequestMediaType> +extends Enum<RequestMediaType>
The media's type.
private final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal RequestMediaType
valueOf(String value)
+ valueOf(String value)
final RequestMediaType valueOf(String value)+
final RequestMediaType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
public enum RequestSubType -extends Enum<RequestSubType> +extends Enum<RequestSubType>
The request's subtype.
private final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal RequestSubType
valueOf(String value)
+ valueOf(String value)
final RequestSubType valueOf(String value)+
final RequestSubType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
public enum RequestType -extends Enum<RequestType> +extends Enum<RequestType>
The request's type.
private final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal RequestType
valueOf(String value)
+ valueOf(String value)
final RequestType valueOf(String value)+
final RequestType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
public enum ResponseType -extends Enum<ResponseType> +extends Enum<ResponseType>@@ -181,13 +181,13 @@
private final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal ResponseType
valueOf(String value)
+ valueOf(String value)
final ResponseType valueOf(String value)+
final ResponseType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
static PiPType
valueOf(String name)
+ valueOf(String name)
static PiPType valueOf(String name)+
static PiPType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
static AspectRatio
valueOf(String name)
+ valueOf(String name)
static AspectRatio valueOf(String name)+
static AspectRatio valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
final NetworkConfiguration.Builder
maxRetries(Integer maxRetries)
+ maxRetries(Integer maxRetries)
final NetworkConfiguration.Builder
minimumBackOff(Long minimumBackOff)
+ minimumBackOff(Long minimumBackOff)
final NetworkConfiguration.Builder
maximumBackOff(Long maximumBackOff)
+ maximumBackOff(Long maximumBackOff)
final NetworkConfiguration.Builder
useHttpEngine(Boolean useHttpEngine)
+ useHttpEngine(Boolean useHttpEngine)
final NetworkConfiguration.Builder maxRetries(Integer maxRetries)+
final NetworkConfiguration.Builder maxRetries(Integer maxRetries)
Sets the maximum amount of retries before the player throws a fatal error.
final NetworkConfiguration.Builder minimumBackOff(Long minimumBackOff)+
final NetworkConfiguration.Builder minimumBackOff(Long minimumBackOff)
Sets the initial delay in milliseconds before a retry request occurs. Exponential backoff will be applied on this value.
final NetworkConfiguration.Builder maximumBackOff(Long maximumBackOff)+
final NetworkConfiguration.Builder maximumBackOff(Long maximumBackOff)
Sets the maximum amount of delay in milliseconds between retry requests.
final NetworkConfiguration.Builder useHttpEngine(Boolean useHttpEngine)+
final NetworkConfiguration.Builder useHttpEngine(Boolean useHttpEngine)
Sets whether the player should use android.net.http.HttpEngine or Cronet for its network stack, if available.
private final Integerprivate final IntegermaxRetriesprivate final Longprivate final LongminimumBackOffprivate final Longprivate final LongmaximumBackOffprivate final Booleanprivate final BooleanuseHttpEnginefinal Integer
+ final Integer
getMaxRetries()
final Long
+ final Long
getMinimumBackOff()
final Long
+ final Long
getMaximumBackOff()
final Boolean
+ final Boolean
getUseHttpEngine()
final Integer getMaxRetries()+
final Integer getMaxRetries()
The maximum amount of retries before the player throws a fatal error.
Default: Integer.MAX_VALUE.
final Long getMinimumBackOff()+
final Long getMinimumBackOff()
Sets the initial delay in milliseconds before a retry request occurs. Exponential backoff will be applied on this value.
Default: 200.
final Long getMaximumBackOff()+
final Long getMaximumBackOff()
Sets the maximum amount of delay in milliseconds between retry requests.
Default: 30000.
final Boolean getUseHttpEngine()-
Whether the player should use android.net.http.HttpEngine or Cronet for its network stack, if available.
By default, the player uses android.net.http.HttpEngine (on Android 14 and higher) or Cronet (when added as a library to your app) for all its network requests, taking advantage of HTTP/2 and HTTP/3 support for optimal media streaming. When neither of these APIs are available, the player falls back to HTTP/1.1 using java.net.HttpURLConnection.
When set to true, the player will attempt to use either android.net.http.HttpEngine or Cronet for its network requests.
When set to false, the player will always use java.net.HttpURLConnection.
Note: Some APIs such as com.theoplayer.android.api.settings.SslSettings.setKeyStore are not supported when using the modern network stack.
Default: true
final Boolean getUseHttpEngine()+
Whether the player should use android.net.http.HttpEngine or Cronet for its network stack, if available.
By default, the player uses android.net.http.HttpEngine (on Android 14 and higher) or Cronet (when added as a library to your app) for all its network requests, taking advantage of HTTP/2 and HTTP/3 support for optimal media streaming. When neither of these APIs are available, the player falls back to HTTP/1.1 using java.net.HttpURLConnection.
When set to true, the player will attempt to use either android.net.http.HttpEngine or Cronet for its network requests.
When set to false, the player will always use java.net.HttpURLConnection.
Note: Some APIs such as com.theoplayer.android.api.settings.SslSettings.setKeyStore are not supported when using the modern network stack.
Default: true
abstract TypedSource
+ getCurrentSource()
+ null if no source is set.abstract void
addIntegration(Integration integration)
@@ -256,7 +264,7 @@ abstract void
removeIntegration(Integration integration)
@@ -264,7 +272,7 @@ abstract TheoLive
getTheoLive()
@@ -272,7 +280,7 @@ abstract Ads
getAds()
@@ -280,7 +288,7 @@ abstract Abr
getAbr()
@@ -288,7 +296,7 @@ abstract MediaTrackList<VideoQuality>
getVideoTracks()
@@ -296,7 +304,7 @@ abstract MediaTrackList<AudioQuality>
getAudioTracks()
@@ -304,7 +312,7 @@ abstract TextTrackList
getTextTracks()
@@ -312,7 +320,7 @@ abstract double
getDuration()
@@ -320,7 +328,7 @@ abstract boolean
isAutoplay()
@@ -328,7 +336,7 @@ abstract void
setAutoplay(boolean autoplay)
@@ -336,7 +344,7 @@ abstract double
getVolume()
@@ -344,7 +352,7 @@ abstract void
setVolume(double volume)
@@ -352,7 +360,7 @@ abstract PreloadType
getPreload()
@@ -360,7 +368,7 @@ abstract void
setPreload(@NonNull() PreloadType preload)
@@ -368,7 +376,7 @@ abstract boolean
isMuted()
@@ -376,7 +384,7 @@ abstract void
setMuted(boolean muted)
@@ -384,7 +392,7 @@ abstract boolean
isSeeking()
@@ -392,7 +400,7 @@ abstract SourceDescription
getSource()
@@ -400,7 +408,7 @@ abstract void
setSource(@Nullable() SourceDescription source)
@@ -408,23 +416,23 @@ abstract String
+ abstract String
getSrc()
abstract void
setSrc(@Nullable() String src)
+ setSrc(@Nullable() String src)
abstract boolean
isPaused()
@@ -432,7 +440,7 @@ abstract boolean
isEnded()
@@ -440,7 +448,7 @@ abstract void
play()
@@ -448,7 +456,7 @@ abstract void
pause()
@@ -456,7 +464,7 @@ abstract void
stop()
@@ -464,7 +472,7 @@ abstract ReadyState
getReadyState()
@@ -472,7 +480,7 @@ abstract TimeRanges
getBuffered()
@@ -480,7 +488,7 @@ abstract double
getCurrentTime()
@@ -488,7 +496,7 @@ abstract void
setCurrentTime(double currentTime)
@@ -496,7 +504,7 @@ abstract Metrics
getMetrics()
@@ -504,15 +512,15 @@ abstract String
+ abstract String
getError()
abstract double
getPlaybackRate()
@@ -520,7 +528,7 @@ abstract void
setPlaybackRate(double playbackRate)
@@ -528,7 +536,7 @@ abstract TimeRanges
getPlayed()
@@ -536,7 +544,7 @@ abstract TimeRanges
getSeekable()
@@ -544,23 +552,23 @@ abstract Date
+ abstract Date
getCurrentProgramDateTime()
abstract void
setCurrentProgramDateTime(Date currentProgramDateTime)
+ setCurrentProgramDateTime(Date currentProgramDateTime)
abstract int
getVideoHeight()
@@ -568,7 +576,7 @@ abstract int
getVideoWidth()
@@ -576,7 +584,7 @@ abstract HespApi
getHespApi()
@@ -584,7 +592,7 @@ abstract void
setAspectRatio(AspectRatio aspectRatio)
@@ -592,7 +600,7 @@ abstract void
setRenderingTarget(RenderingTarget renderingTarget)
@@ -600,7 +608,7 @@ abstract void
setCustomSurface(@Nullable() Surface surface, int width, int height)
@@ -608,7 +616,7 @@ abstract TextTrackStyle
getTextTrackStyle()
@@ -616,7 +624,7 @@ abstract Network
getNetwork()
@@ -624,7 +632,7 @@ abstract LatencyManager
getLatencyManager()
@@ -632,18 +640,18 @@ abstract String
+ abstract String
getPoster()
abstract void
setPoster(@Nullable() String poster)
+ setPoster(@Nullable() String poster)
@MainThread()@Nullable() abstract TypedSource getCurrentSource()+
Returns the source that is currently being played, or null if no source is set.
the currently played TypedSource, or null if no source is set.
@MainThread()@Nullable() abstract String getSrc()+
@MainThread()@Nullable() abstract String getSrc()
The current URL of the media.
@MainThread() abstract void setSrc(@Nullable() String src)+
@MainThread() abstract void setSrc(@Nullable() String src)
Sets a new media source URL.
@MainThread()@Nullable() abstract String getError()+
@MainThread()@Nullable() abstract String getError()
The last error that occurred for the current source, if any.
@MainThread()@Nullable() abstract Date getCurrentProgramDateTime()+
@MainThread()@Nullable() abstract Date getCurrentProgramDateTime()
The current playback position of the media, as a timestamp.
@MainThread() abstract void setCurrentProgramDateTime(Date currentProgramDateTime)+
@MainThread() abstract void setCurrentProgramDateTime(Date currentProgramDateTime)
Sets the current program date time.
@MainThread()@Nullable() abstract String getPoster()+
@MainThread()@Nullable() abstract String getPoster()
The poster image URL of the player.
@MainThread() abstract void setPoster(@Nullable() String poster)+
@MainThread() abstract void setPoster(@Nullable() String poster)
Sets the poster image URL for the player. This poster will be shown for any source which doesn't specify the poster URL in the SourceDescription.
public final Stringpublic final Stringtypestatic PreloadType
valueOf(String name)
+ valueOf(String name)
String
+ String
getType()
static PreloadType valueOf(String name)+
static PreloadType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
@NonNull() String getType()+
@NonNull() String getType()
The textual representation of preload type.
public final Stringpublic final Stringmodestatic PresentationMode
valueOf(String name)
+ valueOf(String name)
String
+ String
getMode()
static PresentationMode valueOf(String name)+
static PresentationMode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
String getMode()+
String getMode()
static ReadyState
valueOf(String name)
+ valueOf(String name)
static ReadyState valueOf(String name)+
static ReadyState valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
static RenderingTarget
valueOf(String name)
+ valueOf(String name)
static RenderingTarget valueOf(String name)+
static RenderingTarget valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
abstract String
+ abstract String
getId()
abstract String
+ abstract String
getName()
abstract String
+ abstract String
getUrl()
abstract String getId()+
abstract String getId()
abstract String getName()+
abstract String getName()
abstract String getUrl()+
abstract String getUrl()
abstract String
+ abstract Unit
+ switchToHesp()
+ abstract String
getAuthToken()
abstract Unit
setAuthToken(String authToken)
+ setAuthToken(String authToken)
abstract Unit switchToHesp()+
Forces the player back to HESP when available: resets the HESP cooldown and re-selects a HESP source.
abstract String getAuthToken()+
abstract String getAuthToken()
The authentication token that will be used when requesting a manifest or segment. To unset the token, pass null or an empty string.
abstract Unit setAuthToken(String authToken)+
abstract Unit setAuthToken(String authToken)
The authentication token that will be used when requesting a manifest or segment. To unset the token, pass null or an empty string.
abstract String
+ abstract String
getId()
abstract Long
+ abstract Long
getBandwidth()
abstract Boolean
+ abstract Boolean
isBadNetworkOnly()
abstract String getId()+
abstract String getId()
abstract Long getBandwidth()+
abstract Long getBandwidth()
abstract Boolean isBadNetworkOnly()+
abstract Boolean isBadNetworkOnly()
abstract String
+ abstract String
getKind()
abstract String
+ abstract String
getId()
abstract String
+ abstract String
getLabel()
abstract String
+ abstract String
getLanguage()
@Nullable() abstract String getKind()+
@Nullable() abstract String getKind()
The kind of the track.
@Nullable() abstract String getId()+
@Nullable() abstract String getId()
The identifier of the track.
@Nullable() abstract String getLabel()+
@Nullable() abstract String getLabel()
The label of the track.
@Nullable() abstract String getLanguage()+
@Nullable() abstract String getLanguage()
The language of the track.
Example:
abstract void
setTargetQualities(@Nullable() List<Q> targetQualities)
+ setTargetQualities(@Nullable() List<Q> targetQualities)
abstract void setTargetQualities(@Nullable() List<Q> targetQualities)+
abstract void setTargetQualities(@Nullable() List<Q> targetQualities)
Set the target qualities.
abstract String
+ abstract String
getCodecs()
abstract String
+ abstract String
getId()
abstract String
+ abstract String
getName()
@Nullable() abstract String getCodecs()+
@Nullable() abstract String getCodecs()
The codecs of the quality as defined in the manifest.
abstract String getId()+
abstract String getId()
@Nullable() abstract String getName()+
@Nullable() abstract String getName()
The name of the quality as defined in the manifest.
abstract String
+ abstract String
getKind()
abstract String
+ abstract String
getInBandMetadataTrackDispatchType()
abstract String
+ abstract String
getSource()
abstract Integer
+ abstract Integer
getCaptionChannel()
abstract String getKind()+
abstract String getKind()
The kind of the text track.
Example:
@Nullable() abstract String getInBandMetadataTrackDispatchType()+
@Nullable() abstract String getInBandMetadataTrackDispatchType()
The dispatch-type of the in-band metadata track of the given text track. (Nullable)
@Nullable() abstract String getSource()+
@Nullable() abstract String getSource()
The source of the text track.
@Nullable() abstract Integer getCaptionChannel()+
@Nullable() abstract Integer getCaptionChannel()
The closed caption service number of the text track.
public enum TextTrackKind -extends Enum<TextTrackKind> +extends Enum<TextTrackKind>
The text track kind.
private final Stringprivate final Stringtypeprivate final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal TextTrackKind
valueOf(String value)
+ valueOf(String value)
final String
+ final String
getType()
final TextTrackKind valueOf(String value)+
final TextTrackKind valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
final String getType()+
final String getType()
The textual representation of the text track kind. (NonNull)
public final Stringpublic final Stringmodestatic TextTrackMode
from(String mode)
+ from(String mode)
String
+ String
toString()
static TextTrackMode
valueOf(String name)
+ valueOf(String name)
String
+ String
getMode()
@Nullable() static TextTrackMode from(String mode)+
@Nullable() static TextTrackMode from(String mode)
Creates a text track mode from a textual representation, when possible.
String toString()+
String toString()
static TextTrackMode valueOf(String name)+
static TextTrackMode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
@NonNull() String getMode()+
@NonNull() String getMode()
The textual representation of the text track mode.
static TextTrackReadyState
valueOf(String name)
+ valueOf(String name)
static TextTrackReadyState valueOf(String name)+
static TextTrackReadyState valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
static TextTrackStyle.EdgeType
valueOf(String name)
+ valueOf(String name)
static TextTrackStyle.EdgeType valueOf(String name)+
static TextTrackStyle.EdgeType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
static TextTrackStyle.FontFamily
valueOf(String name)
+ valueOf(String name)
static TextTrackStyle.FontFamily valueOf(String name)+
static TextTrackStyle.FontFamily valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
static TextTrackStyle.FontStyle
valueOf(String name)
+ valueOf(String name)
static TextTrackStyle.FontStyle valueOf(String name)+
static TextTrackStyle.FontStyle valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
abstract void
setFont(@NonNull() String fontFile, @NonNull() TextTrackStyle.FontStyle fontStyle)
+ setFont(@NonNull() String fontFile, @NonNull() TextTrackStyle.FontStyle fontStyle)
abstract String
+ abstract String
getFontFile()
@MainThread() abstract void setFont(@Nullable() TextTrackStyle.FontFamily fontFamily, @NonNull() TextTrackStyle.FontStyle fontStyle)-
Sets the font family and font style.
This is equivalent to calling setFont with the result of create.
Sets the font family and font style.
This is equivalent to calling setFont with the result of create.
@MainThread() abstract void setFont(@NonNull() String fontFile, @NonNull() TextTrackStyle.FontStyle fontStyle)-
Sets the font from the font file.
This is equivalent to calling setFont with the result of createFromFile.
@MainThread() abstract void setFont(@NonNull() String fontFile, @NonNull() TextTrackStyle.FontStyle fontStyle)+
Sets the font from the font file.
This is equivalent to calling setFont with the result of createFromFile.
@MainThread()@Nullable() abstract String getFontFile()+
@MainThread()@Nullable() abstract String getFontFile()
Returns the file name of the current font.
final TextTrackType
from(String type)
+ from(String type)
final TextTrackType from(String type)+
final TextTrackType from(String type)
Creates a text track type state from a textual representation.
Default: TextTrackType.NONE
public enum TextTrackType -extends Enum<TextTrackType> +extends Enum<TextTrackType>
The content type of a text track.
private final Stringprivate final Stringtypeprivate final Stringprivate final Stringnameprivate final Integerprivate final IntegerordinalString
+ String
toString()
final TextTrackType
valueOf(String value)
+ valueOf(String value)
final String
+ final String
getType()
String toString()+
String toString()
final TextTrackType valueOf(String value)+
final TextTrackType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
final String getType()+
final String getType()
The textual representation of the text track type. (NonNull)
abstract Double
+ abstract Double
getDouble(@NonNull() String key)
+ getDouble(@NonNull() String key)
abstract String
+ abstract String
getString(@NonNull() String key)
+ getString(@NonNull() String key)
abstract Array<byte>
getBytes(@NonNull() String key)
+ getBytes(@NonNull() String key)
abstract Map<String, Object>
+ abstract Map<String, Object>
asMap()
@Nullable() abstract Double getDouble(@NonNull() String key)+
@Nullable() abstract Double getDouble(@NonNull() String key)
The Double value from the CustomAttribute list.
@Nullable() abstract String getString(@NonNull() String key)+
@Nullable() abstract String getString(@NonNull() String key)
The textual value from the CustomAttribute list.
@Nullable() abstract Array<byte> getBytes(@NonNull() String key)+
@Nullable() abstract Array<byte> getBytes(@NonNull() String key)
The byte[] value from the CustomAttribute list.
@Nullable() abstract Map<String, Object> asMap()+
@Nullable() abstract Map<String, Object> asMap()
The CustomAttribute list as a Map.
abstract String
+ abstract String
getAttributeClass()
abstract Date
+ abstract Date
getStartDate()
abstract Date
+ abstract Date
getEndDate()
abstract Double
+ abstract Double
getDuration()
abstract Double
+ abstract Double
getPlannedDuration()
@Nullable() abstract String getAttributeClass()+
@Nullable() abstract String getAttributeClass()
The class of the date range cue.
@NonNull() abstract Date getStartDate()+
@NonNull() abstract Date getStartDate()
The playback position at which the date range cue becomes active, as a Date.
@Nullable() abstract Date getEndDate()+
@Nullable() abstract Date getEndDate()
The playback position at which the date range cue becomes inactive, as a Date.
@Nullable() abstract Double getDuration()+
@Nullable() abstract Double getDuration()
The duration of the date range cue.
@Nullable() abstract Double getPlannedDuration()+
@Nullable() abstract Double getPlannedDuration()
The planned duration of the date range cue, in seconds.
abstract String
+ abstract String
getId()
@NonNull() abstract String getId()+
@NonNull() abstract String getId()
The identifier of the cue. (NonNull)
private final Stringprivate final Stringurlprivate final Stringprivate final StringmimeTypeprivate final Byteprivate final BytepictureTypeprivate final Stringprivate final Stringdescriptionprivate final Stringprivate final StringidID3Frame.AttachedPicture(String id, String mimeType, Byte pictureType, String description, ByteArray data)final String
+ final String
getUrl()
final String
+ final String
getMimeType()
final Byte
+ final Byte
getPictureType()
final String
+ final String
getDescription()
ID3Frame.AttachedPicture(String id, String mimeType, Byte pictureType, String description, ByteArray data)+
ID3Frame.AttachedPicture(String id, String mimeType, Byte pictureType, String description, ByteArray data)
final String getUrl()+
final String getUrl()
final String getMimeType()+
final String getMimeType()
The MIME type of the attached picture.
final Byte getPictureType()+
final Byte getPictureType()
The type of the attached picture.
final String getDescription()+
final String getDescription()
The description of the attached picture.
private final Stringprivate final StringelementIdprivate final Integerprivate final IntegerstartTimeMsprivate final Integerprivate final IntegerendTimeMsprivate final Longprivate final LongstartOffsetprivate final Longprivate final LongendOffsetprivate final List<ID3Frame>private final List<ID3Frame>subFramesprivate final Stringprivate final StringidID3Frame.Chapter(String elementId, Integer startTimeMs, Integer endTimeMs, Long startOffset, Long endOffset, List<ID3Frame> subFrames)final String
+ final String
getElementId()
final Integer
+ final Integer
getStartTimeMs()
final Integer
+ final Integer
getEndTimeMs()
final Long
+ final Long
getStartOffset()
final Long
+ final Long
getEndOffset()
final List<ID3Frame>
+ final List<ID3Frame>
getSubFrames()
ID3Frame.Chapter(String elementId, Integer startTimeMs, Integer endTimeMs, Long startOffset, Long endOffset, List<ID3Frame> subFrames)+
ID3Frame.Chapter(String elementId, Integer startTimeMs, Integer endTimeMs, Long startOffset, Long endOffset, List<ID3Frame> subFrames)
final String getElementId()+
final String getElementId()
The unique identifier for this chapter.
final Integer getStartTimeMs()+
final Integer getStartTimeMs()
The start time of the chapter, in milliseconds from the beginning of the file.
final Integer getEndTimeMs()+
final Integer getEndTimeMs()
The end time of the chapter, in milliseconds from the beginning of the file.
final Long getStartOffset()+
final Long getStartOffset()
The offset of the first byte of the first audio frame in this chapter, in bytes from the beginning of the file.
final Long getEndOffset()+
final Long getEndOffset()
The offset of the first byte of the audio frame following this chapter, in bytes from the beginning of the file.
final List<ID3Frame> getSubFrames()+
final List<ID3Frame> getSubFrames()
The sub-frames describing this chapter.
private final Stringprivate final StringelementIdprivate final Booleanprivate final BooleanisTopLevelprivate final Booleanprivate final BooleanisOrderedprivate final List<String>private final List<String>childrenprivate final List<ID3Frame>private final List<ID3Frame>subFramesprivate final Stringprivate final StringidID3Frame.ChapterToc(String elementId, Boolean isTopLevel, Boolean isOrdered, List<String> children, List<ID3Frame> subFrames)final String
+ final String
getElementId()
final Boolean
+ final Boolean
isTopLevel()
final Boolean
+ final Boolean
isOrdered()
final List<String>
+ final List<String>
getChildren()
final List<ID3Frame>
+ final List<ID3Frame>
getSubFrames()
ID3Frame.ChapterToc(String elementId, Boolean isTopLevel, Boolean isOrdered, List<String> children, List<ID3Frame> subFrames)+
ID3Frame.ChapterToc(String elementId, Boolean isTopLevel, Boolean isOrdered, List<String> children, List<ID3Frame> subFrames)
final String getElementId()+
final String getElementId()
The unique identifier for this chapter table of contents.
final Boolean isTopLevel()+
final Boolean isTopLevel()
Whether this is the root of the table of contents tree, and not a child of any other ChapterToc frame.
final Boolean isOrdered()+
final Boolean isOrdered()
Whether the list of children is ordered.
final List<String> getChildren()+
final List<String> getChildren()
The list of child element IDs. See Chapter.elementId and ChapterToc.elementId.
final List<ID3Frame> getSubFrames()+
final List<ID3Frame> getSubFrames()
The sub-frames describing this table of contents.
private final Stringprivate final Stringlanguageprivate final Stringprivate final Stringdescriptionprivate final Stringprivate final Stringtextprivate final Stringprivate final StringidID3Frame.Comments(String id, String language, String description, String text)final String
+ final String
getLanguage()
final String
+ final String
getDescription()
final String
+ final String
getText()
ID3Frame.Comments(String id, String language, String description, String text)+
ID3Frame.Comments(String id, String language, String description, String text)
final String getLanguage()+
final String getLanguage()
The language of the comments.
final String getDescription()+
final String getDescription()
The description of the comments.
final String getText()+
final String getText()
The content of the comments.
private final Stringprivate final StringmimeTypeprivate final Stringprivate final StringfileNameprivate final Stringprivate final Stringdescriptionprivate final Stringprivate final StringidID3Frame.GeneralEncapsulatedObject(String id, String mimeType, String fileName, String description, ByteArray data)final String
+ final String
getMimeType()
final String
+ final String
getFileName()
final String
+ final String
getDescription()
ID3Frame.GeneralEncapsulatedObject(String id, String mimeType, String fileName, String description, ByteArray data)+
ID3Frame.GeneralEncapsulatedObject(String id, String mimeType, String fileName, String description, ByteArray data)
final String getMimeType()+
final String getMimeType()
The MIME type of the encapsulated object.
final String getFileName()+
final String getFileName()
The file name of the encapsulated object.
final String getDescription()+
final String getDescription()
The description of the encapsulated object.
private final Stringprivate final StringownerIdentifierprivate final Stringprivate final StringidID3Frame.Private(String ownerIdentifier, ByteArray data)final String
+ final String
getOwnerIdentifier()
ID3Frame.Private(String ownerIdentifier, ByteArray data)+
ID3Frame.Private(String ownerIdentifier, ByteArray data)
final String getOwnerIdentifier()+
final String getOwnerIdentifier()
The identifier of the owner.
private final Stringprivate final Stringdescriptionprivate final Stringprivate final Stringtextprivate final Stringprivate final StringidID3Frame.Text(String id, String description, String text)final String
+ final String
getDescription()
final String
+ final String
getText()
ID3Frame.Text(String id, String description, String text)+
ID3Frame.Text(String id, String description, String text)
final String getDescription()+
final String getDescription()
The description of the text.
Only available if id is "TXX" or "TXXX".
final String getText()+
final String getText()
The text contents.
private final Stringprivate final StringidID3Frame.Unknown(String id, ByteArray data)ID3Frame.Unknown(String id, ByteArray data)+
ID3Frame.Unknown(String id, ByteArray data)
private final Stringprivate final Stringdescriptionprivate final Stringprivate final Stringurlprivate final Stringprivate final StringidID3Frame.Url(String id, String description, String url)final String
+ final String
getDescription()
final String
+ final String
getUrl()
ID3Frame.Url(String id, String description, String url)+
ID3Frame.Url(String id, String description, String url)
final String getDescription()+
final String getDescription()
The description of the URL.
Only available if id is "WXX" or "WXXX".
final String getUrl()+
final String getUrl()
The URL.
private final Stringprivate final Stringtextprivate final Stringprivate final StringidID3Frame.Yospace(String id, String text)final String
+ final String
getText()
ID3Frame.Yospace(String id, String text)+
ID3Frame.Yospace(String id, String text)
final String getText()+
final String getText()
The text contents.
private final Stringprivate final Stringidfinal String
+ final String
getId()
final String getId()+
final String getId()
The identifier of the frame.
abstract void
setKeyStore(@NonNull() KeyStore keyStore)
+ setKeyStore(@NonNull() KeyStore keyStore)
abstract void setKeyStore(@NonNull() KeyStore keyStore)+
abstract void setKeyStore(@NonNull() KeyStore keyStore)
Sets the KeyStore.
This is not supported when useHttpEngine
is set to `true`.final static AdIntegration
from(String adIntegration)
+ from(String adIntegration)
final static AdIntegration from(String adIntegration)+
final static AdIntegration from(String adIntegration)
Creates an ad integration from a textual representation.
public enum AdIntegration -extends Enum<AdIntegration> +extends Enum<AdIntegration>
The integration type of the ad break(s).
private final Stringprivate final StringadIntegrationprivate final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal AdIntegration
valueOf(String value)
+ valueOf(String value)
final String
+ final String
getAdIntegration()
final AdIntegration valueOf(String value)+
final AdIntegration valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
final String getAdIntegration()+
final String getAdIntegration()
The textual representation of the ad integration. (NonNull)
protected Map<String, String>protected Map<String, String>headersprotected Doubleprotected DoubleliveOffsetprotected Booleanprotected BooleanhlsDateRangeprotected Stringprotected StringtimeServerprotected Booleanprotected BooleanlowLatencyprotected Stringprotected Stringsrcprivate final Stringprivate final Stringsrcprivate final Map<String, String>private final Map<String, String>headersprivate final Doubleprivate final DoubleliveOffsetprivate final Booleanprivate final BooleanhlsDateRangeprivate final Stringprivate final StringtimeServerprivate final Booleanprivate final BooleanlowLatencyGoogleDaiTypedSource(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, GoogleDaiConfiguration ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)TypedSource
copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
+ copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
GoogleDaiTypedSource(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, GoogleDaiConfiguration ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)+
GoogleDaiTypedSource(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, GoogleDaiConfiguration ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
TypedSource copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)+
TypedSource copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
Creates a new TypedSource with the same properties as this source, optionally replacing specific properties with the given values.
private final Integerprivate final IntegermaxBitrateprivate final List<String>private final List<String>preferredVideoCodecsprivate final List<String>private final List<String>preferredAudioCodecsSourceAbrConfiguration(Integer maxBitrate, List<String> preferredVideoCodecs, List<String> preferredAudioCodecs)SourceAbrConfiguration(Integer maxBitrate, List<String> preferredVideoCodecs)SourceAbrConfiguration(Integer maxBitrate)final Integer
+ final Integer
getMaxBitrate()
final List<String>
+ final List<String>
getPreferredVideoCodecs()
final List<String>
+ final List<String>
getPreferredAudioCodecs()
SourceAbrConfiguration(Integer maxBitrate, List<String> preferredVideoCodecs, List<String> preferredAudioCodecs)+
SourceAbrConfiguration(Integer maxBitrate, List<String> preferredVideoCodecs, List<String> preferredAudioCodecs)
SourceAbrConfiguration(Integer maxBitrate, List<String> preferredVideoCodecs)+
SourceAbrConfiguration(Integer maxBitrate, List<String> preferredVideoCodecs)
SourceAbrConfiguration(Integer maxBitrate)+
SourceAbrConfiguration(Integer maxBitrate)
final Integer getMaxBitrate()+
final Integer getMaxBitrate()
The maximum bitrate in bps for the specified source.
final List<String> getPreferredVideoCodecs()+
final List<String> getPreferredVideoCodecs()
The video codecs to prefer, in order of preference. (Nullable)
Codecs are specified by their RFC 6381 name, e.g. "hvc1", "dvh1" or "avc1". Variant streams using a preferred codec are selected over variant streams that do not, as long as the device supports them.
By default, Dolby Vision and HEVC are preferred over other codecs. Set an empty list to disable any codec preference.
final List<String> getPreferredAudioCodecs()+
final List<String> getPreferredAudioCodecs()
The audio codecs to prefer, in order of preference. (Nullable)
Codecs are specified by their RFC 6381 name, e.g. "ec-3" or "mp4a.40.2".
SourceDescription.Builder(String sources)final SourceDescription.Builder
textTracks(String textTracks)
+ textTracks(String textTracks)
final SourceDescription.Builder
poster(String poster)
+ poster(String poster)
final SourceDescription.Builder
timeServer(String timeServer)
+ timeServer(String timeServer)
SourceDescription.Builder(String sources)+
SourceDescription.Builder(String sources)
final SourceDescription.Builder textTracks(String textTracks)+
final SourceDescription.Builder textTracks(String textTracks)
Sets the text tracks of the SourceDescription.
final SourceDescription.Builder poster(String poster)+
final SourceDescription.Builder poster(String poster)
Sets the poster image of the SourceDescription.
final SourceDescription.Builder timeServer(String timeServer)+
final SourceDescription.Builder timeServer(String timeServer)
Sets the URL of a time server used by the player to synchronise the time in DASH sources.
The time server should return time in ISO-8601 format.
Overrides the time server provided the DASH manifest's <UTCTiming>.
All sources will use the time server. Alternatively, for using it for a single source use TypedSource.timeServer.
private final List<TypedSource>private final List<TypedSource>sourcesprivate final List<AdDescription>private final List<AdDescription>adsprivate final List<TextTrackDescription>private final List<TextTrackDescription>textTracksprivate final Stringprivate final Stringposterprivate final Stringprivate final StringtimeServerSourceDescription(List<TypedSource> sources, List<AdDescription> ads, List<TextTrackDescription> textTracks, String poster, MetadataDescription metadata, String timeServer, SourceAbrConfiguration abr, StreamType streamType, SourceDVRConfiguration dvr, CMCDSourceConfiguration cmcd)final List<TypedSource>
+ final List<TypedSource>
getSources()
final List<AdDescription>
+ final List<AdDescription>
getAds()
final List<TextTrackDescription>
+ final List<TextTrackDescription>
getTextTracks()
final String
+ final String
getPoster()
final String
+ final String
getTimeServer()
SourceDescription(List<TypedSource> sources, List<AdDescription> ads, List<TextTrackDescription> textTracks, String poster, MetadataDescription metadata, String timeServer, SourceAbrConfiguration abr, StreamType streamType, SourceDVRConfiguration dvr, CMCDSourceConfiguration cmcd)+
SourceDescription(List<TypedSource> sources, List<AdDescription> ads, List<TextTrackDescription> textTracks, String poster, MetadataDescription metadata, String timeServer, SourceAbrConfiguration abr, StreamType streamType, SourceDVRConfiguration dvr, CMCDSourceConfiguration cmcd)
final List<TypedSource> getSources()+
final List<TypedSource> getSources()
List of TypedSources that represent the available sources in this SourceDescription. (NonNull)
The first element of the list will initially be used as the player’s source.
When that source is unavailable, the player will fall back to the other elements of this list.
final List<AdDescription> getAds()+
final List<AdDescription> getAds()
List of AdDescriptions of the source. (NonNull)
All valid and supported advertisement files will be cued for playback in the player following the provided advertisement specification.
Each ad in the list should be described as an AdDescription.
final List<TextTrackDescription> getTextTracks()+
final List<TextTrackDescription> getTextTracks()
List of side-loaded text tracks of the source. (NonNull)
All valid tracks will be available during playback.
Each text track should be described as a TextTrackDescription.
final String getPoster()+
final String getPoster()
The poster image url of this source description. (Nullable)
A placeholder for the content between the time that the content has loaded and the user presses play.
final String getTimeServer()+
final String getTimeServer()
The URL of the time server. (Nullable)
The time server should return time in ISO-8601 format.
Applies for all sources.
public enum SourceType -extends Enum<SourceType> +extends Enum<SourceType>
The types of sources.
private final Stringprivate final StringmimeTypeprivate final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal SourceType
valueOf(String value)
+ valueOf(String value)
final String
+ final String
getMimeType()
final SourceType valueOf(String value)+
final SourceType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
final String getMimeType()+
final String getMimeType()
public enum StreamType -extends Enum<StreamType> +extends Enum<StreamType>
The type of a stream.
private final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal Boolean
+ final Boolean
isLive()
final StreamType
valueOf(String value)
+ valueOf(String value)
final Boolean isLive()+
final Boolean isLive()
Whether this is a live stream (with or without DVR).
final StreamType valueOf(String value)+
final StreamType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
TextTrackDescription.Builder(String src)final TextTrackDescription.Builder
isDefault(Boolean isDefault)
+ isDefault(Boolean isDefault)
final TextTrackDescription.Builder
srclang(String srclang)
+ srclang(String srclang)
final TextTrackDescription.Builder
label(String label)
+ label(String label)
TextTrackDescription.Builder(String src)+
TextTrackDescription.Builder(String src)
final TextTrackDescription.Builder isDefault(Boolean isDefault)+
final TextTrackDescription.Builder isDefault(Boolean isDefault)
Sets whether this text track is the default one.
final TextTrackDescription.Builder srclang(String srclang)+
final TextTrackDescription.Builder srclang(String srclang)
Sets the main language.
final TextTrackDescription.Builder label(String label)+
final TextTrackDescription.Builder label(String label)
Sets the label for the track which can be used to identify it.
private final Stringprivate final Stringsrcprivate final Booleanprivate final BooleanisDefaultprivate final Stringprivate final Stringsrclangprivate final Stringprivate final StringlabelTextTrackDescription(String src, Boolean isDefault, TextTrackKind kind, String srclang, String label, TextTrackType format)final String
+ final String
getSrc()
final Boolean
+ final Boolean
isDefault()
final String
+ final String
getSrclang()
final String
+ final String
getLabel()
TextTrackDescription(String src, Boolean isDefault, TextTrackKind kind, String srclang, String label, TextTrackType format)+
TextTrackDescription(String src, Boolean isDefault, TextTrackKind kind, String srclang, String label, TextTrackType format)
final String getSrc()+
final String getSrc()
The source URL where the text track can be downloaded from. (NonNull)
final Boolean isDefault()+
final Boolean isDefault()
Returns whether this textTrack is the default text track.
final String getSrclang()+
final String getSrclang()
The main language of the track. (Nullable)
final String getLabel()+
final String getLabel()
The label for the track which can be used to identify it. (Nullable)
protected Map<String, String>protected Map<String, String>headersprotected Doubleprotected DoubleliveOffsetprotected Booleanprotected BooleanhlsDateRangeprotected Stringprotected StringtimeServerprotected Booleanprotected BooleanlowLatencyprotected Stringprotected StringsrcTypedSource.Builder(String src)final <Error class: unknown class>
headers(Map<String, String> headers)
+ headers(Map<String, String> headers)
final <Error class: unknown class>
liveOffset(Double liveOffset)
+ liveOffset(Double liveOffset)
final <Error class: unknown class>
hlsDateRange(Boolean hlsDateRange)
+ hlsDateRange(Boolean hlsDateRange)
final <Error class: unknown class>
timeServer(String timeServer)
+ timeServer(String timeServer)
final <Error class: unknown class>
lowLatency(Boolean lowLatency)
+ lowLatency(Boolean lowLatency)
TypedSource.Builder(String src)+
TypedSource.Builder(String src)
final <Error class: unknown class> headers(Map<String, String> headers)+
final <Error class: unknown class> headers(Map<String, String> headers)
Sets the headers to be added to all requests associated with this source.
Only supported for MP3 & MP4 sources.
final <Error class: unknown class> liveOffset(Double liveOffset)+
final <Error class: unknown class> liveOffset(Double liveOffset)
Sets the live point from the end of the manifest, in seconds.
If set as null, the live point offset will be 3 target durations.
final <Error class: unknown class> hlsDateRange(Boolean hlsDateRange)+
final <Error class: unknown class> hlsDateRange(Boolean hlsDateRange)
Sets whether the logic to expose date ranges parsed from HLS manifests is enabled.
If not set, TypedSource.hlsDateRange will be null.
final <Error class: unknown class> timeServer(String timeServer)+
final <Error class: unknown class> timeServer(String timeServer)
Sets the URL of a time server used by the player to synchronise the time in DASH sources.
The time server should return time in ISO-8601 format.
Overrides the time server provided the DASH manifest's <UTCTiming>.
Only this source will use the time server. Alternatively, for all sources use SourceDescription.Builder.timeServer.
final <Error class: unknown class> lowLatency(Boolean lowLatency)+
final <Error class: unknown class> lowLatency(Boolean lowLatency)
Sets whether the source should be played in the low-latency-mode of the player.
This setting must be true when using Low-Latency CMAF with ABR.
Default: false
private final Stringprivate final Stringsrcprivate final Map<String, String>private final Map<String, String>headersprivate final Doubleprivate final DoubleliveOffsetprivate final Booleanprivate final BooleanhlsDateRangeprivate final Stringprivate final StringtimeServerprivate final Booleanprivate final BooleanlowLatencyTypedSource(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, HespPlaybackConfiguration hesp, CMCDTransmissionMode cmcdTransmissionMode)final String
+ final String
getSrc()
final Map<String, String>
+ final Map<String, String>
getHeaders()
final Double
+ final Double
getLiveOffset()
final Boolean
+ final Boolean
isHlsDateRange()
final String
+ final String
getTimeServer()
final Boolean
+ final Boolean
isLowLatency()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
TypedSource
copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
+ copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
TypedSource(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, HespPlaybackConfiguration hesp, CMCDTransmissionMode cmcdTransmissionMode)+
TypedSource(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, HespPlaybackConfiguration hesp, CMCDTransmissionMode cmcdTransmissionMode)
final String getSrc()+
final String getSrc()
The source URL of the manifest or video file to be played. (NonNull)
final Map<String, String> getHeaders()+
final Map<String, String> getHeaders()
The headers of the source.
final Double getLiveOffset()+
final Double getLiveOffset()
The live point from the end of the manifest, in seconds. (Nullable)
Will return null if the live point offset is 3 target durations.
final Boolean isHlsDateRange()+
final Boolean isHlsDateRange()
Whether the logic to expose date ranges parsed from HLS manifests is enabled. (Nullable)
Can be null if this property is not set.
If not set, this will use the value of THEOplayerConfig.hlsDateRange.
final String getTimeServer()+
final String getTimeServer()
The URL of the time server. (Nullable)
The time server should return time in ISO-8601 format.
Only applies to the current source.
final Boolean isLowLatency()+
final Boolean isLowLatency()
Whether the source should be played in the low-latency-mode of the player. (Nullable)
Can be null if this property is not set.
Only applicable to live content.
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
TypedSource copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)+
TypedSource copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
Creates a new TypedSource with the same properties as this source, optionally replacing specific properties with the given values.
private final Stringprivate final StringcustomIntegrationCustomAdDescription(String customIntegration)final String
+ final String
getCustomIntegration()
CustomAdDescription(String customIntegration)+
CustomAdDescription(String customIntegration)
final String getCustomIntegration()+
final String getCustomIntegration()
final static Unit
register(String customIntegration, CustomAdDescriptionSerializer serializer)
+ register(String customIntegration, CustomAdDescriptionSerializer serializer)
final static CustomAdDescription
deserialize(String integrationId, String json)
+ deserialize(String integrationId, String json)
final static String
+ final static String
serialize(CustomAdDescription value)
final static Unit register(String customIntegration, CustomAdDescriptionSerializer serializer)+
final static Unit register(String customIntegration, CustomAdDescriptionSerializer serializer)
Register the given serializer to handle CustomAdDescription objects with the given integration ID.
final static CustomAdDescription deserialize(String integrationId, String json)+
final static CustomAdDescription deserialize(String integrationId, String json)
Deserialize an CustomAdDescription of the given integration ID from the given JSON string.
final static String serialize(CustomAdDescription value)+
final static String serialize(CustomAdDescription value)
Serialize the given CustomAdDescription to a JSON string.
abstract CustomAdDescription
fromJson(String json)
+ fromJson(String json)
abstract String
+ abstract String
toJson(CustomAdDescription value)
abstract CustomAdDescription fromJson(String json)+
abstract CustomAdDescription fromJson(String json)
Reads an CustomAdDescription from the given JSON string.
The customIntegration property of the returned object must match the integration with which this serializer was registered.
abstract String toJson(CustomAdDescription value)+
abstract String toJson(CustomAdDescription value)
Writes the given CustomAdDescription as a JSON string.
The returned JSON string must have a string property named "integration" that contains value's customIntegration.
GoogleImaAdDescription.Builder(String sources)final GoogleImaAdDescription.Builder
timeOffset(String timeOffset)
+ timeOffset(String timeOffset)
GoogleImaAdDescription.Builder(String sources)+
GoogleImaAdDescription.Builder(String sources)
final GoogleImaAdDescription.Builder timeOffset(String timeOffset)+
final GoogleImaAdDescription.Builder timeOffset(String timeOffset)
Sets the offset after which the ad break will start.
Possible formats:
A number for the offset in seconds.
A percentage string (XX%) for a proportion of the content duration.
A time-description specifying "start" or "end".
A timestamp of the format: 00:00:10.000.
private final Stringprivate final Stringsourcesprivate final Stringprivate final StringtimeOffsetGoogleImaAdDescription(String sources, String timeOffset)final String
+ final String
getSources()
final String
+ final String
getTimeOffset()
GoogleImaAdDescription(String sources, String timeOffset)+
GoogleImaAdDescription(String sources, String timeOffset)
final String getSources()+
final String getSources()
The URI which contains the location of the ad resources to be scheduled. (NonNull)
This should not be an array of sources.
VPAID support is limited to the Google IMA integration.
final String getTimeOffset()+
final String getTimeOffset()
The offset after which the ad break will start. (Nullable)
VMAP resources will ignore this value as they contain offsets. VMAP resources should be scheduled at the start of the content.
Possible formats:
A number for the offset in seconds.
A percentage string (XX%) for a proportion of the content duration.
A time-description specifying "start" or "end".
A timestamp of the format: 00:00:10.000.
final DashPlaybackConfiguration.Builder
ignoreAvailabilityWindow(Boolean ignoreAvailabilityWindow)
+ ignoreAvailabilityWindow(Boolean ignoreAvailabilityWindow)
final DashPlaybackConfiguration.Builder ignoreAvailabilityWindow(Boolean ignoreAvailabilityWindow)+
final DashPlaybackConfiguration.Builder ignoreAvailabilityWindow(Boolean ignoreAvailabilityWindow)
Set this to force the player to ignore the availability window of individual segments in the MPD, and instead consider every listed segment to be immediately available.
Available since v5.2.0.
This only applies to livestreams (with <MPD type="dynamic">).
This only applies to streams that use <SegmentTimeline>.
private final Booleanprivate final BooleanignoreAvailabilityWindowDashPlaybackConfiguration(Boolean ignoreAvailabilityWindow)final Boolean
+ final Boolean
getIgnoreAvailabilityWindow()
DashPlaybackConfiguration(Boolean ignoreAvailabilityWindow)+
DashPlaybackConfiguration(Boolean ignoreAvailabilityWindow)
final Boolean getIgnoreAvailabilityWindow()+
final Boolean getIgnoreAvailabilityWindow()
Whether the player will forcefully ignore the availability window of individual segments in the MPD, and instead consider every listed segment to be immediately available.
Available since v5.2.0.
This only applies to livestreams (with <MPD type="dynamic">).
This only applies to streams that use <SegmentTimeline>.
ClearkeyKeySystemConfiguration.Builder(String licenseAcquisitionURL)final <Error class: unknown class>
headers(Map<String, String> headers)
+ headers(Map<String, String> headers)
final <Error class: unknown class>
useCredentials(Boolean useCredentials)
+ useCredentials(Boolean useCredentials)
final <Error class: unknown class>
queryParameters(Map<String, String> queryParameters)
+ queryParameters(Map<String, String> queryParameters)
final <Error class: unknown class>
integrationParameters(Map<String, Object> integrationParameters)
+ integrationParameters(Map<String, Object> integrationParameters)
ClearkeyKeySystemConfiguration.Builder(String licenseAcquisitionURL)+
ClearkeyKeySystemConfiguration.Builder(String licenseAcquisitionURL)
final <Error class: unknown class> headers(Map<String, String> headers)+
final <Error class: unknown class> headers(Map<String, String> headers)
Sets the map of HTTP headers for the license acquisition request.
final <Error class: unknown class> useCredentials(Boolean useCredentials)+
final <Error class: unknown class> useCredentials(Boolean useCredentials)
Sets whether the player is allowed to use credentials for cross-origin requests.
final <Error class: unknown class> queryParameters(Map<String, String> queryParameters)+
final <Error class: unknown class> queryParameters(Map<String, String> queryParameters)
Sets the map of query parameters for the license acquisition request.
final <Error class: unknown class> integrationParameters(Map<String, Object> integrationParameters)+
final <Error class: unknown class> integrationParameters(Map<String, Object> integrationParameters)
Sets the integration-specific parameters to be used by a ContentProtectionIntegration.
private final Stringprivate final Stringidprivate final Stringprivate final StringvalueClearkeyKeySystemConfiguration.ClearkeyDecryptionKey(String id, String value)final String
+ final String
getId()
final String
+ final String
getValue()
ClearkeyKeySystemConfiguration.ClearkeyDecryptionKey(String id, String value)+
ClearkeyKeySystemConfiguration.ClearkeyDecryptionKey(String id, String value)
final String getId()+
final String getId()
The identifier of the key. (NonNull)
This is a base64url encoding of the octet sequence containing the key identifier.
See Clear Key License Format for more information.
final String getValue()+
final String getValue()
The value of the key. (NonNull)
The base64url encoding of the octet sequence containing the symmetric key value.
See Clear Key License Format for more information.
private final Stringprivate final StringlicenseAcquisitionURLprivate final Map<String, String>private final Map<String, String>headersprivate final Booleanprivate final BooleanuseCredentialsprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanforceSoftwareDecryptprivate final Map<String, Object>private final Map<String, Object>integrationParametersClearkeyKeySystemConfiguration(String licenseAcquisitionURL, Array<ClearkeyKeySystemConfiguration.ClearkeyDecryptionKey> keys, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, Map<String, Object> integrationParameters)Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
ClearkeyKeySystemConfiguration(String licenseAcquisitionURL, Array<ClearkeyKeySystemConfiguration.ClearkeyDecryptionKey> keys, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, Map<String, Object> integrationParameters)+
ClearkeyKeySystemConfiguration(String licenseAcquisitionURL, Array<ClearkeyKeySystemConfiguration.ClearkeyDecryptionKey> keys, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, Map<String, Object> integrationParameters)
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
final <Error class: unknown class>
customIntegrationId(String integrationId)
+ customIntegrationId(String integrationId)
final <Error class: unknown class>
integrationParameters(Map<String, Object> integrationParameters)
+ integrationParameters(Map<String, Object> integrationParameters)
final <Error class: unknown class>
queryParameters(Map<String, String> queryParameters)
+ queryParameters(Map<String, String> queryParameters)
final <Error class: unknown class>
multiSession(Boolean multiSession)
+ multiSession(Boolean multiSession)
final <Error class: unknown class>
preferredKeySystems(List<KeySystemId> preferredKeySystems)
+ preferredKeySystems(List<KeySystemId> preferredKeySystems)
final <Error class: unknown class> customIntegrationId(String integrationId)+
final <Error class: unknown class> customIntegrationId(String integrationId)
Sets the identifier of the DRM integration.
final <Error class: unknown class> integrationParameters(Map<String, Object> integrationParameters)+
final <Error class: unknown class> integrationParameters(Map<String, Object> integrationParameters)
Sets the integration-specific parameters to be used by a ContentProtectionIntegration.
final <Error class: unknown class> queryParameters(Map<String, String> queryParameters)+
final <Error class: unknown class> queryParameters(Map<String, String> queryParameters)
Sets the default query parameters for all DRM requests.
final <Error class: unknown class> multiSession(Boolean multiSession)+
final <Error class: unknown class> multiSession(Boolean multiSession)
Sets whether multi-session is enabled for this DRM configuration.
final <Error class: unknown class> preferredKeySystems(List<KeySystemId> preferredKeySystems)+
final <Error class: unknown class> preferredKeySystems(List<KeySystemId> preferredKeySystems)
Sets the key systems to try first, in order of preference.
private final Stringprivate final StringcustomIntegrationIdprivate final Map<String, Object>private final Map<String, Object>integrationParametersprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanmultiSessionprivate final List<KeySystemId>private final List<KeySystemId>preferredKeySystemsDRMConfiguration(KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay, String customIntegrationId, Map<String, Object> integrationParameters, Map<String, String> queryParameters, Boolean multiSession, List<KeySystemId> preferredKeySystems)DRMConfiguration(KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay, DRMIntegrationId integration, String customIntegrationId, Map<String, Object> integrationParameters, Map<String, String> queryParameters, Boolean multiSession, List<KeySystemId> preferredKeySystems)final String
+ final String
getCustomIntegrationId()
final Map<String, Object>
+ final Map<String, Object>
getIntegrationParameters()
final Map<String, String>
+ final Map<String, String>
getQueryParameters()
final Boolean
+ final Boolean
isMultiSession()
final List<KeySystemId>
+ final List<KeySystemId>
getPreferredKeySystems()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
final DRMConfiguration
copy(KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay, DRMIntegrationId integration, String customIntegrationId, Map<String, Object> integrationParameters, Map<String, String> queryParameters, Boolean multiSession, List<KeySystemId> preferredKeySystems)
+ copy(KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay, DRMIntegrationId integration, String customIntegrationId, Map<String, Object> integrationParameters, Map<String, String> queryParameters, Boolean multiSession, List<KeySystemId> preferredKeySystems)
DRMConfiguration(KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay, String customIntegrationId, Map<String, Object> integrationParameters, Map<String, String> queryParameters, Boolean multiSession, List<KeySystemId> preferredKeySystems)+
DRMConfiguration(KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay, String customIntegrationId, Map<String, Object> integrationParameters, Map<String, String> queryParameters, Boolean multiSession, List<KeySystemId> preferredKeySystems)
DRMConfiguration(KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay, DRMIntegrationId integration, String customIntegrationId, Map<String, Object> integrationParameters, Map<String, String> queryParameters, Boolean multiSession, List<KeySystemId> preferredKeySystems)+
DRMConfiguration(KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay, DRMIntegrationId integration, String customIntegrationId, Map<String, Object> integrationParameters, Map<String, String> queryParameters, Boolean multiSession, List<KeySystemId> preferredKeySystems)
final String getCustomIntegrationId()+
final String getCustomIntegrationId()
The custom integration identifier of the DRM integration. (Nullable)
final Map<String, Object> getIntegrationParameters()+
final Map<String, Object> getIntegrationParameters()
The integration-specific parameters to be used by a ContentProtectionIntegration.
final Map<String, String> getQueryParameters()+
final Map<String, String> getQueryParameters()
The default query parameters for all DRM requests. (NonNull)
These query parameters will be applied to all license and certificate requests for this DRM configuration. They will be merged with key system-specific query parameters, with key system-specific parameters taking precedence.
final Boolean isMultiSession()+
final Boolean isMultiSession()
Sets whether multi-session is enabled for this DRM configuration. (Nullable)
Set to false when a single key request will obtain all keys required to decrypt the stream.
Set to true when a different key request is needed for different qualities of the stream, or when the stream uses key rotation.
Default: false.
final List<KeySystemId> getPreferredKeySystems()+
final List<KeySystemId> getPreferredKeySystems()
The key systems to try first, in order of preference. (Nullable)
Key systems not in this list are tried afterwards, in the default order. The first preferred key system that is both configured and supported by the device is used.
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
final DRMConfiguration copy(KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay, DRMIntegrationId integration, String customIntegrationId, Map<String, Object> integrationParameters, Map<String, String> queryParameters, Boolean multiSession, List<KeySystemId> preferredKeySystems)+
final DRMConfiguration copy(KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay, DRMIntegrationId integration, String customIntegrationId, Map<String, Object> integrationParameters, Map<String, String> queryParameters, Boolean multiSession, List<KeySystemId> preferredKeySystems)
Creates a new DRMConfiguration with the same properties as this configuration, optionally replacing specific properties with the given values.
final static DRMIntegrationId
from(String integrationId)
+ from(String integrationId)
final static DRMIntegrationId from(String integrationId)+
final static DRMIntegrationId from(String integrationId)
Creates a DRM integration identifier from a textual representation.
public enum DRMIntegrationId -extends Enum<DRMIntegrationId> +extends Enum<DRMIntegrationId>
The identifier of a DRM integration.
private final Stringprivate final StringintegrationIdprivate final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal DRMIntegrationId
valueOf(String value)
+ valueOf(String value)
final String
+ final String
getIntegrationId()
final DRMIntegrationId valueOf(String value)+
final DRMIntegrationId valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
final String getIntegrationId()+
final String getIntegrationId()
The textual representation of the DRM integration identifier. (NonNull)
FairPlayKeySystemConfiguration.Builder(String licenseAcquisitionURL, String certificateURL)final <Error class: unknown class>
headers(Map<String, String> headers)
+ headers(Map<String, String> headers)
final <Error class: unknown class>
useCredentials(Boolean useCredentials)
+ useCredentials(Boolean useCredentials)
final <Error class: unknown class>
queryParameters(Map<String, String> queryParameters)
+ queryParameters(Map<String, String> queryParameters)
final <Error class: unknown class>
integrationParameters(Map<String, Object> integrationParameters)
+ integrationParameters(Map<String, Object> integrationParameters)
FairPlayKeySystemConfiguration.Builder(String licenseAcquisitionURL, String certificateURL)+
FairPlayKeySystemConfiguration.Builder(String licenseAcquisitionURL, String certificateURL)
final <Error class: unknown class> headers(Map<String, String> headers)+
final <Error class: unknown class> headers(Map<String, String> headers)
Sets the map of HTTP headers for the license acquisition request.
final <Error class: unknown class> useCredentials(Boolean useCredentials)+
final <Error class: unknown class> useCredentials(Boolean useCredentials)
Sets whether the player is allowed to use credentials for cross-origin requests.
final <Error class: unknown class> queryParameters(Map<String, String> queryParameters)+
final <Error class: unknown class> queryParameters(Map<String, String> queryParameters)
Sets the map of query parameters for the license acquisition request.
final <Error class: unknown class> integrationParameters(Map<String, Object> integrationParameters)+
final <Error class: unknown class> integrationParameters(Map<String, Object> integrationParameters)
Sets the integration-specific parameters to be used by a ContentProtectionIntegration.
private final Stringprivate final StringcertificateURLprivate final Stringprivate final StringlicenseAcquisitionURLprivate final Map<String, String>private final Map<String, String>headersprivate final Booleanprivate final BooleanuseCredentialsprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanforceSoftwareDecryptprivate final Map<String, Object>private final Map<String, Object>integrationParametersFairPlayKeySystemConfiguration(String licenseAcquisitionURL, String certificateURL, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, Map<String, Object> integrationParameters)final String
+ final String
getCertificateURL()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
FairPlayKeySystemConfiguration(String licenseAcquisitionURL, String certificateURL, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, Map<String, Object> integrationParameters)+
FairPlayKeySystemConfiguration(String licenseAcquisitionURL, String certificateURL, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, Map<String, Object> integrationParameters)
final String getCertificateURL()+
final String getCertificateURL()
The URL of the certificate. (NonNull)
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
KeySystemConfiguration.Builder(String licenseAcquisitionURL)final <Error class: unknown class>
headers(Map<String, String> headers)
+ headers(Map<String, String> headers)
final <Error class: unknown class>
useCredentials(Boolean useCredentials)
+ useCredentials(Boolean useCredentials)
final <Error class: unknown class>
queryParameters(Map<String, String> queryParameters)
+ queryParameters(Map<String, String> queryParameters)
final <Error class: unknown class>
forceSoftwareDecrypt(Boolean forceSoftwareDecrypt)
+ forceSoftwareDecrypt(Boolean forceSoftwareDecrypt)
final <Error class: unknown class>
integrationParameters(Map<String, Object> integrationParameters)
+ integrationParameters(Map<String, Object> integrationParameters)
KeySystemConfiguration.Builder(String licenseAcquisitionURL)+
KeySystemConfiguration.Builder(String licenseAcquisitionURL)
final <Error class: unknown class> headers(Map<String, String> headers)+
final <Error class: unknown class> headers(Map<String, String> headers)
Sets the map of HTTP headers for the license acquisition request.
final <Error class: unknown class> useCredentials(Boolean useCredentials)+
final <Error class: unknown class> useCredentials(Boolean useCredentials)
Sets whether the player is allowed to use credentials for cross-origin requests.
final <Error class: unknown class> queryParameters(Map<String, String> queryParameters)+
final <Error class: unknown class> queryParameters(Map<String, String> queryParameters)
Sets the map of query parameters for the license acquisition request.
final <Error class: unknown class> forceSoftwareDecrypt(Boolean forceSoftwareDecrypt)+
final <Error class: unknown class> forceSoftwareDecrypt(Boolean forceSoftwareDecrypt)
Sets whether to force decryption to happen in software.
final <Error class: unknown class> integrationParameters(Map<String, Object> integrationParameters)+
final <Error class: unknown class> integrationParameters(Map<String, Object> integrationParameters)
Sets the integration-specific parameters to be used by a ContentProtectionIntegration.
private final Stringprivate final StringlicenseAcquisitionURLprivate final Map<String, String>private final Map<String, String>headersprivate final Booleanprivate final BooleanuseCredentialsprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanforceSoftwareDecryptprivate final Map<String, Object>private final Map<String, Object>integrationParametersKeySystemConfiguration(String licenseAcquisitionURL, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, LicenseType licenseType, ByteArray certificate, Boolean forceSoftwareDecrypt, Map<String, Object> integrationParameters)final String
+ final String
getLicenseAcquisitionURL()
final Map<String, String>
+ final Map<String, String>
getHeaders()
final Boolean
+ final Boolean
getUseCredentials()
final Map<String, String>
+ final Map<String, String>
getQueryParameters()
final Boolean
+ final Boolean
getForceSoftwareDecrypt()
final Map<String, Object>
+ final Map<String, Object>
getIntegrationParameters()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
final KeySystemConfiguration
copy(String licenseAcquisitionURL, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, LicenseType licenseType, ByteArray certificate, Boolean forceSoftwareDecrypt, Map<String, Object> integrationParameters)
+ copy(String licenseAcquisitionURL, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, LicenseType licenseType, ByteArray certificate, Boolean forceSoftwareDecrypt, Map<String, Object> integrationParameters)
KeySystemConfiguration(String licenseAcquisitionURL, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, LicenseType licenseType, ByteArray certificate, Boolean forceSoftwareDecrypt, Map<String, Object> integrationParameters)+
KeySystemConfiguration(String licenseAcquisitionURL, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, LicenseType licenseType, ByteArray certificate, Boolean forceSoftwareDecrypt, Map<String, Object> integrationParameters)
final String getLicenseAcquisitionURL()+
final String getLicenseAcquisitionURL()
The license acquisition URL. (NonNull)
final Map<String, String> getHeaders()+
final Map<String, String> getHeaders()
Map of HTTP headers for the license acquisition request. (NonNull)
Each entry contains a header name with associated value.
final Boolean getUseCredentials()+
final Boolean getUseCredentials()
Returns whether the player is allowed to use credentials for cross-origin requests.
Credentials are cookies, authorization headers or TLS client certificates.
Default: false
final Map<String, String> getQueryParameters()+
final Map<String, String> getQueryParameters()
The map of query parameters for the license acquisition request. (NonNull)
Each entry contains a query parameter name with associated value.
final Boolean getForceSoftwareDecrypt()+
final Boolean getForceSoftwareDecrypt()
Whether to force decryption to happen in software.
Only supported for Widevine.
If set, the player will always use Widevine L3 (even if Widevine L1 is supported).
This may prevent the player from switching to a high-definition quality, and should only be used to work around issues on specific devices.
final Map<String, Object> getIntegrationParameters()+
final Map<String, Object> getIntegrationParameters()
The integration-specific parameters to be used by a ContentProtectionIntegration.
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
final KeySystemConfiguration copy(String licenseAcquisitionURL, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, LicenseType licenseType, ByteArray certificate, Boolean forceSoftwareDecrypt, Map<String, Object> integrationParameters)+
final KeySystemConfiguration copy(String licenseAcquisitionURL, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, LicenseType licenseType, ByteArray certificate, Boolean forceSoftwareDecrypt, Map<String, Object> integrationParameters)
Creates a new KeySystemConfiguration with the same properties as this configuration, optionally replacing specific properties with the given values.
public enum LicenseType -extends Enum<LicenseType> +extends Enum<LicenseType>
The type of the license.
private final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal LicenseType
valueOf(String value)
+ valueOf(String value)
final LicenseType valueOf(String value)+
final LicenseType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
AxinomDRMConfiguration.Builder(String token)AxinomDRMConfiguration.Builder(String token)+
AxinomDRMConfiguration.Builder(String token)
private final Stringprivate final Stringtokenprivate final Stringprivate final StringcustomIntegrationIdprivate final Map<String, Object>private final Map<String, Object>integrationParametersprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanmultiSessionprivate final List<KeySystemId>private final List<KeySystemId>preferredKeySystemsAxinomDRMConfiguration(String token, KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay)final String
+ final String
getToken()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
AxinomDRMConfiguration(String token, KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay)+
AxinomDRMConfiguration(String token, KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay)
final String getToken()+
final String getToken()
The Axinom authorization token. (NonNull)
This token will be attached when the license request (custom data) is retrieved.
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
AzureDRMConfiguration.Builder(String certificateURL, String token)AzureDRMConfiguration.Builder(String certificateURL, String token)+
AzureDRMConfiguration.Builder(String certificateURL, String token)
private final Stringprivate final StringcertificateURLprivate final Stringprivate final Stringtokenprivate final Stringprivate final StringcustomIntegrationIdprivate final Map<String, Object>private final Map<String, Object>integrationParametersprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanmultiSessionprivate final List<KeySystemId>private final List<KeySystemId>preferredKeySystemsAzureDRMConfiguration(String certificateURL, String token, KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay)final String
+ final String
getCertificateURL()
final String
+ final String
getToken()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
AzureDRMConfiguration(String certificateURL, String token, KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay)+
AzureDRMConfiguration(String certificateURL, String token, KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay)
final String getCertificateURL()+
final String getCertificateURL()
The Azure certificate URL. (NonNull)
final String getToken()+
final String getToken()
The Azure Media Services Authorization Token. (NonNull)
This token will be used for the license request.
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
ConaxDRMConfiguration.Builder(String deviceId, String token)ConaxDRMConfiguration.Builder(String deviceId, String token)+
ConaxDRMConfiguration.Builder(String deviceId, String token)
private final Stringprivate final StringdeviceIdprivate final Stringprivate final Stringtokenprivate final Stringprivate final StringcustomIntegrationIdprivate final Map<String, Object>private final Map<String, Object>integrationParametersprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanmultiSessionprivate final List<KeySystemId>private final List<KeySystemId>preferredKeySystemsConaxDRMConfiguration(String deviceId, String token, KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay)final String
+ final String
getDeviceId()
final String
+ final String
getToken()
ConaxDRMConfiguration(String deviceId, String token, KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay)+
ConaxDRMConfiguration(String deviceId, String token, KeySystemConfiguration widevine, KeySystemConfiguration playready, ClearkeyKeySystemConfiguration clearkey, FairPlayKeySystemConfiguration fairplay)
final String getDeviceId()+
final String getDeviceId()
The identifier of the Conax Device. (NonNull)
This identifier will be added to the OTT Account. This is done every time the video is started to simplify the example, adding the same device twice will not result in any changes.
The portal will usually handle adding a device to an account.
final String getToken()+
final String getToken()
The Conax authorization token. (NonNull)
This token will be attached when the license request (custom data) is retrieved.
The token is valid for a limited time and can only be used once.
Usually this will be a call to the portal that is integrated with Contego.
private final Stringprivate final StringcustomIntegrationIdprivate final Map<String, Object>private final Map<String, Object>integrationParametersprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanmultiSessionprivate final List<KeySystemId>private final List<KeySystemId>preferredKeySystemsDRMTodayConfiguration.Builder(String licenseAcquisitionUrl)final <Error class: unknown class>
token(String token)
+ token(String token)
final <Error class: unknown class>
userId(String userId)
+ userId(String userId)
final <Error class: unknown class>
sessionId(String sessionId)
+ sessionId(String sessionId)
final <Error class: unknown class>
merchant(String merchant)
+ merchant(String merchant)
DRMTodayConfiguration.Builder(String licenseAcquisitionUrl)+
DRMTodayConfiguration.Builder(String licenseAcquisitionUrl)
final <Error class: unknown class> token(String token)+
final <Error class: unknown class> token(String token)
Sets the DRM Today authorization token.
final <Error class: unknown class> userId(String userId)+
final <Error class: unknown class> userId(String userId)
Sets the identifier of the user.
final <Error class: unknown class> sessionId(String sessionId)+
final <Error class: unknown class> sessionId(String sessionId)
Sets the identifier of the session.
final <Error class: unknown class> merchant(String merchant)+
final <Error class: unknown class> merchant(String merchant)
Sets the identifier of the merchant.
private final Stringprivate final Stringtokenprivate final Stringprivate final StringuserIdprivate final Stringprivate final StringsessionIdprivate final Stringprivate final Stringmerchantprivate final Stringprivate final StringcustomIntegrationIdprivate final Map<String, Object>private final Map<String, Object>integrationParametersprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanmultiSessionprivate final List<KeySystemId>private final List<KeySystemId>preferredKeySystemsDRMTodayConfiguration(String token, String userId, String sessionId, String merchant, KeySystemConfiguration widevine)final String
+ final String
getToken()
final String
+ final String
getUserId()
final String
+ final String
getSessionId()
final String
+ final String
getMerchant()
DRMTodayConfiguration(String token, String userId, String sessionId, String merchant, KeySystemConfiguration widevine)+
DRMTodayConfiguration(String token, String userId, String sessionId, String merchant, KeySystemConfiguration widevine)
final String getToken()+
final String getToken()
The DRM Today authorization token. (Nullable)
This attribute is required when you use the User Authentication Callback flow to make the license request.
final String getUserId()+
final String getUserId()
The identifier of the user. (Nullable)
This attribute is required when you use the User Authentication Callback flow to make the license request.
final String getSessionId()+
final String getSessionId()
The identifier of the session. (Nullable)
This attribute is required when you use the User Authentication Callback flow to make the license request.
final String getMerchant()+
final String getMerchant()
The identifier of the merchant. (Nullable)
This attribute is required when you use the User Authentication Callback flow to make the license request.
IrdetoConfiguration.Builder(String licenseAcquisitionUrl)final <Error class: unknown class>
crmId(String crmId)
+ crmId(String crmId)
final <Error class: unknown class>
accountId(String accountId)
+ accountId(String accountId)
final <Error class: unknown class>
sessionId(String sessionId)
+ sessionId(String sessionId)
final <Error class: unknown class>
contentId(String contentId)
+ contentId(String contentId)
final <Error class: unknown class>
ticket(String ticket)
+ ticket(String ticket)
IrdetoConfiguration.Builder(String licenseAcquisitionUrl)+
IrdetoConfiguration.Builder(String licenseAcquisitionUrl)
final <Error class: unknown class> crmId(String crmId)+
final <Error class: unknown class> crmId(String crmId)
Sets the identifier of the CRM.
final <Error class: unknown class> accountId(String accountId)+
final <Error class: unknown class> accountId(String accountId)
Sets the identifier of the Irdeto account.
final <Error class: unknown class> sessionId(String sessionId)+
final <Error class: unknown class> sessionId(String sessionId)
Sets the identifier of the session.
final <Error class: unknown class> contentId(String contentId)+
final <Error class: unknown class> contentId(String contentId)
Sets the identifier of the content.
final <Error class: unknown class> ticket(String ticket)+
final <Error class: unknown class> ticket(String ticket)
Sets the ticket for registered user flows.
private final Stringprivate final StringcrmIdprivate final Stringprivate final StringaccountIdprivate final Stringprivate final StringcontentIdprivate final Stringprivate final StringsessionIdprivate final Stringprivate final Stringticketprivate final Stringprivate final StringcustomIntegrationIdprivate final Map<String, Object>private final Map<String, Object>integrationParametersprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanmultiSessionprivate final List<KeySystemId>private final List<KeySystemId>preferredKeySystemsIrdetoConfiguration(String crmId, String accountId, String contentId, String sessionId, String ticket, KeySystemConfiguration widevine)final String
+ final String
getCrmId()
final String
+ final String
getAccountId()
final String
+ final String
getContentId()
final String
+ final String
getSessionId()
final String
+ final String
getTicket()
IrdetoConfiguration(String crmId, String accountId, String contentId, String sessionId, String ticket, KeySystemConfiguration widevine)+
IrdetoConfiguration(String crmId, String accountId, String contentId, String sessionId, String ticket, KeySystemConfiguration widevine)
final String getCrmId()+
final String getCrmId()
The identifier of the CRM. (Nullable)
This identifier will be added to the license URL requests.
final String getAccountId()+
final String getAccountId()
The identifier of the Irdeto account. (Nullable)
This identifier will be added to the license URL requests.
final String getContentId()+
final String getContentId()
The identifier of the content. (Nullable)
This identifier will be added to the license URL requests.
final String getSessionId()+
final String getSessionId()
The identifier of the session. (Nullable)
It must be present for registered user flow parameters.
This is not mandatory in case of free open streams.
final String getTicket()+
final String getTicket()
The ticket for registered user flows. (Nullable)
It must be present for registered user flow parameters.
This is not mandatory in case of free open streams.
final <Error class: unknown class>
customdata(String customdata)
+ customdata(String customdata)
final <Error class: unknown class>
playready(String playready)
+ playready(String playready)
final <Error class: unknown class>
widevine(String widevine)
+ widevine(String widevine)
final <Error class: unknown class> customdata(String customdata)+
final <Error class: unknown class> customdata(String customdata)
Sets the custom data which will be used for the license acquisition request.
This attribute is required if it is not specified in the separate KeyOSKeySystemConfiguration for Widevine and PlayReady.
The value of this attribute should be the value of the customData header that you want to send with license requests to the KeyOS license server.
In most cases this will be the base64 encoded KeyOS authentication XML.
final <Error class: unknown class> playready(String playready)+
final <Error class: unknown class> playready(String playready)
The license acquisition URL used for the PlayReady key system.
final <Error class: unknown class> widevine(String widevine)+
final <Error class: unknown class> widevine(String widevine)
The license acquisition URL used for the Widevine key system.
private final Stringprivate final Stringcustomdataprivate final Stringprivate final StringcustomIntegrationIdprivate final Map<String, Object>private final Map<String, Object>integrationParametersprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanmultiSessionprivate final List<KeySystemId>private final List<KeySystemId>preferredKeySystemsKeyOSDRMConfiguration(String customdata, KeyOSKeySystemConfiguration widevine, KeyOSKeySystemConfiguration playready)final String
+ final String
getCustomdata()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
KeyOSDRMConfiguration(String customdata, KeyOSKeySystemConfiguration widevine, KeyOSKeySystemConfiguration playready)+
KeyOSDRMConfiguration(String customdata, KeyOSKeySystemConfiguration widevine, KeyOSKeySystemConfiguration playready)
final String getCustomdata()+
final String getCustomdata()
The custom data for the license acquisition request. (Nullable)
This attribute is required if it is not specified in the separate KeyOSKeySystemConfiguration for Widevine and PlayReady.
The value of this attribute should be the value of the customData header that you want to send with license requests to the KeyOS license server.
In most cases this will be the base64 encoded KeyOS authentication XML.
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
KeyOSKeySystemConfiguration.Builder(String licenseAcquisitionURL)final <Error class: unknown class>
customdata(String customdata)
+ customdata(String customdata)
final <Error class: unknown class>
headers(Map<String, String> headers)
+ headers(Map<String, String> headers)
final <Error class: unknown class>
useCredentials(Boolean useCredentials)
+ useCredentials(Boolean useCredentials)
final <Error class: unknown class>
queryParameters(Map<String, String> queryParameters)
+ queryParameters(Map<String, String> queryParameters)
final <Error class: unknown class>
forceSoftwareDecrypt(Boolean forceSoftwareDecrypt)
+ forceSoftwareDecrypt(Boolean forceSoftwareDecrypt)
KeyOSKeySystemConfiguration.Builder(String licenseAcquisitionURL)+
KeyOSKeySystemConfiguration.Builder(String licenseAcquisitionURL)
final <Error class: unknown class> customdata(String customdata)+
final <Error class: unknown class> customdata(String customdata)
Sets the custom data for the license acquisition request.
The customdata attribute is required if it is not specified in the KeyOSDRMConfiguration.
final <Error class: unknown class> headers(Map<String, String> headers)+
final <Error class: unknown class> headers(Map<String, String> headers)
The map of HTTP headers for the license acquisition request.
final <Error class: unknown class> useCredentials(Boolean useCredentials)+
final <Error class: unknown class> useCredentials(Boolean useCredentials)
Sets whether the player is allowed to use credentials for cross-origin requests.
final <Error class: unknown class> queryParameters(Map<String, String> queryParameters)+
final <Error class: unknown class> queryParameters(Map<String, String> queryParameters)
Sets map of query parameters for the license acquisition request.
final <Error class: unknown class> forceSoftwareDecrypt(Boolean forceSoftwareDecrypt)+
final <Error class: unknown class> forceSoftwareDecrypt(Boolean forceSoftwareDecrypt)
Sets whether to force decryption to happen in software.
private final Stringprivate final Stringcustomdataprivate final Stringprivate final StringlicenseAcquisitionURLprivate final Map<String, String>private final Map<String, String>headersprivate final Booleanprivate final BooleanuseCredentialsprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanforceSoftwareDecryptprivate final Map<String, Object>private final Map<String, Object>integrationParametersKeyOSKeySystemConfiguration(String licenseAcquisitionURL, String customdata, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, Boolean forceSoftwareDecrypt)final String
+ final String
getCustomdata()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
KeyOSKeySystemConfiguration(String licenseAcquisitionURL, String customdata, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, Boolean forceSoftwareDecrypt)+
KeyOSKeySystemConfiguration(String licenseAcquisitionURL, String customdata, Map<String, String> headers, Boolean useCredentials, Map<String, String> queryParameters, Boolean forceSoftwareDecrypt)
final String getCustomdata()+
final String getCustomdata()
The custom data for the license acquisition request. (Nullable)
The customdata attribute is required if it is not specified in the KeyOSDRMConfiguration.
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
TitaniumDRMConfiguration.Builder(String accountName, String customerName, String portalId)final <Error class: unknown class>
friendlyName(String friendlyName)
+ friendlyName(String friendlyName)
final <Error class: unknown class>
authToken(String authToken)
+ authToken(String authToken)
final <Error class: unknown class>
version(String version)
+ version(String version)
TitaniumDRMConfiguration.Builder(String accountName, String customerName, String portalId)+
TitaniumDRMConfiguration.Builder(String accountName, String customerName, String portalId)
final <Error class: unknown class> friendlyName(String friendlyName)+
final <Error class: unknown class> friendlyName(String friendlyName)
Sets the friendly name of the customer.
final <Error class: unknown class> authToken(String authToken)+
final <Error class: unknown class> authToken(String authToken)
Sets the authentication token.
final <Error class: unknown class> version(String version)+
final <Error class: unknown class> version(String version)
Sets the Titanium version.
private final Stringprivate final StringaccountNameprivate final Stringprivate final StringcustomerNameprivate final Stringprivate final StringportalIdprivate final Stringprivate final StringfriendlyNameprivate final Stringprivate final StringauthTokenprivate final Stringprivate final Stringversionprivate final Stringprivate final StringcustomIntegrationIdprivate final Map<String, Object>private final Map<String, Object>integrationParametersprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanmultiSessionprivate final List<KeySystemId>private final List<KeySystemId>preferredKeySystemsTitaniumDRMConfiguration(String accountName, String customerName, String portalId, String friendlyName, String authToken, KeySystemConfiguration widevine, KeySystemConfiguration playready, String version)final String
+ final String
getAccountName()
final String
+ final String
getCustomerName()
final String
+ final String
getPortalId()
final String
+ final String
getFriendlyName()
final String
+ final String
getAuthToken()
final String
+ final String
getVersion()
TitaniumDRMConfiguration(String accountName, String customerName, String portalId, String friendlyName, String authToken, KeySystemConfiguration widevine, KeySystemConfiguration playready, String version)+
TitaniumDRMConfiguration(String accountName, String customerName, String portalId, String friendlyName, String authToken, KeySystemConfiguration widevine, KeySystemConfiguration playready, String version)
final String getAccountName()+
final String getAccountName()
The account name. (NonNull)
Required when doing device-based authentication.
final String getCustomerName()+
final String getCustomerName()
The customer name. (NonNull)
Required when doing device-based authentication.
final String getPortalId()+
final String getPortalId()
The identifier of the portal. (NonNull)
Required when doing device-based authentication.
final String getFriendlyName()+
final String getFriendlyName()
The customer friendly name. (Nullable)
final String getAuthToken()+
final String getAuthToken()
The authentication token. (Nullable)
This is a JSON token provided by the Titanium Secure Token Server.
Required when doing token-based authentication.
final String getVersion()+
final String getVersion()
The version of Titanium. (NonNull)
Only version 2 and 3 are supported.
Default: "2"
VudrmDRMConfiguration.Builder(String token)VudrmDRMConfiguration.Builder(String token)+
VudrmDRMConfiguration.Builder(String token)
private final Stringprivate final Stringtokenprivate final Stringprivate final StringcustomIntegrationIdprivate final Map<String, Object>private final Map<String, Object>integrationParametersprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanmultiSessionprivate final List<KeySystemId>private final List<KeySystemId>preferredKeySystemsVudrmDRMConfiguration(String token, KeySystemConfiguration widevine, KeySystemConfiguration playready)final String
+ final String
getToken()
VudrmDRMConfiguration(String token, KeySystemConfiguration widevine, KeySystemConfiguration playready)+
VudrmDRMConfiguration(String token, KeySystemConfiguration widevine, KeySystemConfiguration playready)
final String getToken()+
final String getToken()
The authentication token.
XstreamConfiguration.Builder(String streamId, String ticketAcquisitionURL)final <Error class: unknown class>
sessionId(String sessionId)
+ sessionId(String sessionId)
XstreamConfiguration.Builder(String streamId, String ticketAcquisitionURL)+
XstreamConfiguration.Builder(String streamId, String ticketAcquisitionURL)
final <Error class: unknown class> sessionId(String sessionId)+
final <Error class: unknown class> sessionId(String sessionId)
Sets the session identifier. (NonNull)
private final Stringprivate final StringstreamIdprivate final Stringprivate final StringticketAcquisitionUrlprivate final Stringprivate final StringsessionIdprivate final Stringprivate final StringcustomIntegrationIdprivate final Map<String, Object>private final Map<String, Object>integrationParametersprivate final Map<String, String>private final Map<String, String>queryParametersprivate final Booleanprivate final BooleanmultiSessionprivate final List<KeySystemId>private final List<KeySystemId>preferredKeySystemsXstreamConfiguration(String streamId, String ticketAcquisitionUrl, String sessionId, KeySystemConfiguration widevine, KeySystemConfiguration playready, FairPlayKeySystemConfiguration fairplay)final String
+ final String
getStreamId()
final String
+ final String
getTicketAcquisitionUrl()
final String
+ final String
getSessionId()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
XstreamConfiguration(String streamId, String ticketAcquisitionUrl, String sessionId, KeySystemConfiguration widevine, KeySystemConfiguration playready, FairPlayKeySystemConfiguration fairplay)+
XstreamConfiguration(String streamId, String ticketAcquisitionUrl, String sessionId, KeySystemConfiguration widevine, KeySystemConfiguration playready, FairPlayKeySystemConfiguration fairplay)
final String getStreamId()+
final String getStreamId()
The stream identifier. (NonNull)
final String getTicketAcquisitionUrl()+
final String getTicketAcquisitionUrl()
The ticket acquisition URL. (NonNull)
final String getSessionId()+
final String getSessionId()
The session identifier. (Nullable)
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
final HespPlaybackConfiguration.Builder
addCustomConfigurationProperty(String key, Object value)
+ addCustomConfigurationProperty(String key, Object value)
final HespPlaybackConfiguration.Builder addCustomConfigurationProperty(String key, Object value)+
final HespPlaybackConfiguration.Builder addCustomConfigurationProperty(String key, Object value)
Add a property to the custom configuration.
private final Map<String, Object>private final Map<String, Object>customConfigurationHespPlaybackConfiguration(Map<String, Object> customConfiguration)final Map<String, Object>
+ final Map<String, Object>
getCustomConfiguration()
HespPlaybackConfiguration(Map<String, Object> customConfiguration)+
HespPlaybackConfiguration(Map<String, Object> customConfiguration)
final Map<String, Object> getCustomConfiguration()+
final Map<String, Object> getCustomConfiguration()
The custom configuration.
final HlsPlaybackConfiguration.Builder
delaySubtitlePreload(Boolean delaySubtitlePreload)
+ delaySubtitlePreload(Boolean delaySubtitlePreload)
final HlsPlaybackConfiguration.Builder delaySubtitlePreload(Boolean delaySubtitlePreload)+
final HlsPlaybackConfiguration.Builder delaySubtitlePreload(Boolean delaySubtitlePreload)
Flag for delaying preloading of subtitles until after video/audio for HLS streams, intended to be used for MediaTailor streams.
A bug on the MediaTailor server side is currently causing them to return manifests without ads if the subtitle request is handled before video/audio. Enabling this flag will cause the player to delay starting subtitle loading until after video/audio manifests have successfully been requested, in order to work around the issue.
private final Booleanprivate final BooleanisDelaySubtitlePreloadHlsPlaybackConfiguration(Boolean isDelaySubtitlePreload)final Boolean
+ final Boolean
isDelaySubtitlePreload()
HlsPlaybackConfiguration(Boolean isDelaySubtitlePreload)+
HlsPlaybackConfiguration(Boolean isDelaySubtitlePreload)
final Boolean isDelaySubtitlePreload()+
final Boolean isDelaySubtitlePreload()
Flag for delaying preloading of subtitles until after video/audio for HLS streams, intended to be used for MediaTailor streams.
A bug on the MediaTailor server side is currently causing them to return manifests without ads if the subtitle request is handled before video/audio. Enabling this flag will cause the player to delay starting subtitle loading until after video/audio manifests have successfully been requested, in order to work around the issue.
protected Map<String, String>protected Map<String, String>headersprotected Doubleprotected DoubleliveOffsetprotected Booleanprotected BooleanhlsDateRangeprotected Stringprotected StringtimeServerprotected Booleanprotected BooleanlowLatencyprotected Stringprotected StringsrcMediaTailorSource.Builder(String src)final <Error class: unknown class>
adsParams(Map<String, String> adsParams)
+ adsParams(Map<String, String> adsParams)
MediaTailorSource.Builder(String src)+
MediaTailorSource.Builder(String src)
final <Error class: unknown class> adsParams(Map<String, String> adsParams)+
final <Error class: unknown class> adsParams(Map<String, String> adsParams)
Optional Map of ad parameters to perform client-side ad reporting. For more information visit MediaTailor documentation.
private final Map<String, String>private final Map<String, String>adsParamsprivate final Stringprivate final Stringsrcprivate final Map<String, String>private final Map<String, String>headersprivate final Doubleprivate final DoubleliveOffsetprivate final Booleanprivate final BooleanhlsDateRangeprivate final Stringprivate final StringtimeServerprivate final Booleanprivate final BooleanlowLatencyMediaTailorSource(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode, Map<String, String> adsParams)final Map<String, String>
+ final Map<String, String>
getAdsParams()
final MediaTailorSource
copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode, Map<String, String> adsParams)
+ copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode, Map<String, String> adsParams)
TypedSource
copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
+ copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
MediaTailorSource(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode, Map<String, String> adsParams)+
MediaTailorSource(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode, Map<String, String> adsParams)
final Map<String, String> getAdsParams()+
final Map<String, String> getAdsParams()
Optional Map of ad parameters to perform client-side ad reporting. For more information visit MediaTailor documentation.
final MediaTailorSource copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode, Map<String, String> adsParams)+
final MediaTailorSource copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode, Map<String, String> adsParams)
TypedSource copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)+
TypedSource copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
Creates a new TypedSource with the same properties as this source, optionally replacing specific properties with the given values.
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
final ChromecastMetadataDescription.Builder
images(String images)
+ images(String images)
final ChromecastMetadataDescription.Builder
releaseDate(String releaseDate)
+ releaseDate(String releaseDate)
final ChromecastMetadataDescription.Builder
title(String title)
+ title(String title)
final ChromecastMetadataDescription.Builder
subtitle(String subtitle)
+ subtitle(String subtitle)
final ChromecastMetadataDescription.Builder images(String images)+
final ChromecastMetadataDescription.Builder images(String images)
Sets one or more URLs of images.
The string must be a valid URL.
final ChromecastMetadataDescription.Builder releaseDate(String releaseDate)+
final ChromecastMetadataDescription.Builder releaseDate(String releaseDate)
Sets the release date of the current source.
The format is "YYYY-MM-DD".
final ChromecastMetadataDescription.Builder title(String title)+
final ChromecastMetadataDescription.Builder title(String title)
Sets the title of the content.
final ChromecastMetadataDescription.Builder subtitle(String subtitle)+
final ChromecastMetadataDescription.Builder subtitle(String subtitle)
Sets the subtitle of the content.
private final List<ChromecastMetadataImage>private final List<ChromecastMetadataImage>imagesprivate final Stringprivate final StringreleaseDateprivate final Stringprivate final Stringtitleprivate final Stringprivate final Stringsubtitleprivate final Map<String, Object>private final Map<String, Object>datafinal List<ChromecastMetadataImage>
+ final List<ChromecastMetadataImage>
getImages()
final String
+ final String
getReleaseDate()
final String
+ final String
getTitle()
final String
+ final String
getSubtitle()
final List<ChromecastMetadataImage> getImages()+
final List<ChromecastMetadataImage> getImages()
final String getReleaseDate()+
final String getReleaseDate()
final String getTitle()+
final String getTitle()
final String getSubtitle()+
final String getSubtitle()
private final Stringprivate final Stringsrcprivate final Integerprivate final Integerwidthprivate final Integerprivate final IntegerheightChromecastMetadataImage(String src)ChromecastMetadataImage(String src, Integer width, Integer height)final String
+ final String
getSrc()
final Integer
+ final Integer
getWidth()
final Integer
+ final Integer
getHeight()
ChromecastMetadataImage(String src)+
ChromecastMetadataImage(String src)
ChromecastMetadataImage(String src, Integer width, Integer height)+
ChromecastMetadataImage(String src, Integer width, Integer height)
final String getSrc()+
final String getSrc()
The URL of the image. (NonNull)
final Integer getWidth()+
final Integer getWidth()
The width of the image, in pixels. (Nullable)
final Integer getHeight()+
final Integer getHeight()
The height of the image, in pixels. (Nullable)
final ChromecastMetadataType
fromName(String metadataType)
+ fromName(String metadataType)
final ChromecastMetadataType fromName(String metadataType)+
final ChromecastMetadataType fromName(String metadataType)
Creates a Chromecast metadata type.
public enum ChromecastMetadataType -extends Enum<ChromecastMetadataType> +extends Enum<ChromecastMetadataType>
The Chromecast metadata type.
private final Stringprivate final Stringtypeprivate final Integerprivate final IntegernativeTypeprivate final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal ChromecastMetadataType
valueOf(String value)
+ valueOf(String value)
final String
+ final String
getType()
final Integer
+ final Integer
getNativeType()
final ChromecastMetadataType valueOf(String value)+
final ChromecastMetadataType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
final String getType()+
final String getType()
The textual representation of the Chromecast metadata.
final Integer getNativeType()+
final Integer getNativeType()
The Chromecast MediaMetadata representation.
private final Map<String, Object>private final Map<String, Object>dataMetadataDescription(Map<String, Object> map)MetadataDescription(Map<String, Object> map)+
MetadataDescription(Map<String, Object> map)
private final Stringprivate final StringcustomIntegrationabstract String
+ abstract String
getCustomIntegration()
abstract String getCustomIntegration()+
abstract String getCustomIntegration()
The ID of the custom SSAI integration. (NonNull)
final static Unit
register(String customIntegration, CustomSsaiDescriptionSerializer serializer)
+ register(String customIntegration, CustomSsaiDescriptionSerializer serializer)
final static CustomSsaiDescription
deserialize(String integrationId, String json)
+ deserialize(String integrationId, String json)
final static String
+ final static String
serialize(CustomSsaiDescription value)
final static Unit register(String customIntegration, CustomSsaiDescriptionSerializer serializer)+
final static Unit register(String customIntegration, CustomSsaiDescriptionSerializer serializer)
Register the given serializer to handle CustomSsaiDescription objects with the given integration ID.
@ApiStatus.Internal() final static CustomSsaiDescription deserialize(String integrationId, String json)+
@ApiStatus.Internal() final static CustomSsaiDescription deserialize(String integrationId, String json)
@ApiStatus.Internal() final static String serialize(CustomSsaiDescription value)+
@ApiStatus.Internal() final static String serialize(CustomSsaiDescription value)
abstract CustomSsaiDescription
fromJson(String json)
+ fromJson(String json)
abstract String
+ abstract String
toJson(CustomSsaiDescription value)
abstract CustomSsaiDescription fromJson(String json)+
abstract CustomSsaiDescription fromJson(String json)
Reads a CustomSsaiDescription from the given JSON string.
The customIntegration property of the returned object must match the integration with which this serializer was registered.
abstract String toJson(CustomSsaiDescription value)+
abstract String toJson(CustomSsaiDescription value)
Writes the given CustomSsaiDescription as a JSON string.
The returned JSON string must have a string property named "integration" that contains value's customIntegrationId.
protected Stringprotected StringauthTokenprotected Stringprotected StringstreamActivityMonitorIDprotected Map<String, String>protected Map<String, String>adTagParametersprotected Stringprotected StringapiKeyGoogleDaiConfiguration.Builder(String apiKey)GoogleDaiConfiguration.Builder
authToken(String authToken)
+ authToken(String authToken)
GoogleDaiConfiguration.Builder
streamActivityMonitorID(String streamActivityMonitorID)
+ streamActivityMonitorID(String streamActivityMonitorID)
GoogleDaiConfiguration.Builder
adTagParameters(Map<String, String> adTagParameters)
+ adTagParameters(Map<String, String> adTagParameters)
GoogleDaiConfiguration.Builder(String apiKey)+
GoogleDaiConfiguration.Builder(String apiKey)
GoogleDaiConfiguration.Builder authToken(String authToken)+
GoogleDaiConfiguration.Builder authToken(String authToken)
Sets the authorization token for the stream request.
For more information, see GoogleDaiConfiguration.getAuthToken.
GoogleDaiConfiguration.Builder streamActivityMonitorID(String streamActivityMonitorID)+
GoogleDaiConfiguration.Builder streamActivityMonitorID(String streamActivityMonitorID)
Sets the identifier for a stream activity monitor session.
GoogleDaiConfiguration.Builder adTagParameters(Map<String, String> adTagParameters)+
GoogleDaiConfiguration.Builder adTagParameters(Map<String, String> adTagParameters)
Sets the ad tag parameters which are added to the stream request.
private final Stringprivate final StringapiKeyprivate final Stringprivate final StringauthTokenprivate final Stringprivate final StringstreamActivityMonitorIDprivate final Map<String, String>private final Map<String, String>adTagParametersGoogleDaiConfiguration(StreamType availabilityType, String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)final String
+ final String
getApiKey()
final String
+ final String
getAuthToken()
final String
+ final String
getStreamActivityMonitorID()
final Map<String, String>
+ final Map<String, String>
getAdTagParameters()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
abstract GoogleDaiConfiguration
copy(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)
+ copy(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)
GoogleDaiConfiguration(StreamType availabilityType, String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)+
GoogleDaiConfiguration(StreamType availabilityType, String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)
final String getApiKey()+
final String getApiKey()
The API key for the stream request. (NonNull)
This key is used to verify applications that are attempting to access the content.
This key is configured through the Google Ad Manager UI.
final String getAuthToken()+
final String getAuthToken()
The authorization token for the stream request. (Nullable)
This token is used for stricter content authorization.
The publisher can control individual content streams authorizations based on this token.
final String getStreamActivityMonitorID()+
final String getStreamActivityMonitorID()
The identifier for a stream activity monitor session. (Nullable)
final Map<String, String> getAdTagParameters()+
final Map<String, String> getAdTagParameters()
The ad tag parameters added to stream request. (Nullable)
Each entry contains the parameter name with associated value.
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
abstract GoogleDaiConfiguration copy(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)+
abstract GoogleDaiConfiguration copy(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)
final SsaiIntegration
from(String ssaiIntegrationId)
+ from(String ssaiIntegrationId)
final SsaiIntegration from(String ssaiIntegrationId)+
final SsaiIntegration from(String ssaiIntegrationId)
Creates a SSAI integration from a textual representation.
public enum SsaiIntegration -extends Enum<SsaiIntegration> +extends Enum<SsaiIntegration>
The identifier of a server-side ad insertion integration.
private final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal SsaiIntegration
valueOf(String value)
+ valueOf(String value)
final SsaiIntegration valueOf(String value)+
final SsaiIntegration valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
final StreamType
from(String streamTypeString)
+ from(String streamTypeString)
final StreamType from(String streamTypeString)+
final StreamType from(String streamTypeString)
Creates a stream type from a textual representation.
public enum StreamType -extends Enum<StreamType> +extends Enum<StreamType>
The type of a stream.
private final Stringprivate final Stringnameprivate final Integerprivate final Integerordinalfinal StreamType
valueOf(String value)
+ valueOf(String value)
final StreamType valueOf(String value)+
final StreamType valueOf(String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
protected Stringprotected StringauthTokenprotected Stringprotected StringstreamActivityMonitorIDprotected Map<String, String>protected Map<String, String>adTagParametersprotected Stringprotected StringapiKeyGoogleDaiLiveConfiguration.Builder(String apiKey, String assetKey)GoogleDaiLiveConfiguration.Builder
authToken(String authToken)
+ authToken(String authToken)
GoogleDaiLiveConfiguration.Builder
streamActivityMonitorID(String streamActivityMonitorID)
+ streamActivityMonitorID(String streamActivityMonitorID)
GoogleDaiLiveConfiguration.Builder
adTagParameters(Map<String, String> adTagParameters)
+ adTagParameters(Map<String, String> adTagParameters)
GoogleDaiLiveConfiguration.Builder(String apiKey, String assetKey)+
GoogleDaiLiveConfiguration.Builder(String apiKey, String assetKey)
GoogleDaiLiveConfiguration.Builder authToken(String authToken)+
GoogleDaiLiveConfiguration.Builder authToken(String authToken)
Sets the authorization token for the stream request.
For more information, see GoogleDaiConfiguration.getAuthToken.
GoogleDaiLiveConfiguration.Builder streamActivityMonitorID(String streamActivityMonitorID)+
GoogleDaiLiveConfiguration.Builder streamActivityMonitorID(String streamActivityMonitorID)
Sets the identifier for a stream activity monitor session.
GoogleDaiLiveConfiguration.Builder adTagParameters(Map<String, String> adTagParameters)+
GoogleDaiLiveConfiguration.Builder adTagParameters(Map<String, String> adTagParameters)
Sets the ad tag parameters which are added to the stream request.
private final Stringprivate final StringassetKeyprivate final Stringprivate final StringapiKeyprivate final Stringprivate final StringauthTokenprivate final Stringprivate final StringstreamActivityMonitorIDprivate final Map<String, String>private final Map<String, String>adTagParametersGoogleDaiLiveConfiguration(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters, String assetKey)final String
+ final String
getAssetKey()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
GoogleDaiLiveConfiguration
copy(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)
+ copy(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)
GoogleDaiLiveConfiguration(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters, String assetKey)+
GoogleDaiLiveConfiguration(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters, String assetKey)
final String getAssetKey()+
final String getAssetKey()
The identifier for the video content source for live streams.
This property is required for live streams.
The asset key can be found in the Google Ad Manager UI.
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
GoogleDaiLiveConfiguration copy(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)+
GoogleDaiLiveConfiguration copy(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)
protected Stringprotected StringauthTokenprotected Stringprotected StringstreamActivityMonitorIDprotected Map<String, String>protected Map<String, String>adTagParametersprotected Stringprotected StringapiKeyGoogleDaiVodConfiguration.Builder(String apiKey, String contentSourceID, String videoID)GoogleDaiVodConfiguration.Builder
authToken(String authToken)
+ authToken(String authToken)
GoogleDaiVodConfiguration.Builder
streamActivityMonitorID(String streamActivityMonitorID)
+ streamActivityMonitorID(String streamActivityMonitorID)
GoogleDaiVodConfiguration.Builder
adTagParameters(Map<String, String> adTagParameters)
+ adTagParameters(Map<String, String> adTagParameters)
GoogleDaiVodConfiguration.Builder(String apiKey, String contentSourceID, String videoID)+
GoogleDaiVodConfiguration.Builder(String apiKey, String contentSourceID, String videoID)
GoogleDaiVodConfiguration.Builder authToken(String authToken)+
GoogleDaiVodConfiguration.Builder authToken(String authToken)
Sets the authorization token for the stream request.
For more information, see GoogleDaiConfiguration.getAuthToken.
GoogleDaiVodConfiguration.Builder streamActivityMonitorID(String streamActivityMonitorID)+
GoogleDaiVodConfiguration.Builder streamActivityMonitorID(String streamActivityMonitorID)
Sets the identifier for a stream activity monitor session.
GoogleDaiVodConfiguration.Builder adTagParameters(Map<String, String> adTagParameters)+
GoogleDaiVodConfiguration.Builder adTagParameters(Map<String, String> adTagParameters)
Sets the ad tag parameters which are added to the stream request.
private final Stringprivate final StringcontentSourceIDprivate final Stringprivate final StringvideoIDprivate final Stringprivate final StringapiKeyprivate final Stringprivate final StringauthTokenprivate final Stringprivate final StringstreamActivityMonitorIDprivate final Map<String, String>private final Map<String, String>adTagParametersGoogleDaiVodConfiguration(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters, String contentSourceID, String videoID)final String
+ final String
getContentSourceID()
final String
+ final String
getVideoID()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
GoogleDaiVodConfiguration
copy(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)
+ copy(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)
GoogleDaiVodConfiguration(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters, String contentSourceID, String videoID)+
GoogleDaiVodConfiguration(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters, String contentSourceID, String videoID)
final String getContentSourceID()+
final String getContentSourceID()
The identifier for the publisher's content for on-demand streams. (NonNull)
The publisher's content comes from a CMS.
This property is required for on-demand streams.
final String getVideoID()+
final String getVideoID()
The identifier for the video content source for on-demand streams. (NonNull)
This property is required for on-demand streams.
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
GoogleDaiVodConfiguration copy(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)+
GoogleDaiVodConfiguration copy(String apiKey, String authToken, String streamActivityMonitorID, Map<String, String> adTagParameters)
private final Stringprivate final StringintegrationContentProtectionConfiguration(String integration, KeySystemConfiguration widevine, KeySystemConfiguration playready, FairPlayConfiguration fairplay)final String
+ final String
getIntegration()
ContentProtectionConfiguration(String integration, KeySystemConfiguration widevine, KeySystemConfiguration playready, FairPlayConfiguration fairplay)+
ContentProtectionConfiguration(String integration, KeySystemConfiguration widevine, KeySystemConfiguration playready, FairPlayConfiguration fairplay)
final String getIntegration()+
final String getIntegration()
abstract String
+ abstract String
getId()
abstract String
+ abstract String
getExternalId()
abstract String
+ abstract String
getName()
abstract String getId()+
abstract String getId()
abstract String getExternalId()+
abstract String getExternalId()
abstract String getName()+
abstract String getName()
private final Stringprivate final StringhespSrcprivate final Stringprivate final StringhlsSrcprivate final Stringprivate final StringhlsMpegTsSrcprivate final Stringprivate final StringadSrcprivate final Stringprivate final StringdaiAssetKeyprivate final Stringprivate final Stringcdnprivate final Integerprivate final Integerweightprivate final Integerprivate final Integerpriorityprivate final Stringprivate final Stringproviderprivate final Stringprivate final StringadSystemprivate Doubleprivate DoubletargetLatencyEndpoint(String hespSrc, EndpointMillicastSource millicastSrc, String hlsSrc, String hlsMpegTsSrc, String adSrc, String daiAssetKey, String cdn, Integer weight, Integer priority, ContentProtectionConfiguration contentProtection, String provider, String adSystem, Double targetLatency)final String
+ final String
getHespSrc()
final String
+ final String
getHlsSrc()
final String
+ final String
getHlsMpegTsSrc()
final String
+ final String
getAdSrc()
final String
+ final String
getDaiAssetKey()
final String
+ final String
getCdn()
final Integer
+ final Integer
getWeight()
final Integer
+ final Integer
getPriority()
final String
+ final String
getProvider()
final String
+ final String
getAdSystem()
final Double
+ final Double
getTargetLatency()
final Unit
setTargetLatency(Double targetLatency)
+ setTargetLatency(Double targetLatency)
Endpoint(String hespSrc, EndpointMillicastSource millicastSrc, String hlsSrc, String hlsMpegTsSrc, String adSrc, String daiAssetKey, String cdn, Integer weight, Integer priority, ContentProtectionConfiguration contentProtection, String provider, String adSystem, Double targetLatency)+
Endpoint(String hespSrc, EndpointMillicastSource millicastSrc, String hlsSrc, String hlsMpegTsSrc, String adSrc, String daiAssetKey, String cdn, Integer weight, Integer priority, ContentProtectionConfiguration contentProtection, String provider, String adSystem, Double targetLatency)
final String getHespSrc()+
final String getHespSrc()
final String getHlsSrc()+
final String getHlsSrc()
final String getHlsMpegTsSrc()+
final String getHlsMpegTsSrc()
final String getAdSrc()+
final String getAdSrc()
final String getDaiAssetKey()+
final String getDaiAssetKey()
final String getCdn()+
final String getCdn()
final Integer getWeight()+
final Integer getWeight()
final Integer getPriority()+
final Integer getPriority()
final String getProvider()+
final String getProvider()
final String getAdSystem()+
final String getAdSystem()
final Double getTargetLatency()+
final Double getTargetLatency()
final Unit setTargetLatency(Double targetLatency)+
final Unit setTargetLatency(Double targetLatency)
private final Stringprivate final Stringnameprivate final Stringprivate final StringaccountIdprivate final Stringprivate final StringsubscriberTokenprivate final Stringprivate final StringdirectorUrlEndpointMillicastSource(String name, String accountId, String subscriberToken, String directorUrl, WebRTCOptions webrtc)final String
+ final String
getName()
final String
+ final String
getAccountId()
final String
+ final String
getSubscriberToken()
final String
+ final String
getDirectorUrl()
EndpointMillicastSource(String name, String accountId, String subscriberToken, String directorUrl, WebRTCOptions webrtc)+
EndpointMillicastSource(String name, String accountId, String subscriberToken, String directorUrl, WebRTCOptions webrtc)
final String getName()+
final String getName()
final String getAccountId()+
final String getAccountId()
final String getSubscriberToken()+
final String getSubscriberToken()
final String getDirectorUrl()+
final String getDirectorUrl()
private final Stringprivate final StringlicenseUrlprivate final Stringprivate final StringcertificateUrlFairPlayConfiguration(String licenseUrl, String certificateUrl)final String
+ final String
getLicenseUrl()
final String
+ final String
getCertificateUrl()
FairPlayConfiguration(String licenseUrl, String certificateUrl)+
FairPlayConfiguration(String licenseUrl, String certificateUrl)
final String getLicenseUrl()+
final String getLicenseUrl()
final String getCertificateUrl()+
final String getCertificateUrl()
private final Stringprivate final StringlicenseUrlKeySystemConfiguration(String licenseUrl)final String
+ final String
getLicenseUrl()
KeySystemConfiguration(String licenseUrl)+
KeySystemConfiguration(String licenseUrl)
final String getLicenseUrl()+
final String getLicenseUrl()
private final Integerprivate final Integerminimumprivate final Integerprivate final IntegermaximumPlayoutDelay(Integer minimum, Integer maximum)final Integer
+ final Integer
getMinimum()
final Integer
+ final Integer
getMaximum()
PlayoutDelay(Integer minimum, Integer maximum)+
PlayoutDelay(Integer minimum, Integer maximum)
final Integer getMinimum()+
final Integer getMinimum()
final Integer getMaximum()+
final Integer getMaximum()
THEOLiveConfig.Builder(String externalSessionId, Boolean analyticsDisabled, String discoveryUrl)final THEOLiveConfig.Builder
externalSessionId(String sessionId)
+ externalSessionId(String sessionId)
final THEOLiveConfig.Builder
discoveryUrl(String url)
+ discoveryUrl(String url)
THEOLiveConfig.Builder(String externalSessionId, Boolean analyticsDisabled, String discoveryUrl)+
THEOLiveConfig.Builder(String externalSessionId, Boolean analyticsDisabled, String discoveryUrl)
final THEOLiveConfig.Builder externalSessionId(String sessionId)+
final THEOLiveConfig.Builder externalSessionId(String sessionId)
final THEOLiveConfig.Builder discoveryUrl(String url)+
final THEOLiveConfig.Builder discoveryUrl(String url)
abstract String
+ abstract String
getExternalSessionId()
abstract Boolean
+ abstract Boolean
getAnalyticsDisabled()
abstract String
+ abstract String
getDiscoveryUrl()
abstract String 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.
abstract Boolean getAnalyticsDisabled()+
abstract Boolean getAnalyticsDisabled()
Returns whether the Analytics is supported or not.
abstract String getDiscoveryUrl()+
abstract String getDiscoveryUrl()
Override for the discovery URL.
private final Stringprivate final Stringprofileprivate final Stringprivate final Stringsrcprivate final Map<String, String>private final Map<String, String>headersprivate final Doubleprivate final DoubleliveOffsetprivate final Booleanprivate final BooleanhlsDateRangeprivate final Stringprivate final StringtimeServerprivate final Booleanprivate final BooleanlowLatencyTheoLiveSource(String src, Map<String, String> headers, LatencyConfiguration latencyConfiguration, DRMConfiguration drm, String profile, WebRTCOptions webrtc)final String
+ final String
getProfile()
Boolean
+ Boolean
equals(Object other)
+ equals(Object other)
Integer
+ Integer
hashCode()
final TheoLiveSource
copy(String src, Map<String, String> headers, LatencyConfiguration latencyConfiguration, String profile, WebRTCOptions webrtc)
+ copy(String src, Map<String, String> headers, LatencyConfiguration latencyConfiguration, String profile, WebRTCOptions webrtc)
TheoLiveSource
copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
+ copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
TheoLiveSource(String src, Map<String, String> headers, LatencyConfiguration latencyConfiguration, DRMConfiguration drm, String profile, WebRTCOptions webrtc)+
TheoLiveSource(String src, Map<String, String> headers, LatencyConfiguration latencyConfiguration, DRMConfiguration drm, String profile, WebRTCOptions webrtc)
final String getProfile()+
final String getProfile()
Boolean equals(Object other)+
Boolean equals(Object other)
Integer hashCode()+
Integer hashCode()
final TheoLiveSource copy(String src, Map<String, String> headers, LatencyConfiguration latencyConfiguration, String profile, WebRTCOptions webrtc)+
final TheoLiveSource copy(String src, Map<String, String> headers, LatencyConfiguration latencyConfiguration, String profile, WebRTCOptions webrtc)
Creates a new TheoLiveSource with the same properties as this source, optionally replacing specific properties with the given values.
TheoLiveSource copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)+
TheoLiveSource copy(String src, DRMConfiguration drm, SourceType type, Map<String, String> headers, Double liveOffset, SsaiDescription ssai, Boolean hlsDateRange, String timeServer, Boolean lowLatency, LatencyConfiguration latencyConfiguration, HlsPlaybackConfiguration hls, DashPlaybackConfiguration dash, CMCDTransmissionMode cmcdTransmissionMode)
Creates a new TypedSource with the same properties as this source, optionally replacing specific properties with the given values.
public interface TimeRanges - implements Iterable<T> + implements Iterable<T>
The TimeRanges API which can be used to get information regarding multiple periods in the playback.
-public interface JavaCallback<T extends Object> +public interface JavaCallback<T extends Object>@@ -256,7 +256,7 @@
abstract Unit
onError(Throwable exception)
+ onError(Throwable exception)
abstract Unit onError(Throwable exception)+
abstract Unit onError(Throwable exception)
public final static Stringpublic final static StringContentPlayerpublic final static Stringpublic final static StringMedia3public final static Stringpublic final static StringHTTPpublic final static Stringpublic final static StringCachepublic final static Stringpublic final static StringLicensepublic final static Stringpublic final static StringPictureInPicturepublic final static Stringpublic final static StringFullscreenpublic final static Stringpublic final static StringMediaTailorpublic final static Stringpublic final static StringChromecastpublic final static Stringpublic final static StringGoogleDAIpublic final static Stringpublic final static StringGoogleIMApublic final static Stringpublic final static StringTHEOAdspublic final static Stringpublic final static StringMillicastpublic final static Stringpublic final static StringTheoLivepublic final static Stringpublic final static StringCMCDpublic final static Stringpublic final static StringHESPUnit
log(Integer logLevel, String tag, String message)
+ log(Integer logLevel, String tag, String message)
Unit
logVerbose(String tag, String message)
+ logVerbose(String tag, String message)
Unit
logDebug(String tag, String message)
+ logDebug(String tag, String message)
Unit
logInfo(String tag, String message)
+ logInfo(String tag, String message)
Unit
logWarning(String tag, String message)
+ logWarning(String tag, String message)
Unit
logError(String tag, String message)
+ logError(String tag, String message)
Unit log(Integer logLevel, String tag, String message)+
Unit log(Integer logLevel, String tag, String message)
Called when the tag would print a message.
Unit logVerbose(String tag, String message)-
Called when the tag would print a Verbose message, same level as Log.VERBOSE.
Unit logVerbose(String tag, String message)+
Called when the tag would print a Verbose message, same level as Log.VERBOSE.
Unit logDebug(String tag, String message)-
Called when the tag would print a Debug message, same level as Log.DEBUG.
Unit logDebug(String tag, String message)+
Called when the tag would print a Debug message, same level as Log.DEBUG.
Unit logInfo(String tag, String message)-
Called when the tag would print an Info message, same level as Log.INFO.
Unit logInfo(String tag, String message)+
Called when the tag would print an Info message, same level as Log.INFO.
Unit logWarning(String tag, String message)-
Called when the tag would print a Warning message, same level as Log.WARN.
Unit logWarning(String tag, String message)+
Called when the tag would print a Warning message, same level as Log.WARN.
Unit logError(String tag, String message)-
Called when the tag would print an Error message, same level as Log.ERROR.
Unit logError(String tag, String message)+
Called when the tag would print an Error message, same level as Log.ERROR.
abstract Unit
enableTags(String tags)
+ enableTags(String tags)
abstract Unit
disableTags(String tags)
+ disableTags(String tags)
abstract Set<String>
+ abstract Set<String>
availableTags()
abstract Boolean
+ abstract Boolean
isTagEnabled(String tag)
+ isTagEnabled(String tag)
abstract Unit enableTags(String tags)+
abstract Unit enableTags(String tags)
Enables logs with the provided tags.
abstract Unit disableTags(String tags)+
abstract Unit disableTags(String tags)
Disables logs with the provided tags.
abstract Set<String> availableTags()+
abstract Set<String> availableTags()
Returns the set of all available log tags.
abstract Boolean isTagEnabled(String tag)+
abstract Boolean isTagEnabled(String tag)
Returns whether the given log tag is currently enabled.
public interface SimpleList<T> - implements Iterable<T> + implements Iterable<T>
A Simple list of items.
The player will use a SurfaceView to draw the video into.
null if no source is set.