Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TweaksConfig

The tweaks configuration is used as an incubator for experimental features and also contains features implemented for specific customers that might not make it into the officially supported feature set.

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. Tweaks are often proof-of-concepts that are quickly implemented for urgent needs of customers. They often do not go through an architectural review and are therefore not signed and approved by the architecture team.

Example:

tweaks : {
  autoqualityswitching : true,
  max_buffer_level     : 20,
  search_real_end      : false,
  query_parameters : {
    key1: 'value1',
    key2: 'value2',
    mycustomname: 'another-value'
  }
}

Hierarchy

  • TweaksConfig

Index

Properties

ad_video_load_timeout

ad_video_load_timeout: number

Set the timeout in milliseconds to cancel a loading ad.

Optional adaptation_set_switching_without_supplemental_property

adaptation_set_switching_without_supplemental_property: boolean

Groups adaptation sets and switches between them based on their group attribute instead of the recommended SupplementalProperty urn:mpeg:dash:adaptation-set-switching:2016. Default is false.

since

7.8.10

Optional autoqualityswitching

autoqualityswitching: boolean

Determines if the automatic quality switching is enabled on startup (true, default).

Optional disable_mpeg2ts_silence_insertion

disable_mpeg2ts_silence_insertion: boolean

When converting mpeg2ts to mp4 segments we insert silence if we detect a drift between audio and video data to avoid getting out of sync. This tweak disables this functionality.

Optional hls_audio_only_threshold_bitrate

hls_audio_only_threshold_bitrate: number

All HLS variants with a bitrate lower than the given bitrate in bits per second (bps) are considered audio-only variants and removed if there is at least one with a higher bitrate.

Optional hwdecoding

hwdecoding: boolean

Enable or disable (false, default) hardware-supported video decoding for the Flash fallback. Enabling this might lead to decoding artefacts, but can improve performance.

Optional impressionServer

impressionServer: string

Sets the impression server to the given URL if it is included in PlayerAPI.getAvailableImpressionServers. Default is the first entry of the available impression servers.

Optional licenseServer

licenseServer: string

Sets the license server to the given URL if it is included in PlayerAPI.getAvailableLicenseServers. Default is the first entry of the available license servers.

Optional log_level

log_level: LogLevel

Sets the LOG_LEVEL of the player by calling PlayerAPI.setLogLevel.

Optional max_buffer_level

max_buffer_level: number

Changes the maximum buffer level in seconds. Default is 40 seconds. For live streams the lowest value of playlist duration for HLS, timeShiftBufferDepth for DASH and the max_buffer_level is used as a maximum value for the buffer.

Optional native_hls_download_error_handling

native_hls_download_error_handling: boolean

If enabled the native player used for HLS in Safari would fetch and parse the HLS playlist and trigger an onError event if the download of a segment fails and the playback stalls. Default is false.

Optional native_hls_parsing

native_hls_parsing: boolean

If enabled the native player used for HLS in Safari would fetch and parse the HLS playlist and trigger {@link Events.ON_SEGMENT_PLAYBACK} events carrying segment-specific metadata like #EXT-X-PROGRAM-DATE-TIME if present in the manifest. Default is false.

Optional preferred_audio_codec_order

preferred_audio_codec_order: string[]

A list of audio codecs defining the preferred order. If a stream has multiple audio codec definitions in the manifest for the same lang, the one which matches the lowest index in this list and is supported by the current browser will be taken as default. The other ones will still be available for selection. If none of the available codecs match anything in this list, the first one in the manifest which is supported by the current browser will be taken. Default value: ['ec-3', 'mp4a.a6', 'ac-3', 'mp4a.a5', 'mp4a.40']

Optional preferred_video_codec_order

preferred_video_codec_order: string[]

A list of video codecs defining the preferred order. If there are multiple video adaptation sets defined in the manifest (inside one Period), the codecs from the Representations will be compared against this list. The lowest matching index which is supported by the current browser determines the chosen Adaptation Set. If no codec in this list matches the available codecs, the first codec in the manifest which is supported by the current browser will be taken. Default value: ['av1', 'hevc', 'hvc', 'vp9', 'avc']

Optional query_parameters

query_parameters: QueryParameters

Query parameters are added as GET parameters to all request URLs (e.g. manifest, media segments, subtitle files, …). Query_parameters should be an object with key value pairs, where the keys are used as parameter name and the values as parameter values.

Example:

query_parameters : {
  key1: 'value1',
  key2: 'value2',
  mycustomname: 'another-value'
}

The example above would be translated into MY_REQUEST_URL?key1=value1&key2=value2&mycustomname=another-value.

Optional restart_threshold

restart_threshold: number

Amount of seconds the player buffers before playback starts again after a stall. Default is 0.9 seconds. This value is restricted to the maximum value of the buffer minus 0.5 seconds.

Optional search_real_end

search_real_end: boolean

If set to true, the mediaPresentationDuration (the total duration of the video) in the MPD is ignored and the video is played until no more segments are available. This enables playback of MPDs with a wrong mediaPresentationDuration. Default is false.

deprecated

Optional startup_threshold

startup_threshold: number

Amount of seconds the player buffers before playback starts. Default is 0.9 seconds. This value is restricted to the maximum value of the buffer minus 0.5 seconds.

Optional stop_download_on_pause

stop_download_on_pause: boolean

Enabling this flag prevents the player from downloading any further resource (playlist, segments, ...), when the player is paused. Already issued requests will be finished. Default is false.

Generated using TypeDoc