Update doc (#617)

aws · Oct 2, 2023 · d341b0f · d341b0f
1 parent 53f21e6
commit d341b0f
Show file tree

Hide file tree

Showing 287 changed files with 821 additions and 613 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,4 @@
-## Unreleased
+## [0.23.3] - 2023-09-28
 
 ### Fixed
 * Fixed Obj-C support for BackgroundBlurVideoFrameProcessor and BackgroundBlurConfiguration

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -1568,9 +1568,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14AmazonChimeSDK27BackgroundBlurConfigurationC"></a>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)BackgroundBlurConfiguration"></a>
                     <a name="//apple_ref/swift/Class/BackgroundBlurConfiguration" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14AmazonChimeSDK27BackgroundBlurConfigurationC">BackgroundBlurConfiguration</a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)BackgroundBlurConfiguration">BackgroundBlurConfiguration</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -1586,7 +1586,7 @@ <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">BackgroundBlurConfiguration</span></code></pre>
+<span class="kd">public</span> <span class="kd">class</span> <span class="kt">BackgroundBlurConfiguration</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
 
                         </div>
                       </div>
@@ -1596,9 +1596,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14AmazonChimeSDK33BackgroundBlurVideoFrameProcessorC"></a>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)BackgroundBlurVideoFrameProcessor"></a>
                     <a name="//apple_ref/swift/Class/BackgroundBlurVideoFrameProcessor" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14AmazonChimeSDK33BackgroundBlurVideoFrameProcessorC">BackgroundBlurVideoFrameProcessor</a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)BackgroundBlurVideoFrameProcessor">BackgroundBlurVideoFrameProcessor</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -1617,7 +1617,7 @@ <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">BackgroundBlurVideoFrameProcessor</span> <span class="p">:</span> <span class="kt"><a href="Protocols/VideoSource.html">VideoSource</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/VideoSink.html">VideoSink</a></span></code></pre>
+<span class="kd">public</span> <span class="kd">class</span> <span class="kt">BackgroundBlurVideoFrameProcessor</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt"><a href="Protocols/VideoSource.html">VideoSource</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/VideoSink.html">VideoSink</a></span></code></pre>
 
                         </div>
                       </div>
@@ -2546,8 +2546,8 @@ <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-06-27)</p>
-          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</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-10-02)</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>
     </div>

diff --git a/docs/Classes/Attendee.html b/docs/Classes/Attendee.html
@@ -524,8 +524,8 @@ <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-06-27)</p>
-          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</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-10-02)</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>
     </div>

diff --git a/docs/Classes/AttendeeInfo.html b/docs/Classes/AttendeeInfo.html
@@ -654,8 +654,8 @@ <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-06-27)</p>
-          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</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-10-02)</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>
     </div>

diff --git a/docs/Classes/AudioVideoConfiguration.html b/docs/Classes/AudioVideoConfiguration.html
@@ -546,6 +546,32 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(py)enableAudioRedundancy"></a>
+                    <a name="//apple_ref/swift/Property/enableAudioRedundancy" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(py)enableAudioRedundancy">enableAudioRedundancy</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">enableAudioRedundancy</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
                 <li class="item">
                   <div>
                     <code>
@@ -624,6 +650,32 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(im)initWithEnableAudioRedundancy:"></a>
+                    <a name="//apple_ref/swift/Method/init(enableAudioRedundancy:)" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(im)initWithEnableAudioRedundancy:">init(enableAudioRedundancy:<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">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>
@@ -643,7 +695,59 @@ <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></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></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(im)initWithAudioMode:callKitEnabled:enableAudioRedundancy:"></a>
+                    <a name="//apple_ref/swift/Method/init(audioMode:callKitEnabled:enableAudioRedundancy:)" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(im)initWithAudioMode:callKitEnabled:enableAudioRedundancy:">init(audioMode:<wbr>callKitEnabled:<wbr>enableAudioRedundancy:<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></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(py)description"></a>
+                    <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)AudioVideoConfiguration(py)description">description</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="k">override</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 
                         </div>
                       </div>
@@ -655,8 +759,8 @@ <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-06-27)</p>
-          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</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-10-02)</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>
     </div>

diff --git a/docs/Classes/BackgroundBlurConfiguration.html b/docs/Classes/BackgroundBlurConfiguration.html
@@ -484,7 +484,7 @@ <h1>BackgroundBlurConfiguration</h1>
                 <div class="language">
 
                   <pre class="highlight swift"><code><span class="kd">@objcMembers</span>
-<span class="kd">public</span> <span class="kd">class</span> <span class="kt">BackgroundBlurConfiguration</span></code></pre>
+<span class="kd">public</span> <span class="kd">class</span> <span class="kt">BackgroundBlurConfiguration</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
 
                 </div>
               </div>
@@ -496,9 +496,9 @@ <h1>BackgroundBlurConfiguration</h1>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14AmazonChimeSDK27BackgroundBlurConfigurationC6logger12blurStrengthAcA6Logger_p_AA0deI0Otcfc"></a>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)BackgroundBlurConfiguration(im)initWithLogger:blurStrength:"></a>
                     <a name="//apple_ref/swift/Method/init(logger:blurStrength:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14AmazonChimeSDK27BackgroundBlurConfigurationC6logger12blurStrengthAcA6Logger_p_AA0deI0Otcfc">init(logger:<wbr>blurStrength:<wbr>)</a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)BackgroundBlurConfiguration(im)initWithLogger:blurStrength:">init(logger:<wbr>blurStrength:<wbr>)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -524,8 +524,8 @@ <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-06-27)</p>
-          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</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-10-02)</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>
     </div>