AbrConfiguration class
Properties
-
advanced
↔ AdvancedAbrConfiguration
-
shaka.extern.AdvancedAbrConfiguration Advanced ABR configuration
getter/setter pair
-
bandwidthDowngradeTarget
↔ num
-
number The largest fraction of the estimated bandwidth we should use. We should downgrade to avoid this.
getter/setter pair
-
bandwidthUpgradeTarget
↔ num
-
number The fraction of the estimated bandwidth which we should try to use when upgrading.
getter/setter pair
-
clearBufferSwitch
↔ bool
-
boolean If true, the buffer will be cleared during the switch. The default automatic behavior is false to have a smoother transition. On some device it's better to clear buffer. Defaults false.
getter/setter pair
-
defaultBandwidthEstimate
↔ num
-
number The default bandwidth estimate to use if there is not enough data, in bit/sec.
getter/setter pair
-
enabled
↔ bool
-
boolean If true, enable adaptation by the current AbrManager. Defaults to true.
getter/setter pair
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
ignoreDevicePixelRatio
↔ bool
-
boolean If true,device pixel ratio is ignored when restricting the quality to media element size or screen size. Defaults false.
getter/setter pair
-
restrictions
↔ Restrictions
-
shaka.extern.Restrictions The restrictions to apply to ABR decisions. These are "soft" restrictions. Any track that fails to meet these restrictions will not be selected automatically, but will still appear in the track list and can still be selected via selectVariantTrack(). If no tracks meet these restrictions, AbrManager should not fail, but choose a low-res or low-bandwidth variant instead. It is the responsibility of AbrManager implementations to follow these rules and implement this behavior.
getter/setter pair
-
restrictToElementSize
↔ bool
-
boolean If true, restrict the quality to media element size. Note: The use of ResizeObserver is required for it to work properly. If true without ResizeObserver, it behaves as false. Defaults false.
getter/setter pair
-
restrictToScreenSize
↔ bool
-
boolean If true, restrict the quality to screen size. Defaults false.
getter/setter pair
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
safeMarginSwitch
↔ num?
-
number Optional amount of buffer (in seconds) to retain when clearing the buffer during the automatic switch. Useful for switching variant quickly without causing a buffering event. Defaults to 0 if not provided. Ignored if clearBuffer is false. Can cause hiccups on some browsers if chosen too small, e.g. The amount of two segments is a fair minimum to consider as safeMargin value.
getter/setter pair
-
switchInterval
↔ num
-
number The minimum amount of time that must pass between switches, in seconds. This keeps us from changing too often and annoying the user.
getter/setter pair
-
useNetworkInformation
↔ bool
-
boolean If true, use Network Information API in the current AbrManager. Defaults to true.
getter/setter pair
Methods
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
