Skip to content

Commit

Permalink
Fix naming
Browse files Browse the repository at this point in the history
  • Loading branch information
Shi Su committed Sep 14, 2022
1 parent c731c87 commit 0cbf2a9
Show file tree
Hide file tree
Showing 10 changed files with 80 additions and 77 deletions.
26 changes: 13 additions & 13 deletions docs/assets/js/search.js
View file

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/classes/clientmetricreport.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h3>Properties</h3>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="clientmetricreport.html#observablevideometricspec" class="tsd-kind-icon">observable<wbr>Video<wbr>Metric<wbr>Spec</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="clientmetricreport.html#previoustimestampms" class="tsd-kind-icon">previous<wbr>Timestamp<wbr>Ms</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="clientmetricreport.html#rtcstatsreport" class="tsd-kind-icon">rtc<wbr>Stats<wbr>Report</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="clientmetricreport.html#streammetricdimensionmap" class="tsd-kind-icon">stream<wbr>Metric<wbr>Dimension<wbr>Map</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="clientmetricreport.html#streamdimensionmap" class="tsd-kind-icon">stream<wbr>Dimension<wbr>Map</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="clientmetricreport.html#streammetricreports" class="tsd-kind-icon">stream<wbr>Metric<wbr>Reports</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="clientmetricreport.html#videodownstreammetricmap" class="tsd-kind-icon">video<wbr>Downstream<wbr>Metric<wbr>Map</a></li>
<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>
Expand All @@ -123,7 +123,7 @@ <h3>Methods</h3>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#getobservablevideometricvalue" class="tsd-kind-icon">get<wbr>Observable<wbr>Video<wbr>Metric<wbr>Value</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#getobservablevideometrics" class="tsd-kind-icon">get<wbr>Observable<wbr>Video<wbr>Metrics</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#getrtcstatsreport" class="tsd-kind-icon">getRTCStats<wbr>Report</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#getstreammetricdimensionmap" class="tsd-kind-icon">get<wbr>Stream<wbr>Metric<wbr>Dimension<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clientmetricreport.html#getstreamdimensionmap" class="tsd-kind-icon">get<wbr>Stream<wbr>Dimension<wbr>Map</a></li>
<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>
Expand Down Expand Up @@ -453,9 +453,9 @@ <h3>rtc<wbr>Stats<wbr>Report</h3>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="streammetricdimensionmap" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> stream<wbr>Metric<wbr>Dimension<wbr>Map</h3>
<div class="tsd-signature tsd-kind-icon">stream<wbr>Metric<wbr>Dimension<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = ...</span></div>
<a name="streamdimensionmap" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> stream<wbr>Dimension<wbr>Map</h3>
<div class="tsd-signature tsd-kind-icon">stream<wbr>Dimension<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/clientmetricreport/ClientMetricReport.ts#L379">src/clientmetricreport/ClientMetricReport.ts:379</a></li>
Expand Down Expand Up @@ -902,10 +902,10 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RTCStatsR
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getstreammetricdimensionmap" class="tsd-anchor"></a>
<h3>get<wbr>Stream<wbr>Metric<wbr>Dimension<wbr>Map</h3>
<a name="getstreamdimensionmap" class="tsd-anchor"></a>
<h3>get<wbr>Stream<wbr>Dimension<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Stream<wbr>Metric<wbr>Dimension<wbr>Map<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></li>
<li class="tsd-signature tsd-kind-icon">get<wbr>Stream<wbr>Dimension<wbr>Map<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
Expand Down Expand Up @@ -1179,7 +1179,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</s
<a href="clientmetricreport.html#rtcstatsreport" class="tsd-kind-icon">rtc<wbr>Stats<wbr>Report</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="clientmetricreport.html#streammetricdimensionmap" class="tsd-kind-icon">stream<wbr>Metric<wbr>Dimension<wbr>Map</a>
<a href="clientmetricreport.html#streamdimensionmap" class="tsd-kind-icon">stream<wbr>Dimension<wbr>Map</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="clientmetricreport.html#streammetricreports" class="tsd-kind-icon">stream<wbr>Metric<wbr>Reports</a>
Expand Down Expand Up @@ -1221,7 +1221,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</s
<a href="clientmetricreport.html#getrtcstatsreport" class="tsd-kind-icon">getRTCStats<wbr>Report</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="clientmetricreport.html#getstreammetricdimensionmap" class="tsd-kind-icon">get<wbr>Stream<wbr>Metric<wbr>Dimension<wbr>Map</a>
<a href="clientmetricreport.html#getstreamdimensionmap" class="tsd-kind-icon">get<wbr>Stream<wbr>Dimension<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="clientmetricreport.html#identityvalue" class="tsd-kind-icon">identity<wbr>Value</a>
Expand Down
26 changes: 13 additions & 13 deletions docs/classes/globalmetricreport.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ <h3>Constructors</h3>
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="globalmetricreport.html#currentmetrics" class="tsd-kind-icon">current<wbr>Metrics</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="globalmetricreport.html#currentstringmetrics" class="tsd-kind-icon">current<wbr>String<wbr>Metrics</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="globalmetricreport.html#previousmetrics" class="tsd-kind-icon">previous<wbr>Metrics</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="globalmetricreport.html#stringvalues" class="tsd-kind-icon">string<wbr>Values</a></li>
</ul>
</section>
</div>
Expand Down Expand Up @@ -132,37 +132,37 @@ <h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-ty
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="previousmetrics" class="tsd-anchor"></a>
<h3>previous<wbr>Metrics</h3>
<div class="tsd-signature tsd-kind-icon">previous<wbr>Metrics<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div>
<a name="currentstringmetrics" class="tsd-anchor"></a>
<h3>current<wbr>String<wbr>Metrics</h3>
<div class="tsd-signature tsd-kind-icon">current<wbr>String<wbr>Metrics<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/clientmetricreport/GlobalMetricReport.ts#L5">src/clientmetricreport/GlobalMetricReport.ts:5</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/clientmetricreport/GlobalMetricReport.ts#L8">src/clientmetricreport/GlobalMetricReport.ts:8</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">number</span></h5>
<h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="stringvalues" class="tsd-anchor"></a>
<h3>string<wbr>Values</h3>
<div class="tsd-signature tsd-kind-icon">string<wbr>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div>
<a name="previousmetrics" class="tsd-anchor"></a>
<h3>previous<wbr>Metrics</h3>
<div class="tsd-signature tsd-kind-icon">previous<wbr>Metrics<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/clientmetricreport/GlobalMetricReport.ts#L7">src/clientmetricreport/GlobalMetricReport.ts:7</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/clientmetricreport/GlobalMetricReport.ts#L5">src/clientmetricreport/GlobalMetricReport.ts:5</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
<h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</div>
Expand Down Expand Up @@ -191,10 +191,10 @@ <h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-ty
<a href="globalmetricreport.html#currentmetrics" class="tsd-kind-icon">current<wbr>Metrics</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="globalmetricreport.html#previousmetrics" class="tsd-kind-icon">previous<wbr>Metrics</a>
<a href="globalmetricreport.html#currentstringmetrics" class="tsd-kind-icon">current<wbr>String<wbr>Metrics</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="globalmetricreport.html#stringvalues" class="tsd-kind-icon">string<wbr>Values</a>
<a href="globalmetricreport.html#previousmetrics" class="tsd-kind-icon">previous<wbr>Metrics</a>
</li>
</ul>
</li>
Expand Down
44 changes: 22 additions & 22 deletions docs/classes/streammetricreport.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,11 @@ <h3>Constructors</h3>
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammetricreport.html#currentmetrics" class="tsd-kind-icon">current<wbr>Metrics</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammetricreport.html#currentstringmetrics" class="tsd-kind-icon">current<wbr>String<wbr>Metrics</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammetricreport.html#direction" class="tsd-kind-icon">direction</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammetricreport.html#mediatype" class="tsd-kind-icon">media<wbr>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammetricreport.html#previousmetrics" class="tsd-kind-icon">previous<wbr>Metrics</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammetricreport.html#streamid" class="tsd-kind-icon">stream<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammetricreport.html#stringvalues" class="tsd-kind-icon">string<wbr>Values</a></li>
</ul>
</section>
</div>
Expand Down Expand Up @@ -134,6 +134,24 @@ <h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-ty
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="currentstringmetrics" class="tsd-anchor"></a>
<h3>current<wbr>String<wbr>Metrics</h3>
<div class="tsd-signature tsd-kind-icon">current<wbr>String<wbr>Metrics<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/clientmetricreport/StreamMetricReport.ts#L14">src/clientmetricreport/StreamMetricReport.ts:14</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="direction" class="tsd-anchor"></a>
<h3>direction</h3>
Expand Down Expand Up @@ -182,24 +200,6 @@ <h3>stream<wbr>Id</h3>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="stringvalues" class="tsd-anchor"></a>
<h3>string<wbr>Values</h3>
<div class="tsd-signature tsd-kind-icon">string<wbr>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/clientmetricreport/StreamMetricReport.ts#L13">src/clientmetricreport/StreamMetricReport.ts:13</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
Expand All @@ -223,6 +223,9 @@ <h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-ty
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="streammetricreport.html#currentmetrics" class="tsd-kind-icon">current<wbr>Metrics</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="streammetricreport.html#currentstringmetrics" class="tsd-kind-icon">current<wbr>String<wbr>Metrics</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="streammetricreport.html#direction" class="tsd-kind-icon">direction</a>
</li>
Expand All @@ -235,9 +238,6 @@ <h5><span class="tsd-signature-symbol">[</span>id: <span class="tsd-signature-ty
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="streammetricreport.html#streamid" class="tsd-kind-icon">stream<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="streammetricreport.html#stringvalues" class="tsd-kind-icon">string<wbr>Values</a>
</li>
</ul>
</li>
</ul>
Expand Down
8 changes: 4 additions & 4 deletions src/clientmetricreport/ClientMetricReport.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ export default class ClientMetricReport {

isHardwareImplementation = (metricName?: string, ssrc?: number): number => {
const metricReport = this.streamMetricReports[ssrc];
const implName = String(metricReport.stringValues[metricName]);
const implName = String(metricReport.currentStringMetrics[metricName]);
const hasHwName =
implName.includes('ExternalDecoder') ||
implName.includes('ExternalEncoder') ||
Expand Down Expand Up @@ -376,17 +376,17 @@ export default class ClientMetricReport {
/**
* Dimensions derived from metric
*/
readonly streamMetricDimensionMap: {
readonly streamDimensionMap: {
[id: string]: SdkStreamDimension.Type;
} = {
encoderImplementation: SdkStreamDimension.Type.VIDEO_ENCODER_NAME,
decoderImplementation: SdkStreamDimension.Type.VIDEO_DECODER_NAME,
};

getStreamMetricDimensionMap(): {
getStreamDimensionMap(): {
[id: string]: SdkStreamDimension.Type;
} {
return this.streamMetricDimensionMap;
return this.streamDimensionMap;
}

/**
Expand Down
3 changes: 2 additions & 1 deletion src/clientmetricreport/GlobalMetricReport.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
export default class GlobalMetricReport {
previousMetrics: { [id: string]: number } = {};
currentMetrics: { [id: string]: number } = {};
stringValues: { [id: string]: string } = {};
// As metric values do not necessarily be number, this is a workaround in case metric value is string
currentStringMetrics: { [id: string]: string } = {};
}
3 changes: 2 additions & 1 deletion src/clientmetricreport/StreamMetricReport.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ export default class StreamMetricReport {
direction: Direction;
previousMetrics: { [id: string]: number } = {};
currentMetrics: { [id: string]: number } = {};
stringValues: { [id: string]: string } = {};
// As metric values do not necessarily be number, this is a workaround in case metric value is string
currentStringMetrics: { [id: string]: string } = {};
}
Loading

0 comments on commit 0cbf2a9

Please sign in to comment.