Player Module/com.bitmovin.player.api/TweaksConfig

TweaksConfig

data class TweaksConfig(timeChangedInterval: Double, bandwidthEstimateWeightLimit: Int, languagePropertyNormalization: Boolean, localDynamicDashWindowUpdateInterval: Double?, useFiletypeExtractorFallbackForHls: Boolean, useDrmSessionForClearPeriods: Boolean, useDrmSessionForClearSources: Boolean, shouldApplyTtmlRegionWorkaround: Boolean, devicesThatRequireSurfaceWorkaround: List<DeviceDescription>) : Parcelable

This configuration is used as an incubator for experimental features. Tweaks are not officially supported and are not guaranteed to be stable, i.e. their naming, functionality and API can change at any time within the tweaks or when being promoted to an official feature and moved into its final configuration namespace.

Constructors

TweaksConfig

fun TweaksConfig(timeChangedInterval: Double = DEFAULT_TIME_CHANGED_EVENT_INTERVAL, bandwidthEstimateWeightLimit: Int = DEFAULT_BANDWIDTH_ESTIMATE_WEIGHT_LIMIT, languagePropertyNormalization: Boolean = true, localDynamicDashWindowUpdateInterval: Double? = null, useFiletypeExtractorFallbackForHls: Boolean = false, useDrmSessionForClearPeriods: Boolean = false, useDrmSessionForClearSources: Boolean = false, shouldApplyTtmlRegionWorkaround: Boolean = true, devicesThatRequireSurfaceWorkaround: List<DeviceDescription> = emptyList())

Types

Companion

object Companion

Properties

bandwidthEstimateWeightLimit

var bandwidthEstimateWeightLimit: Int

Constantly aggregated and weighted bandwidth samples are summed up to this weight limit to calculate an bandwidth estimation. Remaining samples (i.e. that would lead to exceeding the limit) are dropped from memory as they are not relevant anymore.

devicesThatRequireSurfaceWorkaround

var devicesThatRequireSurfaceWorkaround: List<DeviceDescription>

Some devices have an incorrect implementation of MediaCodec.setOutputSurface. This leads to failure when the surface changes. To prevent failure, the codec will be released and re-instantiated in those scenarios.

exoPlayerCache

@Transient

var exoPlayerCache: Cache? = null

A cache instance that is used by the player in read-only mode. Ignored when playing back OfflineSourceConfigs.

languagePropertyNormalization

var languagePropertyNormalization: Boolean = true

Specifies if the language property on DASH Representations, HLS Renditions and SmoothStreaming QualityLevels is normalized. If enabled, language properties are normalized to IETF BCP 47 language tags. Examples: - "ENG" is normalized to "en" - "en_us" is normalized to "en-us" - "en-US-x-lvariant-POSIX" is normalized to "en-us-posix"

localDynamicDashWindowUpdateInterval

var localDynamicDashWindowUpdateInterval: Double? = null

The interval in which dynamic DASH windows are updated locally. I.e. The rate by which the playback window is moved forward on the timeline.

shouldApplyTtmlRegionWorkaround

var shouldApplyTtmlRegionWorkaround: Boolean = true

Specifies whether default positioning values should be assumed when parsing TTML regions in case of unsupported TTML features. Default is true.

timeChangedInterval

var timeChangedInterval: Double

The frequency in seconds the TimeChanged will be fired.

useDrmSessionForClearPeriods

var useDrmSessionForClearPeriods: Boolean = false

Specifies whether a DRM session should be used for clear tracks of type video and audio. Using DRM sessions for clear content avoids the recreation of decoders when transitioning between clear and encrypted sections of content. Default is false.

useDrmSessionForClearSources

var useDrmSessionForClearSources: Boolean = false

Specifies whether a DRM session should be used for clear tracks of type video and audio in a clear source that follows after a DRM protected source. In addition, a DRM session will be used for clear periods in a DRM protected source. Using DRM sessions for clear content avoids the recreation of decoders when transitioning between clear and encrypted sections of content. Default is false.

useFiletypeExtractorFallbackForHls

var useFiletypeExtractorFallbackForHls: Boolean = false

Specifies if the player should always fall back to an extractor matching the file type, if no matching extractor was found. If the fallback is applied, this will ignore potential incompatibilities with streams and thus can result in unstable or failing playback.