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

Rename a function with a confusing name #2443

Merged
merged 1 commit into from
Sep 17, 2022
Merged

Rename a function with a confusing name #2443

Show file tree
Hide file tree
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

- Fix a confusing function name from `millisecondsPerSecond` to `averageTimeSpentPerSecondInMilliseconds`.

### Fixed

- Use a default "playback" `latencyHint` when creating the `AudioContext` on Windows. Also adds a `setDefaultLatencyHint` API to `DefaultDeviceController` to allow for overriding.
Expand Down
6 changes: 3 additions & 3 deletions docs/assets/js/search.js
View file
Open in desktop

Large diffs are not rendered by default.

60 changes: 30 additions & 30 deletions docs/classes/clientmetricreport.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ <h3>Properties</h3>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#averagetimespentpersecondinmilliseconds" class="tsd-kind-icon">average<wbr>Time<wbr>Spent<wbr>Per<wbr>Second<wbr>InMilliseconds</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#bitspersecond" class="tsd-kind-icon">bits<wbr>Per<wbr>Second</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#clone" class="tsd-kind-icon">clone</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#countpersecond" class="tsd-kind-icon">count<wbr>Per<wbr>Second</a></li>
Expand All @@ -127,7 +128,6 @@ <h3>Methods</h3>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#identityvalue" class="tsd-kind-icon">identity<wbr>Value</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#ishardwareimplementation" class="tsd-kind-icon">is<wbr>Hardware<wbr>Implementation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#jitterbufferms" class="tsd-kind-icon">jitter<wbr>Buffer<wbr>Ms</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#millisecondspersecond" class="tsd-kind-icon">milliseconds<wbr>Per<wbr>Second</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#packetlosspercent" class="tsd-kind-icon">packet<wbr>Loss<wbr>Percent</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#print" class="tsd-kind-icon">print</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#removedestroyedssrcs" class="tsd-kind-icon">remove<wbr>Destroyed<wbr>Ssrcs</a></li>
Expand Down Expand Up @@ -596,6 +596,32 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> type<span class="tsd-
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="averagetimespentpersecondinmilliseconds" class="tsd-anchor"></a>
<h3>average<wbr>Time<wbr>Spent<wbr>Per<wbr>Second<wbr>InMilliseconds</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">average<wbr>Time<wbr>Spent<wbr>Per<wbr>Second<wbr>InMilliseconds<span class="tsd-signature-symbol">(</span>metricName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, ssrc<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/clientmetricreport/ClientMetricReport.ts#L129">src/clientmetricreport/ClientMetricReport.ts:129</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> metricName: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ssrc: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="bitspersecond" class="tsd-anchor"></a>
<h3>bits<wbr>Per<wbr>Second</h3>
Expand Down Expand Up @@ -1006,32 +1032,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</s
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="millisecondspersecond" class="tsd-anchor"></a>
<h3>milliseconds<wbr>Per<wbr>Second</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">milliseconds<wbr>Per<wbr>Second<span class="tsd-signature-symbol">(</span>metricName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, ssrc<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/clientmetricreport/ClientMetricReport.ts#L129">src/clientmetricreport/ClientMetricReport.ts:129</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> metricName: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ssrc: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="packetlosspercent" class="tsd-anchor"></a>
<h3>packet<wbr>Loss<wbr>Percent</h3>
Expand Down Expand Up @@ -1190,6 +1190,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</s
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="clientmetricreport.html#videoupstreammetricmap" class="tsd-kind-icon">video<wbr>Upstream<wbr>Metric<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="clientmetricreport.html#averagetimespentpersecondinmilliseconds" class="tsd-kind-icon">average<wbr>Time<wbr>Spent<wbr>Per<wbr>Second<wbr>InMilliseconds</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="clientmetricreport.html#bitspersecond" class="tsd-kind-icon">bits<wbr>Per<wbr>Second</a>
</li>
Expand Down Expand Up @@ -1232,9 +1235,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</s
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="clientmetricreport.html#jitterbufferms" class="tsd-kind-icon">jitter<wbr>Buffer<wbr>Ms</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="clientmetricreport.html#millisecondspersecond" class="tsd-kind-icon">milliseconds<wbr>Per<wbr>Second</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="clientmetricreport.html#packetlosspercent" class="tsd-kind-icon">packet<wbr>Loss<wbr>Percent</a>
</li>
Expand Down
6 changes: 3 additions & 3 deletions src/clientmetricreport/ClientMetricReport.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ export default class ClientMetricReport {
return Number(metricReport.currentMetrics[metricName] * 1000);
};

millisecondsPerSecond = (metricName?: string, ssrc?: number): number => {
averageTimeSpentPerSecondInMilliseconds = (metricName?: string, ssrc?: number): number => {
const metricReport = ssrc ? this.streamMetricReports[ssrc] : this.globalMetricReport;
let intervalSeconds = (this.currentTimestampMs - this.previousTimestampMs) / 1000;
if (intervalSeconds <= 0) {
Expand Down Expand Up @@ -282,7 +282,7 @@ export default class ClientMetricReport {
transform: this.secondsToMilliseconds,
},
totalEncodeTime: {
transform: this.millisecondsPerSecond,
transform: this.averageTimeSpentPerSecondInMilliseconds,
type: SdkMetric.Type.VIDEO_ENCODE_MS,
},
encoderImplementation: {
Expand Down Expand Up @@ -334,7 +334,7 @@ export default class ClientMetricReport {
frameHeight: { transform: this.identityValue, type: SdkMetric.Type.VIDEO_DECODE_HEIGHT },
frameWidth: { transform: this.identityValue, type: SdkMetric.Type.VIDEO_DECODE_WIDTH },
totalDecodeTime: {
transform: this.millisecondsPerSecond,
transform: this.averageTimeSpentPerSecondInMilliseconds,
type: SdkMetric.Type.VIDEO_DECODE_MS,
},
decoderImplementation: {
Expand Down
12 changes: 7 additions & 5 deletions test/clientmetricreport/ClientMetricReport.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,15 +248,15 @@ describe('ClientMetricReport', () => {
});
});

describe('millisecondsPerSecond', () => {
describe('averageTimeSpentPerSecondInMilliseconds', () => {
const metricName = 'metric-name';

it('returns 0 if the interval is 0', () => {
const report = new GlobalMetricReport();
clientMetricReport.globalMetricReport = report;
clientMetricReport.currentTimestampMs = 0;
clientMetricReport.previousTimestampMs = 0;
expect(clientMetricReport.millisecondsPerSecond(metricName)).to.equal(0);
expect(clientMetricReport.averageTimeSpentPerSecondInMilliseconds(metricName)).to.equal(0);
});

it('returns 0 if the diff is 0', () => {
Expand All @@ -265,7 +265,7 @@ describe('ClientMetricReport', () => {
clientMetricReport.globalMetricReport = report;
clientMetricReport.currentTimestampMs = 2000;
clientMetricReport.previousTimestampMs = 0;
expect(clientMetricReport.millisecondsPerSecond(metricName)).to.equal(0);
expect(clientMetricReport.averageTimeSpentPerSecondInMilliseconds(metricName)).to.equal(0);
});

it('interval is 1 second if pervious timestamp is 0', () => {
Expand All @@ -274,7 +274,7 @@ describe('ClientMetricReport', () => {
clientMetricReport.globalMetricReport = report;
clientMetricReport.currentTimestampMs = 2000;
clientMetricReport.previousTimestampMs = 0;
expect(clientMetricReport.millisecondsPerSecond(metricName)).to.equal(100);
expect(clientMetricReport.averageTimeSpentPerSecondInMilliseconds(metricName)).to.equal(100);
});

it('returns the count from the stream metric reports', () => {
Expand All @@ -284,7 +284,9 @@ describe('ClientMetricReport', () => {
clientMetricReport.streamMetricReports[ssrc] = report;
clientMetricReport.currentTimestampMs = 2000;
clientMetricReport.previousTimestampMs = 1000;
expect(clientMetricReport.millisecondsPerSecond(metricName, ssrc)).to.equal(100);
expect(clientMetricReport.averageTimeSpentPerSecondInMilliseconds(metricName, ssrc)).to.equal(
100
);
});
});

Expand Down