Skip to content

Commit

Permalink
Update doc (#632)
Browse files Browse the repository at this point in the history
  • Loading branch information
@bjason
bjason authored Dec 21, 2023
1 parent 34e7c58 commit 45c01bd
Show file tree
Hide file tree
Showing 289 changed files with 5,223 additions and 299 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## [0.24.0] - 2023-12-19
## [0.24.0] - 2023-12-20

### Added
* Add support for high-definition WebRTC sessions with 1080p webcam video and 4K screen share, and decode support for VP9. Developers can choose video encoding bitrates up to 2.5Mbps, frame rates up to 30fps.
Expand Down
65 changes: 64 additions & 1 deletion docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,9 @@
<li class="nav-group-task">
<a href="Classes/MeetingEventClientConfiguration.html">MeetingEventClientConfiguration</a>
</li>
<li class="nav-group-task">
<a href="Classes/MeetingFeatures.html">MeetingFeatures</a>
</li>
<li class="nav-group-task">
<a href="Classes/MeetingHistoryEvent.html">MeetingHistoryEvent</a>
</li>
Expand Down Expand Up @@ -227,6 +230,9 @@
<li class="nav-group-task">
<a href="Classes/Versioning.html">Versioning</a>
</li>
<li class="nav-group-task">
<a href="Classes/VideoBitrateConstants.html">VideoBitrateConstants</a>
</li>
<li class="nav-group-task">
<a href="Classes/VideoCaptureFormat.html">VideoCaptureFormat</a>
</li>
Expand Down Expand Up @@ -1356,6 +1362,35 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@AmazonChimeSDK@objc(cs)VideoBitrateConstants"></a>
<a name="//apple_ref/swift/Class/VideoBitrateConstants" class="dashAnchor"></a>
<a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)VideoBitrateConstants">VideoBitrateConstants</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>video bitrates for regular and high-resolution meetings</p>

<a href="Classes/VideoBitrateConstants.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">VideoBitrateConstants</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -2255,6 +2290,34 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@AmazonChimeSDK@objc(cs)MeetingFeatures"></a>
<a name="//apple_ref/swift/Class/MeetingFeatures" class="dashAnchor"></a>
<a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)MeetingFeatures">MeetingFeatures</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

<a href="Classes/MeetingFeatures.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objcMembers</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">MeetingFeatures</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -2546,7 +2609,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2023-10-02)</p>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2023-12-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
8 changes: 7 additions & 1 deletion docs/Classes/Attendee.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,9 @@
<li class="nav-group-task">
<a href="../Classes/MeetingEventClientConfiguration.html">MeetingEventClientConfiguration</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MeetingFeatures.html">MeetingFeatures</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MeetingHistoryEvent.html">MeetingHistoryEvent</a>
</li>
Expand Down Expand Up @@ -227,6 +230,9 @@
<li class="nav-group-task">
<a href="../Classes/Versioning.html">Versioning</a>
</li>
<li class="nav-group-task">
<a href="../Classes/VideoBitrateConstants.html">VideoBitrateConstants</a>
</li>
<li class="nav-group-task">
<a href="../Classes/VideoCaptureFormat.html">VideoCaptureFormat</a>
</li>
Expand Down Expand Up @@ -524,7 +530,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2023-10-02)</p>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2023-12-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
8 changes: 7 additions & 1 deletion docs/Classes/AttendeeInfo.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,9 @@
<li class="nav-group-task">
<a href="../Classes/MeetingEventClientConfiguration.html">MeetingEventClientConfiguration</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MeetingFeatures.html">MeetingFeatures</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MeetingHistoryEvent.html">MeetingHistoryEvent</a>
</li>
Expand Down Expand Up @@ -227,6 +230,9 @@
<li class="nav-group-task">
<a href="../Classes/Versioning.html">Versioning</a>
</li>
<li class="nav-group-task">
<a href="../Classes/VideoBitrateConstants.html">VideoBitrateConstants</a>
</li>
<li class="nav-group-task">
<a href="../Classes/VideoCaptureFormat.html">VideoCaptureFormat</a>
</li>
Expand Down Expand Up @@ -654,7 +660,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2023-10-02)</p>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2023-12-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
88 changes: 86 additions & 2 deletions docs/Classes/AudioVideoConfiguration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,9 @@
<li class="nav-group-task">
<a href="../Classes/MeetingEventClientConfiguration.html">MeetingEventClientConfiguration</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MeetingFeatures.html">MeetingFeatures</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MeetingHistoryEvent.html">MeetingHistoryEvent</a>
</li>
Expand Down Expand Up @@ -227,6 +230,9 @@
<li class="nav-group-task">
<a href="../Classes/Versioning.html">Versioning</a>
</li>
<li class="nav-group-task">
<a href="../Classes/VideoBitrateConstants.html">VideoBitrateConstants</a>
</li>
<li class="nav-group-task">
<a href="../Classes/VideoCaptureFormat.html">VideoCaptureFormat</a>
</li>
Expand Down Expand Up @@ -572,6 +578,32 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(py)videoMaxResolution"></a>
<a name="//apple_ref/swift/Property/videoMaxResolution" class="dashAnchor"></a>
<a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(py)videoMaxResolution">videoMaxResolution</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">videoMaxResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/VideoResolution.html">VideoResolution</a></span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -676,6 +708,32 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(im)initWithVideoMaxResolution:"></a>
<a name="//apple_ref/swift/Method/init(videoMaxResolution:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(im)initWithVideoMaxResolution:">init(videoMaxResolution:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">convenience</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">videoMaxResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/VideoResolution.html">VideoResolution</a></span><span class="p">)</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -721,7 +779,33 @@ <h4>Declaration</h4>
<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">audioMode</span><span class="p">:</span> <span class="kt"><a href="../Enums/AudioMode.html">AudioMode</a></span><span class="p">,</span> <span class="nv">callKitEnabled</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">enableAudioRedundancy</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>
<pre class="highlight swift"><code><span class="kd">convenience</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">audioMode</span><span class="p">:</span> <span class="kt"><a href="../Enums/AudioMode.html">AudioMode</a></span><span class="p">,</span> <span class="nv">callKitEnabled</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">enableAudioRedundancy</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(im)initWithAudioMode:callKitEnabled:enableAudioRedundancy:videoMaxResolution:"></a>
<a name="//apple_ref/swift/Method/init(audioMode:callKitEnabled:enableAudioRedundancy:videoMaxResolution:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(im)initWithAudioMode:callKitEnabled:enableAudioRedundancy:videoMaxResolution:">init(audioMode:<wbr>callKitEnabled:<wbr>enableAudioRedundancy:<wbr>videoMaxResolution:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

</div>
<div class="declaration">
<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">audioMode</span><span class="p">:</span> <span class="kt"><a href="../Enums/AudioMode.html">AudioMode</a></span><span class="p">,</span> <span class="nv">callKitEnabled</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">enableAudioRedundancy</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">videoMaxResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/VideoResolution.html">VideoResolution</a></span><span class="p">)</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -759,7 +843,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2023-10-02)</p>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2023-12-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
8 changes: 7 additions & 1 deletion docs/Classes/BackgroundBlurConfiguration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,9 @@
<li class="nav-group-task">
<a href="../Classes/MeetingEventClientConfiguration.html">MeetingEventClientConfiguration</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MeetingFeatures.html">MeetingFeatures</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MeetingHistoryEvent.html">MeetingHistoryEvent</a>
</li>
Expand Down Expand Up @@ -227,6 +230,9 @@
<li class="nav-group-task">
<a href="../Classes/Versioning.html">Versioning</a>
</li>
<li class="nav-group-task">
<a href="../Classes/VideoBitrateConstants.html">VideoBitrateConstants</a>
</li>
<li class="nav-group-task">
<a href="../Classes/VideoCaptureFormat.html">VideoCaptureFormat</a>
</li>
Expand Down Expand Up @@ -524,7 +530,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2023-10-02)</p>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2023-12-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit 45c01bd

Please sign in to comment.