# All files / src config.ts

75% Statements 3/4
50% Branches 7/14
100% Functions 1/1
75% Lines 3/4

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265

    1x

    1x

    1x

     /**
     * HLS config
     */

    import AbrController from './controller/abr-controller';
    import BufferController from './controller/buffer-controller';
    import CapLevelController from './controller/cap-level-controller';
    import FPSController from './controller/fps-controller';
    import XhrLoader from './utils/xhr-loader';
    // import FetchLoader from './utils/fetch-loader';

    import AudioTrackController from './controller/audio-track-controller';
    import AudioStreamController from './controller/audio-stream-controller';

    import * as Cues from './utils/cues';
    import TimelineController from './controller/timeline-controller';
    import SubtitleTrackController from './controller/subtitle-track-controller';
    import { SubtitleStreamController } from './controller/subtitle-stream-controller';
    import EMEController from './controller/eme-controller';
    import { requestMediaKeySystemAccess, MediaKeyFunc } from './utils/mediakeys-helper';

    type ABRControllerConfig = {
      abrEwmaFastLive: number,
      abrEwmaSlowLive: number,
      abrEwmaFastVoD: number,
      abrEwmaSlowVoD: number,
      abrEwmaDefaultEstimate: number,
      abrBandWidthFactor: number,
      abrBandWidthUpFactor: number,
      abrMaxWithRealBitrate: boolean,
      maxStarvationDelay: number,
      maxLoadingDelay: number,
    };

    export type BufferControllerConfig = {
      appendErrorMaxRetry: number,
      liveDurationInfinity: boolean,
      liveBackBufferLength: number,
    };

    type CapLevelControllerConfig = {
      capLevelToPlayerSize: boolean
    };

    export type EMEControllerConfig = {
      licenseXhrSetup?: (xhr: XMLHttpRequest, url: string) => void,
      emeEnabled: boolean,
      widevineLicenseUrl?: string,
      requestMediaKeySystemAccessFunc: MediaKeyFunc | null,
    };

    type FragmentLoaderConfig = {
      fLoader: any, // TODO(typescript-loader): Once Loader is typed fill this in

      fragLoadingTimeOut: number,
      fragLoadingMaxRetry: number,
      fragLoadingRetryDelay: number,
      fragLoadingMaxRetryTimeout: number,
    };

    type FPSControllerConfig = {
      capLevelOnFPSDrop: boolean,
      fpsDroppedMonitoringPeriod: number,
      fpsDroppedMonitoringThreshold: number,
    };

    type LevelControllerConfig = {
      startLevel?: number
    };

    type MP4RemuxerConfig = {
      stretchShortVideoTrack: boolean,
      maxAudioFramesDrift: number,
    };

    type PlaylistLoaderConfig = {
      pLoader: any, // TODO(typescript-loader): Once Loader is typed fill this in

      manifestLoadingTimeOut: number,
      manifestLoadingMaxRetry: number,
      manifestLoadingRetryDelay: number,
      manifestLoadingMaxRetryTimeout: number,

      levelLoadingTimeOut: number,
      levelLoadingMaxRetry: number,
      levelLoadingRetryDelay: number,
      levelLoadingMaxRetryTimeout: number
    };

    type StreamControllerConfig = {
      autoStartLoad: boolean,
      startPosition: number,
      defaultAudioCodec?: string,
      initialLiveManifestSize: number,
      maxBufferLength: number,
      maxBufferSize: number,
      maxBufferHole: number,

      lowBufferWatchdogPeriod: number,
      highBufferWatchdogPeriod: number,
      nudgeOffset: number,
      nudgeMaxRetry: number,
      maxFragLookUpTolerance: number,
      liveSyncDurationCount: number,
      liveMaxLatencyDurationCount: number,
      liveSyncDuration?: number,
      liveMaxLatencyDuration?: number,
      maxMaxBufferLength: number,

      startFragPrefetch: boolean,
    };

    type TimelineControllerConfig = {
      cueHandler: any, // TODO(typescript-cues): Type once file is done
      enableCEA708Captions: boolean,
      enableWebVTT: boolean,
      captionsTextTrack1Label: string,
      captionsTextTrack1LanguageCode: string,
      captionsTextTrack2Label: string,
      captionsTextTrack2LanguageCode: string,
    };

    type TSDemuxerConfig = {
      forceKeyFrameOnDiscontinuity: boolean,
    };

    export type HlsConfig =
      {
        debug: boolean,
        enableWorker: boolean,
        enableSoftwareAES: boolean,
        minAutoBitrate: number,
        loader: any, // TODO(typescript-xhrloader): Type once XHR is done
        xhrSetup?: (xhr: XMLHttpRequest, url: string) => void,

        // Alt Audio
        audioStreamController?: any, // TODO(typescript-audiostreamcontroller): Type once file is done
        audioTrackController?: any, // TODO(typescript-audiotrackcontroller): Type once file is done
        // Subtitle
        subtitleStreamController?: any, // TODO(typescript-subtitlestreamcontroller): Type once file is done
        subtitleTrackController?: any, // TODO(typescript-subtitletrackcontroller): Type once file is done
        timelineController?: any, // TODO(typescript-timelinecontroller): Type once file is done
        // EME
        emeController?: typeof EMEController,

        abrController: any, // TODO(typescript-abrcontroller): Type once file is done
        bufferController: typeof BufferController,
        capLevelController: any, // TODO(typescript-caplevelcontroller): Type once file is done
        fpsController: any, // TODO(typescript-fpscontroller): Type once file is done
      } &
      ABRControllerConfig &
      BufferControllerConfig &
      CapLevelControllerConfig &
      EMEControllerConfig &
      FPSControllerConfig &
      FragmentLoaderConfig &
      LevelControllerConfig &
      MP4RemuxerConfig &
      PlaylistLoaderConfig &
      StreamControllerConfig &
      Partial<TimelineControllerConfig> &
      TSDemuxerConfig;

    // If possible, keep hlsDefaultConfig shallow
    // It is cloned whenever a new Hls instance is created, by keeping the config
    // shallow the properties are cloned, and we don't end up manipulating the default
    export const hlsDefaultConfig: HlsConfig = {
      autoStartLoad: true, // used by stream-controller
      startPosition: -1, // used by stream-controller
      defaultAudioCodec: void 0, // used by stream-controller
      debug: false, // used by logger
      capLevelOnFPSDrop: false, // used by fps-controller
      capLevelToPlayerSize: false, // used by cap-level-controller
      initialLiveManifestSize: 1, // used by stream-controller
      maxBufferLength: 30, // used by stream-controller
      maxBufferSize: 60 * 1000 * 1000, // used by stream-controller
      maxBufferHole: 0.5, // used by stream-controller

      lowBufferWatchdogPeriod: 0.5, // used by stream-controller
      highBufferWatchdogPeriod: 3, // used by stream-controller
      nudgeOffset: 0.1, // used by stream-controller
      nudgeMaxRetry: 3, // used by stream-controller
      maxFragLookUpTolerance: 0.25, // used by stream-controller
      liveSyncDurationCount: 3, // used by stream-controller
      liveMaxLatencyDurationCount: Infinity, // used by stream-controller
      liveSyncDuration: void 0, // used by stream-controller
      liveMaxLatencyDuration: void 0, // used by stream-controller
      liveDurationInfinity: false, // used by buffer-controller
      liveBackBufferLength: Infinity, // used by buffer-controller
      maxMaxBufferLength: 600, // used by stream-controller
      enableWorker: true, // used by demuxer
      enableSoftwareAES: true, // used by decrypter
      manifestLoadingTimeOut: 10000, // used by playlist-loader
      manifestLoadingMaxRetry: 1, // used by playlist-loader
      manifestLoadingRetryDelay: 1000, // used by playlist-loader
      manifestLoadingMaxRetryTimeout: 64000, // used by playlist-loader
      startLevel: void 0, // used by level-controller
      levelLoadingTimeOut: 10000, // used by playlist-loader
      levelLoadingMaxRetry: 4, // used by playlist-loader
      levelLoadingRetryDelay: 1000, // used by playlist-loader
      levelLoadingMaxRetryTimeout: 64000, // used by playlist-loader
      fragLoadingTimeOut: 20000, // used by fragment-loader
      fragLoadingMaxRetry: 6, // used by fragment-loader
      fragLoadingRetryDelay: 1000, // used by fragment-loader
      fragLoadingMaxRetryTimeout: 64000, // used by fragment-loader
      startFragPrefetch: false, // used by stream-controller
      fpsDroppedMonitoringPeriod: 5000, // used by fps-controller
      fpsDroppedMonitoringThreshold: 0.2, // used by fps-controller
      appendErrorMaxRetry: 3, // used by buffer-controller
      loader: XhrLoader,
      // loader: FetchLoader,
      fLoader: void 0, // used by fragment-loader
      pLoader: void 0, // used by playlist-loader
      xhrSetup: void 0, // used by xhr-loader
      licenseXhrSetup: void 0, // used by eme-controller
      // fetchSetup: void 0,
      abrController: AbrController,
      bufferController: BufferController,
      capLevelController: CapLevelController,
      fpsController: FPSController,
      stretchShortVideoTrack: false, // used by mp4-remuxer
      maxAudioFramesDrift: 1, // used by mp4-remuxer
      forceKeyFrameOnDiscontinuity: true, // used by ts-demuxer
      abrEwmaFastLive: 3, // used by abr-controller
      abrEwmaSlowLive: 9, // used by abr-controller
      abrEwmaFastVoD: 3, // used by abr-controller
      abrEwmaSlowVoD: 9, // used by abr-controller
      abrEwmaDefaultEstimate: 5e5, // 500 kbps  // used by abr-controller
      abrBandWidthFactor: 0.95, // used by abr-controller
      abrBandWidthUpFactor: 0.7, // used by abr-controller
      abrMaxWithRealBitrate: false, // used by abr-controller
      maxStarvationDelay: 4, // used by abr-controller
      maxLoadingDelay: 4, // used by abr-controller
      minAutoBitrate: 0, // used by hls
      emeEnabled: false, // used by eme-controller
      widevineLicenseUrl: void 0, // used by eme-controller
      requestMediaKeySystemAccessFunc: requestMediaKeySystemAccess, // used by eme-controller

      // Dynamic Modules
      ...timelineConfig(),
      subtitleStreamController: (__USE_SUBTITLES__) ? SubtitleStreamController : void 0,
      subtitleTrackController: (__USE_SUBTITLES__) ? SubtitleTrackController : void 0,
      timelineController: (__USE_SUBTITLES__) ? TimelineController : void 0,
      audioStreamController: (__USE_ALT_AUDIO__) ? AudioStreamController : void 0,
      audioTrackController: (__USE_ALT_AUDIO__) ? AudioTrackController : void 0,
      emeController: (__USE_EME_DRM__) ? EMEController : void 0
    };

    function timelineConfig (): TimelineControllerConfig {
      Iif (!__USE_SUBTITLES__) {
        // intentionally doing this over returning Partial<TimelineControllerConfig> above
        // this has the added nice property of still requiring the object below to completely define all props.
        return {} as any;
      }
      return {
        cueHandler: Cues, // used by timeline-controller
        enableCEA708Captions: true, // used by timeline-controller
        enableWebVTT: true, // used by timeline-controller
        captionsTextTrack1Label: 'English', // used by timeline-controller
        captionsTextTrack1LanguageCode: 'en', // used by timeline-controller
        captionsTextTrack2Label: 'Spanish', // used by timeline-controller
        captionsTextTrack2LanguageCode: 'es' // used by timeline-controller
      };
    }