StreamingConfiguration class
- Annotations
-
- @JS('StreamingConfiguration')
Properties
-
alwaysStreamText
↔ bool
-
boolean If true, always stream text tracks, regardless of whether or not they are shown. This is necessary when using the browser's built-in controls, which are not capable of signaling display state changes back to Shaka Player. Defaults to false.
getter/setter pair
-
autoLowLatencyMode
↔ bool
-
boolean If the stream is low latency and the user has not configured the lowLatencyMode, but if it has been configured to activate the lowLatencyMode if a stream of this type is detected, we automatically activate the lowLatencyMode. Defaults to false.
getter/setter pair
-
bufferBehind
↔ num
-
number The maximum number of seconds of content that the StreamingEngine will keep in buffer behind the playhead when it appends a new media segment. The StreamingEngine will evict content to meet this limit.
getter/setter pair
-
bufferingGoal
↔ num
-
number The number of seconds of content that the StreamingEngine will attempt to buffer ahead of the playhead. This value must be greater than or equal to the rebuffering goal.
getter/setter pair
-
dispatchAllEmsgBoxes
↔ bool
-
boolean If true, all emsg boxes are parsed and dispatched.
getter/setter pair
-
durationBackoff
↔ num
-
number By default, we will not allow seeking to exactly the duration of a presentation. This field is the number of seconds before duration we will seek to when the user tries to seek to or start playback at the duration. To disable this behavior, the config can be set to 0. We recommend using the default value unless you have a good reason not to.
getter/setter pair
-
failureCallback
↔ JSFunction
-
function A callback to decide what to do on a streaming failure. Default behavior is to retry on live streams and not on VOD.
getter/setter pair
-
forceHTTPS
↔ bool
-
boolean If true, if the protocol is HTTP change it to HTTPs.
getter/setter pair
-
gapDetectionThreshold
↔ num
-
number The maximum distance (in seconds) before a gap when we'll automatically jump. This value defaults to 0.5.
getter/setter pair
-
gapJumpTimerTime
↔ num
-
number The polling time in seconds to check for gaps in the media. This value defaults to 0.25.
getter/setter pair
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
ignoreTextStreamFailures
↔ bool
-
boolean If true, the player will ignore text stream failures and continue playing other streams.
getter/setter pair
-
inaccurateManifestTolerance
↔ num
-
number The maximum difference, in seconds, between the times in the manifest and the times in the segments. Larger values allow us to compensate for more drift (up to one segment duration). Smaller values reduce the incidence of extra segment requests necessary to compensate for drift.
getter/setter pair
-
liveSync
↔ bool
-
boolean Enable the live stream sync against the live edge by changing the playback rate. Defaults to false. Note: on some SmartTVs, if this is activated, it may not work or the sound may be lost when activated.
getter/setter pair
-
liveSyncMaxLatency
↔ num
-
number Maximum acceptable latency, in seconds. Effective only if liveSync is true. Defaults to 1.
getter/setter pair
-
liveSyncPlaybackRate
↔ num
-
number Playback rate used for latency chasing. It is recommended to use a value between 1 and 2. Effective only if liveSync is true. Defaults to 1.1.
getter/setter pair
-
lowLatencyMode
↔ bool
-
boolean If true, low latency streaming mode is enabled. If lowLatencyMode is set to true, inaccurateManifestTolerance is set to 0 unless specified, and rebufferingGoal to 0.01 unless specified at the same time.
getter/setter pair
-
maxDisabledTime
↔ num
-
number The maximum time a variant can be disabled when NETWORK HTTP_ERROR is reached, in seconds. If all variants are disabled this way, NETWORK HTTP_ERROR will be thrown.
getter/setter pair
-
observeQualityChanges
↔ bool
-
boolean If true, monitor media quality changes and emit .
getter/setter pair
-
parsePrftBox
↔ bool
-
boolean If true, will raise a shaka.extern.ProducerReferenceTime player event (event name 'prft'). The event will be raised only once per playback session as program start date will not change, and would save parsing the segment multiple times needlessly. Defaults to false.
getter/setter pair
-
preferNativeHls
↔ bool
-
boolean If true, prefer native HLS playback when possible, regardless of platform.
getter/setter pair
-
rebufferingGoal
↔ num
-
number The minimum number of seconds of content that the StreamingEngine must buffer before it can begin playback or can continue playback after it has entered into a buffering state (i.e., after it has depleted one more more of its buffers).
getter/setter pair
-
retryParameters
↔ RetryParameters
-
shaka.extern.RetryParameters Retry parameters for segment requests.
getter/setter pair
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
safeSeekOffset
↔ num
-
number The amount of seconds that should be added when repositioning the playhead after falling out of the availability window or seek. This gives the player more time to buffer before falling outside again, but increases the forward jump in the stream skipping more content. This is helpful for lower bandwidth scenarios. Defaults to 5 if not provided.
getter/setter pair
-
segmentPrefetchLimit
↔ bool
-
boolean The maximum number of segments for each active stream to be prefetched ahead of playhead in parallel. If 0, the segments will be fetched sequentially. Defaults to 0.
getter/setter pair
-
stallEnabled
↔ bool
-
boolean When set to true, the stall detector logic will run. If the playhead stops moving for stallThreshold seconds, the player will either seek or pause/play to resolve the stall, depending on the value of stallSkip.
getter/setter pair
-
stallSkip
↔ num
-
number The number of seconds that the player will skip forward when a stall has been detected. If 0, the player will pause and immediately play instead of seeking. A value of 0 is recommended and provided as default on TV platforms (WebOS, Tizen, Chromecast, etc).
getter/setter pair
-
stallThreshold
↔ num
-
number The maximum number of seconds that may elapse without the playhead moving (when playback is expected) before it will be labeled as a stall.
getter/setter pair
-
startAtSegmentBoundary
↔ bool
-
boolean If true, adjust the start time backwards so it is at the start of a segment. This affects both explicit start times and calculated start time for live streams. This can put us further from the live edge. Defaults to false.
getter/setter pair
-
updateIntervalSeconds
↔ num
-
number The minimum number of seconds to see if the manifest has changes.
getter/setter pair
-
useNativeHlsOnSafari
↔ num
-
boolean Desktop Safari has both MediaSource and their native HLS implementation. Depending on the application's needs, it may prefer one over the other. Warning when disabled: Where single-key DRM streams work fine, multi-keys streams is showing unexpected behaviours (stall, audio playing with video freezes, ...). Use with care.
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
