Update docs

skyway · Jan 9, 2025 · 10ef06f · 10ef06f
1 parent 6be1365
commit 10ef06f
Show file tree

Hide file tree

Showing 251 changed files with 1,477 additions and 3,647 deletions.
diff --git a/docs/core/Classes.html b/docs/core/Classes.html
diff --git a/docs/core/Classes/SKWAudioSource.html b/docs/core/Classes/SKWAudioSource.html
@@ -17,7 +17,7 @@
     <a title="SKWAudioSource Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SkyWayCore 2.1.6 Docs</a> (52% documented)</p>
+        <p><a href="../index.html">SkyWayCore 2.1.7 Docs</a> (61% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -107,7 +107,7 @@
                 <a href="../Classes/SKWFileVideoSource.html">SKWFileVideoSource</a>
               </li>
               <li class="nav-group-task">
-                <a href="../Classes/SKWLocalAudioStream.html">SKWLocalAudioStream</a>
+                <a href="../Classes.html#/c:objc(cs)SKWLocalAudioStream">SKWLocalAudioStream</a>
               </li>
               <li class="nav-group-task">
                 <a href="../Classes/SKWLocalDataStream.html">SKWLocalDataStream</a>
@@ -441,7 +441,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Objective-C</p>
-                          <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n"><a href="../Classes/SKWLocalAudioStream.html">SKWLocalAudioStream</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">)</span><span class="n">createStream</span><span class="p">;</span></code></pre>
+                          <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SKWLocalAudioStream">SKWLocalAudioStream</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">)</span><span class="n">createStream</span><span class="p">;</span></code></pre>
 
                         </div>
                         <div class="language">
@@ -458,7 +458,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2024-12-25)</p>
+          <p>&copy; 2025 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2025-01-09)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/core/Classes/SKWCameraCaptureOptions.html b/docs/core/Classes/SKWCameraCaptureOptions.html
@@ -17,7 +17,7 @@
     <a title="SKWCameraCaptureOptions Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SkyWayCore 2.1.6 Docs</a> (52% documented)</p>
+        <p><a href="../index.html">SkyWayCore 2.1.7 Docs</a> (61% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -107,7 +107,7 @@
                 <a href="../Classes/SKWFileVideoSource.html">SKWFileVideoSource</a>
               </li>
               <li class="nav-group-task">
-                <a href="../Classes/SKWLocalAudioStream.html">SKWLocalAudioStream</a>
+                <a href="../Classes.html#/c:objc(cs)SKWLocalAudioStream">SKWLocalAudioStream</a>
               </li>
               <li class="nav-group-task">
                 <a href="../Classes/SKWLocalDataStream.html">SKWLocalDataStream</a>
@@ -499,7 +499,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2024-12-25)</p>
+          <p>&copy; 2025 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2025-01-09)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/core/Classes/SKWCameraPreviewView.html b/docs/core/Classes/SKWCameraPreviewView.html
@@ -17,7 +17,7 @@
     <a title="SKWCameraPreviewView Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SkyWayCore 2.1.6 Docs</a> (52% documented)</p>
+        <p><a href="../index.html">SkyWayCore 2.1.7 Docs</a> (61% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -107,7 +107,7 @@
                 <a href="../Classes/SKWFileVideoSource.html">SKWFileVideoSource</a>
               </li>
               <li class="nav-group-task">
-                <a href="../Classes/SKWLocalAudioStream.html">SKWLocalAudioStream</a>
+                <a href="../Classes.html#/c:objc(cs)SKWLocalAudioStream">SKWLocalAudioStream</a>
               </li>
               <li class="nav-group-task">
                 <a href="../Classes/SKWLocalDataStream.html">SKWLocalDataStream</a>
@@ -455,7 +455,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2024-12-25)</p>
+          <p>&copy; 2025 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2025-01-09)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/core/Classes/SKWCameraVideoSource.html b/docs/core/Classes/SKWCameraVideoSource.html
@@ -17,7 +17,7 @@
     <a title="SKWCameraVideoSource Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SkyWayCore 2.1.6 Docs</a> (52% documented)</p>
+        <p><a href="../index.html">SkyWayCore 2.1.7 Docs</a> (61% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -107,7 +107,7 @@
                 <a href="../Classes/SKWFileVideoSource.html">SKWFileVideoSource</a>
               </li>
               <li class="nav-group-task">
-                <a href="../Classes/SKWLocalAudioStream.html">SKWLocalAudioStream</a>
+                <a href="../Classes.html#/c:objc(cs)SKWLocalAudioStream">SKWLocalAudioStream</a>
               </li>
               <li class="nav-group-task">
                 <a href="../Classes/SKWLocalDataStream.html">SKWLocalDataStream</a>
@@ -849,7 +849,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2024-12-25)</p>
+          <p>&copy; 2025 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2025-01-09)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/core/Classes/SKWChannel.html b/docs/core/Classes/SKWChannel.html
@@ -17,7 +17,7 @@
     <a title="SKWChannel Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SkyWayCore 2.1.6 Docs</a> (52% documented)</p>
+        <p><a href="../index.html">SkyWayCore 2.1.7 Docs</a> (61% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -107,7 +107,7 @@
                 <a href="../Classes/SKWFileVideoSource.html">SKWFileVideoSource</a>
               </li>
               <li class="nav-group-task">
-                <a href="../Classes/SKWLocalAudioStream.html">SKWLocalAudioStream</a>
+                <a href="../Classes.html#/c:objc(cs)SKWLocalAudioStream">SKWLocalAudioStream</a>
               </li>
               <li class="nav-group-task">
                 <a href="../Classes/SKWLocalDataStream.html">SKWLocalDataStream</a>
@@ -1193,6 +1193,25 @@ <h4>Declaration</h4>
 
                         </div>
                       </div>
+                      <div>
+                        <h4>Parameters</h4>
+                        <table class="graybox">
+                          <tbody>
+                            <tr>
+                              <td>
+                                <code>
+                                <em>completion</em>
+                                </code>
+                              </td>
+                              <td>
+                                <div>
+                                  <p>完了コールバック</p>
+                                </div>
+                              </td>
+                            </tr>
+                          </tbody>
+                        </table>
+                      </div>
                     </section>
                   </div>
                 </li>
@@ -1234,7 +1253,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2024-12-25)</p>
+          <p>&copy; 2025 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2025-01-09)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/core/Classes/SKWChannel/delegate.html b/docs/core/Classes/SKWChannel/delegate.html
@@ -17,7 +17,7 @@
     <a title="delegate Property Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../../index.html">SkyWayCore 2.1.6 Docs</a> (52% documented)</p>
+        <p><a href="../../index.html">SkyWayCore 2.1.7 Docs</a> (61% documented)</p>
         <div class="header-right">
           <form role="search" action="../../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -109,7 +109,7 @@
                 <a href="../../Classes/SKWFileVideoSource.html">SKWFileVideoSource</a>
               </li>
               <li class="nav-group-task">
-                <a href="../../Classes/SKWLocalAudioStream.html">SKWLocalAudioStream</a>
+                <a href="../../Classes.html#/c:objc(cs)SKWLocalAudioStream">SKWLocalAudioStream</a>
               </li>
               <li class="nav-group-task">
                 <a href="../../Classes/SKWLocalDataStream.html">SKWLocalDataStream</a>
@@ -450,7 +450,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2024-12-25)</p>
+          <p>&copy; 2025 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2025-01-09)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/core/Classes/SKWChannelInit.html b/docs/core/Classes/SKWChannelInit.html
@@ -17,7 +17,7 @@
     <a title="SKWChannelInit Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SkyWayCore 2.1.6 Docs</a> (52% documented)</p>
+        <p><a href="../index.html">SkyWayCore 2.1.7 Docs</a> (61% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -107,7 +107,7 @@
                 <a href="../Classes/SKWFileVideoSource.html">SKWFileVideoSource</a>
               </li>
               <li class="nav-group-task">
-                <a href="../Classes/SKWLocalAudioStream.html">SKWLocalAudioStream</a>
+                <a href="../Classes.html#/c:objc(cs)SKWLocalAudioStream">SKWLocalAudioStream</a>
               </li>
               <li class="nav-group-task">
                 <a href="../Classes/SKWLocalDataStream.html">SKWLocalDataStream</a>
@@ -459,7 +459,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2024-12-25)</p>
+          <p>&copy; 2025 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2025-01-09)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/core/Classes/SKWChannelQuery.html b/docs/core/Classes/SKWChannelQuery.html
@@ -17,7 +17,7 @@
     <a title="SKWChannelQuery Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SkyWayCore 2.1.6 Docs</a> (52% documented)</p>
+        <p><a href="../index.html">SkyWayCore 2.1.7 Docs</a> (61% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -107,7 +107,7 @@
                 <a href="../Classes/SKWFileVideoSource.html">SKWFileVideoSource</a>
               </li>
               <li class="nav-group-task">
-                <a href="../Classes/SKWLocalAudioStream.html">SKWLocalAudioStream</a>
+                <a href="../Classes.html#/c:objc(cs)SKWLocalAudioStream">SKWLocalAudioStream</a>
               </li>
               <li class="nav-group-task">
                 <a href="../Classes/SKWLocalDataStream.html">SKWLocalDataStream</a>
@@ -459,7 +459,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2024-12-25)</p>
+          <p>&copy; 2025 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2025-01-09)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/core/Classes/SKWCodec.html b/docs/core/Classes/SKWCodec.html
@@ -17,7 +17,7 @@
     <a title="SKWCodec Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SkyWayCore 2.1.6 Docs</a> (52% documented)</p>
+        <p><a href="../index.html">SkyWayCore 2.1.7 Docs</a> (61% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -107,7 +107,7 @@
                 <a href="../Classes/SKWFileVideoSource.html">SKWFileVideoSource</a>
               </li>
               <li class="nav-group-task">
-                <a href="../Classes/SKWLocalAudioStream.html">SKWLocalAudioStream</a>
+                <a href="../Classes.html#/c:objc(cs)SKWLocalAudioStream">SKWLocalAudioStream</a>
               </li>
               <li class="nav-group-task">
                 <a href="../Classes/SKWLocalDataStream.html">SKWLocalDataStream</a>
@@ -495,7 +495,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2024-12-25)</p>
+          <p>&copy; 2025 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2025-01-09)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/core/Classes/SKWCodecParameters.html b/docs/core/Classes/SKWCodecParameters.html
@@ -17,7 +17,7 @@
     <a title="SKWCodecParameters Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SkyWayCore 2.1.6 Docs</a> (52% documented)</p>
+        <p><a href="../index.html">SkyWayCore 2.1.7 Docs</a> (61% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -107,7 +107,7 @@
                 <a href="../Classes/SKWFileVideoSource.html">SKWFileVideoSource</a>
               </li>
               <li class="nav-group-task">
-                <a href="../Classes/SKWLocalAudioStream.html">SKWLocalAudioStream</a>
+                <a href="../Classes.html#/c:objc(cs)SKWLocalAudioStream">SKWLocalAudioStream</a>
               </li>
               <li class="nav-group-task">
                 <a href="../Classes/SKWLocalDataStream.html">SKWLocalDataStream</a>
@@ -409,12 +409,11 @@ <h1>SKWCodecParameters</h1>
 
 <p>コーデックでOpusが利用される場合は、デフォルトで利用します。</p>
 
-<p>利用しない場合は以下のように設定します。
-　`&ldquo;
-let codec: Codec = .init(mimeType: &quot;audio/opus&rdquo;)
-codec.parameters.useDTX = false
-// and publish with codec options</p>
-<pre class="highlight objective_c"><code></code></pre>
+<p>利用しない場合は以下のように設定します。</p>
+<pre class="highlight objective_c"><code><span class="n">let</span> <span class="n">codec</span><span class="o">:</span> <span class="n">Codec</span> <span class="o">=</span> <span class="p">.</span><span class="n">init</span><span class="p">(</span><span class="n">mimeType</span><span class="o">:</span> <span class="s">"audio/opus"</span><span class="p">)</span>
+<span class="n">codec</span><span class="p">.</span><span class="n">parameters</span><span class="p">.</span><span class="n">useDTX</span> <span class="o">=</span> <span class="nb">false</span>
+<span class="c1">// and publish with codec options</span>
+</code></pre>
 
                       </div>
                       <div class="declaration">
@@ -438,7 +437,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2024-12-25)</p>
+          <p>&copy; 2025 <a class="link" href="" target="_blank" rel="external noopener">NTT Communications</a>. All rights reserved. (Last updated: 2025-01-09)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>