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.

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

feat: Set baseDelay to 100 by default for low latency streaming #5926

Merged
merged 1 commit into from
Nov 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 23 additions & 7 deletions docs/tutorials/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,20 +123,36 @@ buffering settings) while some will not have any effect until the next call to

With `.streaming.lowLatencyMode` set to true,
`.streaming.inaccurateManifestTolerance` is set to 0 by default,
`.streaming.rebufferingGoal` is set to 0.01 by default, and
`.streaming.segmentPrefetchLimit` is set to 2 by default.

To customize the values of inaccurateManifestTolerance, rebufferingGoal and
segmentPrefetchLimit with low latency mode, you can set the fields in the same
or subsequent call to configure().
`.streaming.rebufferingGoal` is set to 0.01 by default,
`.streaming.segmentPrefetchLimit` is set to 2 by default,
`.streaming.retryParameters.baseDelay` is set to 100 by default,
`.manifest.retryParameters.baseDelay` is set to 100 by default, and
`.drm.retryParameters.baseDelay` is set to 100 by default.

To customize the values of inaccurateManifestTolerance, rebufferingGoal,
segmentPrefetchLimit and baseDelay with low latency mode, you can set the
fields in the same or subsequent call to configure().
```js
player.configure({
streaming: {
lowLatencyMode: true,
inaccurateManifestTolerance: 0,
rebufferingGoal: 0.01,
segmentPrefetchLimit: 2,
}
retryParameters: {
baseDelay: 100,
},
},
manifest: {
retryParameters: {
baseDelay: 100,
},
},
drm: {
retryParameters: {
baseDelay: 100,
},
},
});

```
Expand Down
31 changes: 28 additions & 3 deletions lib/player.js
Original file line number Diff line number Diff line change
Expand Up @@ -2980,9 +2980,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
}

// If lowLatencyMode is enabled, and inaccurateManifestTolerance and
// rebufferingGoal and segmentPrefetchLimit are not specified, set
// inaccurateManifestTolerance to 0 and rebufferingGoal to 0.01 and
// segmentPrefetchLimit to 2 by default for low latency streaming.
// rebufferingGoal and segmentPrefetchLimit and baseDelay are not
// specified, set inaccurateManifestTolerance to 0 and rebufferingGoal
// to 0.01 and segmentPrefetchLimit to 2 and baseDelay to 100 by default
// for low latency streaming.
if (config['streaming'] && config['streaming']['lowLatencyMode']) {
if (config['streaming']['inaccurateManifestTolerance'] == undefined) {
config['streaming']['inaccurateManifestTolerance'] = 0;
Expand All @@ -2993,6 +2994,30 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
if (config['streaming']['segmentPrefetchLimit'] == undefined) {
config['streaming']['segmentPrefetchLimit'] = 2;
}
if (config['streaming']['retryParameters'] == undefined) {
config['streaming']['retryParameters'] = {};
}
if (config['streaming']['retryParameters']['baseDelay'] == undefined) {
config['streaming']['retryParameters']['baseDelay'] = 100;
}
if (config['manifest'] == undefined) {
config['manifest'] = {};
}
if (config['manifest']['retryParameters'] == undefined) {
config['manifest']['retryParameters'] = {};
}
if (config['manifest']['retryParameters']['baseDelay'] == undefined) {
config['manifest']['retryParameters']['baseDelay'] = 100;
}
if (config['drm'] == undefined) {
config['drm'] = {};
}
if (config['drm']['retryParameters'] == undefined) {
config['drm']['retryParameters'] = {};
}
if (config['drm']['retryParameters']['baseDelay'] == undefined) {
config['drm']['retryParameters']['baseDelay'] = 100;
}
}
const ret = shaka.util.PlayerConfiguration.mergeConfigObjects(
this.config_, config, this.defaultConfig_());
Expand Down
25 changes: 25 additions & 0 deletions test/player_unit.js
Original file line number Diff line number Diff line change
Expand Up @@ -1178,12 +1178,31 @@ describe('Player', () => {
rebufferingGoal: 1,
inaccurateManifestTolerance: 1,
segmentPrefetchLimit: 1,
retryParameters: {
baseDelay: 2000,
},
},
manifest: {
retryParameters: {
baseDelay: 2000,
},
},
drm: {
retryParameters: {
baseDelay: 2000,
},
},
});
expect(player.getConfiguration().streaming.rebufferingGoal).toBe(1);
expect(player.getConfiguration().streaming.inaccurateManifestTolerance)
.toBe(1);
expect(player.getConfiguration().streaming.segmentPrefetchLimit).toBe(1);
expect(player.getConfiguration().streaming.retryParameters.baseDelay)
.toBe(2000);
expect(player.getConfiguration().manifest.retryParameters.baseDelay)
.toBe(2000);
expect(player.getConfiguration().drm.retryParameters.baseDelay)
.toBe(2000);

// When low latency streaming gets enabled, rebufferingGoal will default
// to 0.01 if unless specified, inaccurateManifestTolerance will
Expand All @@ -1194,6 +1213,12 @@ describe('Player', () => {
expect(player.getConfiguration().streaming.inaccurateManifestTolerance)
.toBe(0);
expect(player.getConfiguration().streaming.segmentPrefetchLimit).toBe(2);
expect(player.getConfiguration().streaming.retryParameters.baseDelay)
.toBe(100);
expect(player.getConfiguration().manifest.retryParameters.baseDelay)
.toBe(100);
expect(player.getConfiguration().drm.retryParameters.baseDelay)
.toBe(100);
});
});

Expand Down
Loading