Update doc (#689)

aws · Aug 16, 2024 · b232b83 · b232b83
1 parent 0806b58
commit b232b83
Show file tree

Hide file tree

Showing 291 changed files with 333 additions and 333 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,4 @@
-## Unreleased
+## [0.26.1] - 2024-08-15
 
 ### Fixed
 * Add Obj-C support for BackgroundReplacementConfiguration and BackgroundReplacementVideoFrameProcessor

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -1665,9 +1665,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14AmazonChimeSDK34BackgroundReplacementConfigurationC"></a>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementConfiguration"></a>
                     <a name="//apple_ref/swift/Class/BackgroundReplacementConfiguration" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14AmazonChimeSDK34BackgroundReplacementConfigurationC">BackgroundReplacementConfiguration</a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementConfiguration">BackgroundReplacementConfiguration</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -1683,7 +1683,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">BackgroundReplacementConfiguration</span></code></pre>
+<span class="kd">public</span> <span class="kd">class</span> <span class="kt">BackgroundReplacementConfiguration</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
 
                         </div>
                       </div>
@@ -1693,9 +1693,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC"></a>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor"></a>
                     <a name="//apple_ref/swift/Class/BackgroundReplacementVideoFrameProcessor" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC">BackgroundReplacementVideoFrameProcessor</a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor">BackgroundReplacementVideoFrameProcessor</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -1713,7 +1713,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">BackgroundReplacementVideoFrameProcessor</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">BackgroundReplacementVideoFrameProcessor</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>
@@ -2612,7 +2612,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-07-24)</p>
+          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-08-15)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/Attendee.html b/docs/Classes/Attendee.html
@@ -535,7 +535,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-07-24)</p>
+          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-08-15)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/AttendeeInfo.html b/docs/Classes/AttendeeInfo.html
@@ -665,7 +665,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-07-24)</p>
+          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-08-15)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/AudioVideoConfiguration.html b/docs/Classes/AudioVideoConfiguration.html
@@ -1161,7 +1161,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-07-24)</p>
+          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-08-15)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/BackgroundBlurConfiguration.html b/docs/Classes/BackgroundBlurConfiguration.html
@@ -535,7 +535,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-07-24)</p>
+          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-08-15)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/BackgroundBlurVideoFrameProcessor.html b/docs/Classes/BackgroundBlurVideoFrameProcessor.html
@@ -777,7 +777,7 @@ <h4>Parameters</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-07-24)</p>
+          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-08-15)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/BackgroundFilterProcessor.html b/docs/Classes/BackgroundFilterProcessor.html
@@ -756,7 +756,7 @@ <h4>Return Value</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-07-24)</p>
+          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-08-15)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/BackgroundReplacementConfiguration.html b/docs/Classes/BackgroundReplacementConfiguration.html
@@ -495,7 +495,7 @@ <h1>BackgroundReplacementConfiguration</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">BackgroundReplacementConfiguration</span></code></pre>
+<span class="kd">public</span> <span class="kd">class</span> <span class="kt">BackgroundReplacementConfiguration</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
 
                 </div>
               </div>
@@ -507,9 +507,9 @@ <h1>BackgroundReplacementConfiguration</h1>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14AmazonChimeSDK34BackgroundReplacementConfigurationC6logger010backgroundE5ImageAcA6Logger_p_So7UIImageCtcfc"></a>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementConfiguration(im)initWithLogger:backgroundReplacementImage:"></a>
                     <a name="//apple_ref/swift/Method/init(logger:backgroundReplacementImage:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14AmazonChimeSDK34BackgroundReplacementConfigurationC6logger010backgroundE5ImageAcA6Logger_p_So7UIImageCtcfc">init(logger:<wbr>backgroundReplacementImage:<wbr>)</a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementConfiguration(im)initWithLogger:backgroundReplacementImage:">init(logger:<wbr>backgroundReplacementImage:<wbr>)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -535,7 +535,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-07-24)</p>
+          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-08-15)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/BackgroundReplacementVideoFrameProcessor.html b/docs/Classes/BackgroundReplacementVideoFrameProcessor.html
@@ -495,7 +495,7 @@ <h1>BackgroundReplacementVideoFrameProcessor</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">BackgroundReplacementVideoFrameProcessor</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">BackgroundReplacementVideoFrameProcessor</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>
@@ -535,9 +535,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC010backgroundE13ConfigurationAcA0deJ0C_tcfc"></a>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor(im)initWithBackgroundReplacementConfiguration:"></a>
                     <a name="//apple_ref/swift/Method/init(backgroundReplacementConfiguration:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC010backgroundE13ConfigurationAcA0deJ0C_tcfc">init(backgroundReplacementConfiguration:<wbr>)</a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor(im)initWithBackgroundReplacementConfiguration:">init(backgroundReplacementConfiguration:<wbr>)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -581,9 +581,9 @@ <h4>Parameters</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC02onfG8Received5frameyAA0fG0C_tF"></a>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor(im)onVideoFrameReceivedWithFrame:"></a>
                     <a name="//apple_ref/swift/Method/onVideoFrameReceived(frame:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC02onfG8Received5frameyAA0fG0C_tF">onVideoFrameReceived(frame:<wbr>)</a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor(im)onVideoFrameReceivedWithFrame:">onVideoFrameReceived(frame:<wbr>)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -628,9 +628,9 @@ <h4>Parameters</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC03setD5Image03newdeJ0ySo7UIImageC_tF"></a>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor(im)setBackgroundImageWithNewBackgroundReplacementImage:"></a>
                     <a name="//apple_ref/swift/Method/setBackgroundImage(newBackgroundReplacementImage:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC03setD5Image03newdeJ0ySo7UIImageC_tF">setBackgroundImage(newBackgroundReplacementImage:<wbr>)</a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor(im)setBackgroundImageWithNewBackgroundReplacementImage:">setBackgroundImage(newBackgroundReplacementImage:<wbr>)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -674,9 +674,9 @@ <h4>Parameters</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC03addF4Sink4sinkyAA0fJ0_p_tF"></a>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor(im)addVideoSinkWithSink:"></a>
                     <a name="//apple_ref/swift/Method/addVideoSink(sink:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC03addF4Sink4sinkyAA0fJ0_p_tF">addVideoSink(sink:<wbr>)</a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor(im)addVideoSinkWithSink:">addVideoSink(sink:<wbr>)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -701,9 +701,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC06removeF4Sink4sinkyAA0fJ0_p_tF"></a>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor(im)removeVideoSinkWithSink:"></a>
                     <a name="//apple_ref/swift/Method/removeVideoSink(sink:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC06removeF4Sink4sinkyAA0fJ0_p_tF">removeVideoSink(sink:<wbr>)</a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor(im)removeVideoSinkWithSink:">removeVideoSink(sink:<wbr>)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -728,9 +728,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC11updateSinks5frameyAA0fG0C_tF"></a>
+                    <a name="/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor(im)updateSinksWithFrame:"></a>
                     <a name="//apple_ref/swift/Method/updateSinks(frame:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14AmazonChimeSDK40BackgroundReplacementVideoFrameProcessorC11updateSinks5frameyAA0fG0C_tF">updateSinks(frame:<wbr>)</a>
+                    <a class="token" href="#/c:@M@AmazonChimeSDK@objc(cs)BackgroundReplacementVideoFrameProcessor(im)updateSinksWithFrame:">updateSinks(frame:<wbr>)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -776,7 +776,7 @@ <h4>Parameters</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-07-24)</p>
+          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-08-15)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/ConsoleLogger.html b/docs/Classes/ConsoleLogger.html
@@ -731,7 +731,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-07-24)</p>
+          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon.com, Inc. or its affiliates</a>. All rights reserved. (Last updated: 2024-08-15)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>