Skip to content

Commit

Permalink
Update documentation and changelog (#246)
Browse files Browse the repository at this point in the history
  • Loading branch information
zhinang-amazon authored Feb 24, 2021
1 parent 641fe56 commit 2320d47
Show file tree
Hide file tree
Showing 227 changed files with 363 additions and 239 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Unreleased
## [0.16.0] - 2021-02-24

### Added
* Pass SDK metadata to Media AudioClient for metrics.
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -1767,7 +1767,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/Attendee.html
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/AttendeeInfo.html
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/ConsoleLogger.html
Original file line number Diff line number Diff line change
Expand Up @@ -648,7 +648,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/ContentShareSource.html
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/ContentShareStatus.html
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/CreateAttendeeResponse.html
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/CreateMeetingResponse.html
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/DataMessage.html
Original file line number Diff line number Diff line change
Expand Up @@ -763,7 +763,7 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
9 changes: 4 additions & 5 deletions docs/Classes/DefaultActiveSpeakerDetector.html
Original file line number Diff line number Diff line change
Expand Up @@ -424,9 +424,9 @@ <h1>DefaultActiveSpeakerDetector</h1>
<li class="item">
<div>
<code>
<a name="/c:@M@AmazonChimeSDK@objc(cs)DefaultActiveSpeakerDetector(im)initWithAudioClientObserver:selfAttendeeId:"></a>
<a name="//apple_ref/swift/Method/init(audioClientObserver:selfAttendeeId:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)DefaultActiveSpeakerDetector(im)initWithAudioClientObserver:selfAttendeeId:">init(audioClientObserver:<wbr>selfAttendeeId:<wbr>)</a>
<a name="/c:@M@AmazonChimeSDK@objc(cs)DefaultActiveSpeakerDetector(im)initWithSelfAttendeeId:"></a>
<a name="//apple_ref/swift/Method/init(selfAttendeeId:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)DefaultActiveSpeakerDetector(im)initWithSelfAttendeeId:">init(selfAttendeeId:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -441,7 +441,6 @@ <h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span>
<span class="nv">audioClientObserver</span><span class="p">:</span> <span class="kt"><a href="../Protocols/AudioClientObserver.html">AudioClientObserver</a></span><span class="p">,</span>
<span class="nv">selfAttendeeId</span><span class="p">:</span> <span class="kt">String</span>
<span class="p">)</span></code></pre>

Expand Down Expand Up @@ -718,7 +717,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/DefaultActiveSpeakerPolicy.html
Original file line number Diff line number Diff line change
Expand Up @@ -610,7 +610,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
9 changes: 5 additions & 4 deletions docs/Classes/DefaultAudioVideoController.html
Original file line number Diff line number Diff line change
Expand Up @@ -476,9 +476,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/c:@M@AmazonChimeSDK@objc(cs)DefaultAudioVideoController(im)initWithAudioClientController:audioClientObserver:clientMetricsCollector:videoClientController:configuration:logger:"></a>
<a name="//apple_ref/swift/Method/init(audioClientController:audioClientObserver:clientMetricsCollector:videoClientController:configuration:logger:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)DefaultAudioVideoController(im)initWithAudioClientController:audioClientObserver:clientMetricsCollector:videoClientController:configuration:logger:">init(audioClientController:<wbr>audioClientObserver:<wbr>clientMetricsCollector:<wbr>videoClientController:<wbr>configuration:<wbr>logger:<wbr>)</a>
<a name="/c:@M@AmazonChimeSDK@objc(cs)DefaultAudioVideoController(im)initWithAudioClientController:audioClientObserver:clientMetricsCollector:videoClientController:videoTileController:configuration:logger:"></a>
<a name="//apple_ref/swift/Method/init(audioClientController:audioClientObserver:clientMetricsCollector:videoClientController:videoTileController:configuration:logger:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)DefaultAudioVideoController(im)initWithAudioClientController:audioClientObserver:clientMetricsCollector:videoClientController:videoTileController:configuration:logger:">init(audioClientController:<wbr>audioClientObserver:<wbr>clientMetricsCollector:<wbr>videoClientController:<wbr>videoTileController:<wbr>configuration:<wbr>logger:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -496,6 +496,7 @@ <h4>Declaration</h4>
<span class="nv">audioClientObserver</span><span class="p">:</span> <span class="kt"><a href="../Protocols/AudioClientObserver.html">AudioClientObserver</a></span><span class="p">,</span>
<span class="nv">clientMetricsCollector</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ClientMetricsCollector.html">ClientMetricsCollector</a></span><span class="p">,</span>
<span class="nv">videoClientController</span><span class="p">:</span> <span class="kt"><a href="../Protocols/VideoClientController.html">VideoClientController</a></span><span class="p">,</span>
<span class="nv">videoTileController</span><span class="p">:</span> <span class="kt"><a href="../Protocols/VideoTileController.html">VideoTileController</a></span><span class="p">,</span>
<span class="nv">configuration</span><span class="p">:</span> <span class="kt"><a href="../Classes/MeetingSessionConfiguration.html">MeetingSessionConfiguration</a></span><span class="p">,</span>
<span class="nv">logger</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Logger.html">Logger</a></span><span class="p">)</span></code></pre>

Expand Down Expand Up @@ -821,7 +822,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/DefaultAudioVideoFacade.html
Original file line number Diff line number Diff line change
Expand Up @@ -1748,7 +1748,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/DefaultCameraCaptureSource.html
Original file line number Diff line number Diff line change
Expand Up @@ -793,7 +793,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/DefaultContentShareController.html
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/DefaultContentShareVideoClientController.html
Original file line number Diff line number Diff line change
Expand Up @@ -716,7 +716,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/DefaultDeviceController.html
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/DefaultEventAnalyticsController.html
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/DefaultMeetingSession.html
Original file line number Diff line number Diff line change
Expand Up @@ -557,7 +557,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/DefaultMeetingStatsCollector.html
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/DefaultModality.html
Original file line number Diff line number Diff line change
Expand Up @@ -593,7 +593,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-04)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2021-02-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit 2320d47

Please sign in to comment.