Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix JSDoc in Settings.js #4214

Merged
merged 1 commit into from
Jun 16, 2023
Merged

Fix JSDoc in Settings.js #4214

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
46 changes: 23 additions & 23 deletions src/core/Settings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ import Events from './events/Events';
* abandonLoadTimeout: 10000,
* wallclockTimeUpdateInterval: 100,
* manifestUpdateRetryInterval: 100,
* cacheInitSegments: true,
* cacheInitSegments: false,
* applyServiceDescription: true,
* applyProducerReferenceTime: true,
* applyContentSteering: true,
Expand Down Expand Up @@ -92,7 +92,7 @@ import Events from './events/Events';
* detectPlayreadyMessageFormat: true,
* },
* buffer: {
* enableSeekDecorrelationFix: true,
* enableSeekDecorrelationFix: false,
* fastSwitchEnabled: true,
* flushBufferAtTrackSwitch: false,
* reuseExistingSourceBuffers: true,
Expand All @@ -103,7 +103,7 @@ import Events from './events/Events';
* initialBufferLevel: NaN,
* stableBufferTime: 12,
* longFormContentDurationThreshold: 600,
* stallThreshold: 0.5,
* stallThreshold: 0.3,
* useAppendWindow: true,
* setStallState: true,
* avoidCurrentTimeRangePruning: false,
Expand Down Expand Up @@ -134,8 +134,8 @@ import Events from './events/Events';
* }
* },
* scheduling: {
* defaultTimeout: 300,
* lowLatencyTimeout: 100,
* defaultTimeout: 500,
* lowLatencyTimeout: 0,
* scheduleWhilePaused: true
* },
* text: {
Expand All @@ -149,7 +149,7 @@ import Events from './events/Events';
* maxDrift: NaN,
* playbackRate: {min: NaN, max: NaN},
* playbackBufferMin: 0.5,
* enabled: false,
* enabled: null,
* mode: Constants.LIVE_CATCHUP_MODE_DEFAULT
* },
* lastBitrateCachingInfo: { enabled: true, ttl: 360000 },
Expand Down Expand Up @@ -191,10 +191,10 @@ import Events from './events/Events';
* movingAverageMethod: Constants.MOVING_AVERAGE_SLIDING_WINDOW,
* ABRStrategy: Constants.ABR_STRATEGY_DYNAMIC,
* additionalAbrRules: {
* insufficientBufferRule: false,
* insufficientBufferRule: true,
* switchHistoryRule: true,
* droppedFramesRule: true,
* abandonRequestsRule: false
* abandonRequestsRule: true
* },
* bandwidthSafetyFactor: 0.9,
* useDefaultABRRules: true,
Expand Down Expand Up @@ -250,7 +250,7 @@ import Events from './events/Events';
* The detected segment duration will be multiplied by this value to define a time in seconds to delay a live stream from the live edge.
*
* Lowering this value will lower latency but may decrease the player's ability to build a stable buffer.
* @property {number} [liveDelay]
* @property {number} [liveDelay=NaN]
* Equivalent in seconds of setLiveDelayFragmentCount.
*
* Lowering this value will lower latency but may decrease the player's ability to build a stable buffer.
Expand Down Expand Up @@ -450,17 +450,17 @@ import Events from './events/Events';

/**
* @typedef {Object} Scheduling
* @property {number} [defaultTimeout=300]
* @property {number} [defaultTimeout=500]
* Default timeout between two consecutive segment scheduling attempts
* @property {number} [lowLatencyTimeout]
* @property {number} [lowLatencyTimeout=0]
* Default timeout between two consecutive low-latency segment scheduling attempts
* @property {boolean} [scheduleWhilePaused=true]
* Set to true if you would like dash.js to keep downloading fragments in the background when the video element is paused.
*/

/**
* @typedef {Object} Text
* @property {number} [defaultEnabled=true]
* @property {boolean} [defaultEnabled=true]
* Enable/disable subtitle rendering by default.
* @property {boolean} [extendSegmentedCues=true]
* Enable/disable patching of segmented cues in order to merge as a single cue by extending cue end time.
Expand Down Expand Up @@ -495,11 +495,11 @@ import Events from './events/Events';
* These playback rate limits take precedence over any PlaybackRate values in ServiceDescription elements in an MPD. If only one of the min/max properties is given a value, the property without a value will not fall back to a ServiceDescription value. Its default value of NaN will be used.
*
* Note: Catch-up mechanism is only applied when playing low latency live streams.
* @property {number} [playbackBufferMin=NaN]
* @property {number} [playbackBufferMin=0.5]
* Use this parameter to specify the minimum buffer which is used for LoL+ based playback rate reduction.
*
*
* @property {boolean} [enabled=false]
* @property {boolean} [enabled=null]
* Use this parameter to enable the catchup mode for non low-latency streams.
*
* @property {string} [mode="liveCatchupModeDefault"]
Expand Down Expand Up @@ -544,10 +544,10 @@ import Events from './events/Events';
* Set the value for the ProtectionController and MediaKeys life cycle.
*
* If true, the ProtectionController and then created MediaKeys and MediaKeySessions will be preserved during the MediaPlayer lifetime.
* @property {boolean} ignoreEmeEncryptedEvent
* @property {boolean} [ignoreEmeEncryptedEvent=false]
* If set to true the player will ignore "encrypted" and "needkey" events thrown by the EME.
*
* @property {boolean} detectPlayreadyMessageFormat
* @property {boolean} [detectPlayreadyMessageFormat=true]
* If set to true the player will use the raw unwrapped message from the Playready CDM
*/

Expand Down Expand Up @@ -584,7 +584,7 @@ import Events from './events/Events';
* @property {string} [ABRStrategy="abrDynamic"]
* Returns the current ABR strategy being used: "abrDynamic", "abrBola" or "abrThroughput".
* @property {object} [trackSwitchMode={video: "neverReplace", audio: "alwaysReplace"}]
* @property {object} [additionalAbrRules={insufficientBufferRule: false,switchHistoryRule: true,droppedFramesRule: true,abandonRequestsRule: false}]
* @property {object} [additionalAbrRules={insufficientBufferRule: true,switchHistoryRule: true,droppedFramesRule: true,abandonRequestsRule: true}]
* Enable/Disable additional ABR rules in case ABRStrategy is set to "abrDynamic", "abrBola" or "abrThroughput".
* @property {number} [bandwidthSafetyFactor=0.9]
* Standard ABR throughput rules multiply the throughput by this value.
Expand Down Expand Up @@ -655,11 +655,11 @@ import Events from './events/Events';
* The requested maximum throughput that the client considers sufficient for delivery of the asset.
*
* If not specified this value will be dynamically calculated in the CMCDModel based on the current buffer level.
* @property {number} [rtpSafetyFactor]
* @property {number} [rtpSafetyFactor=5]
* This value is used as a factor for the rtp value calculation: rtp = minBandwidth * rtpSafetyFactor
*
* If not specified this value defaults to 5. Note that this value is only used when no static rtp value is defined.
* @property {number} [mode]
* @property {number} [mode="query"]
* The method to use to attach cmcd metrics to the requests. 'query' to use query parameters, 'header' to use http headers.
*
* If not specified this value defaults to 'query'.
Expand Down Expand Up @@ -695,11 +695,11 @@ import Events from './events/Events';
* A timeout value in seconds, which during the ABRController will block switch-up events.
*
* This will only take effect after an abandoned fragment event occurs.
* @property {number} [wallclockTimeUpdateInterval=50]
* @property {number} [wallclockTimeUpdateInterval=100]
* How frequently the wallclockTimeUpdated internal event is triggered (in milliseconds).
* @property {number} [manifestUpdateRetryInterval=100]
* For live streams, set the interval-frequency in milliseconds at which dash.js will check if the current manifest is still processed before downloading the next manifest once the minimumUpdatePeriod time has.
* @property {boolean} [cacheInitSegments=true]
* @property {boolean} [cacheInitSegments=false]
* Enables the caching of init segments to avoid requesting the init segments before each representation switch.
* @property {boolean} [applyServiceDescription=true]
* Set to true if dash.js should use the parameters defined in ServiceDescription elements
Expand Down Expand Up @@ -745,7 +745,7 @@ import Events from './events/Events';
* - Constants.TRACK_SWITCH_MODE_NEVER_REPLACE
* Do not replace existing segments in the buffer
*
* @property {string} [selectionModeForInitialTrack="highestBitrate"]
* @property {string} [selectionModeForInitialTrack="highestSelectionPriority"]
* Sets the selection mode for the initial track. This mode defines how the initial track will be selected if no initial media settings are set. If initial media settings are set this parameter will be ignored. Available options are:
*
* Possible values
Expand Down Expand Up @@ -1007,7 +1007,7 @@ function Settings() {
rtp: null,
rtpSafetyFactor: 5,
mode: Constants.CMCD_MODE_QUERY,
enabledKeys: ['br', 'd', 'ot', 'tb' , 'bl', 'dl', 'mtp', 'nor', 'nrr', 'su' , 'bs', 'rtp' , 'cid', 'pr', 'sf', 'sid', 'st', 'v']
enabledKeys: ['br', 'd', 'ot', 'tb', 'bl', 'dl', 'mtp', 'nor', 'nrr', 'su', 'bs', 'rtp', 'cid', 'pr', 'sf', 'sid', 'st', 'v']
},
cmsd: {
enabled: false,
Expand Down