Regen jazzy docs [ci skip]

dingwilson · Feb 18, 2019 · 784f1c1 · 784f1c1
1 parent 2ae4f15
commit 784f1c1
Show file tree

Hide file tree

Showing 14 changed files with 188 additions and 12 deletions.
diff --git a/docs/Classes.html b/docs/Classes.html
@@ -89,7 +89,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-17)</p>
+          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-18)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/VideoBackground.html b/docs/Classes/VideoBackground.html
@@ -171,6 +171,34 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:20SwiftVideoBackground0bC0C12videoGravitySo07AVLayerbE0avp"></a>
+                    <a name="//apple_ref/swift/Property/videoGravity" class="dashAnchor"></a>
+                    <a class="token" href="#/s:20SwiftVideoBackground0bC0C12videoGravitySo07AVLayerbE0avp">videoGravity</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Default is <code>.resizeAspectFill</code>. Change to <code>.resizeAspect</code> (doesn&rsquo;t fill view)
+or <code>.resize</code> (doesn&rsquo;t conserve aspect ratio)</p>
+
+                      </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">var</span> <span class="nv">videoGravity</span><span class="p">:</span> <span class="kt">AVLayerVideoGravity</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
                 <li class="item">
                   <div>
                     <code>
@@ -552,12 +580,70 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:20SwiftVideoBackground0bC0C17getThumbnailImage4from2atSo7UIImageC10Foundation3URLV_So6CMTimeatKF"></a>
+                    <a name="//apple_ref/swift/Method/getThumbnailImage(from:at:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:20SwiftVideoBackground0bC0C17getThumbnailImage4from2atSo7UIImageC10Foundation3URLV_So6CMTimeatKF">getThumbnailImage(from:at:)</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Generate an image from the video to show as thumbnail</p>
+
+                      </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="kd">func</span> <span class="nf">getThumbnailImage</span><span class="p">(</span><span class="n">from</span> <span class="nv">url</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="n">at</span> <span class="nv">time</span><span class="p">:</span> <span class="kt">CMTime</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">UIImage</span></code></pre>
+
+                        </div>
+                      </div>
+                      <div>
+                        <h4>Parameters</h4>
+                        <table class="graybox">
+                          <tbody>
+                            <tr>
+                              <td>
+                                <code>
+                                <em>url</em>
+                                </code>
+                              </td>
+                              <td>
+                                <div>
+                                  <p>video file URL</p>
+                                </div>
+                              </td>
+                            </tr>
+                            <tr>
+                              <td>
+                                <code>
+                                <em>time</em>
+                                </code>
+                              </td>
+                              <td>
+                                <div>
+                                  <p>time of video frame to make into thumbnail image</p>
+                                </div>
+                              </td>
+                            </tr>
+                          </tbody>
+                        </table>
+                      </div>
+                    </section>
+                  </div>
+                </li>
               </ul>
             </div>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-17)</p>
+          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-18)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Enums.html b/docs/Enums.html
@@ -89,7 +89,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-17)</p>
+          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-18)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Enums/VideoBackgroundError.html b/docs/Enums/VideoBackgroundError.html
@@ -121,7 +121,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-17)</p>
+          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-18)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/docsets/SwiftVideoBackground.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/SwiftVideoBackground.docset/Contents/Resources/Documents/Classes.html
@@ -89,7 +89,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-17)</p>
+          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-18)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/...ets/SwiftVideoBackground.docset/Contents/Resources/Documents/Classes/VideoBackground.html b/...ets/SwiftVideoBackground.docset/Contents/Resources/Documents/Classes/VideoBackground.html
@@ -171,6 +171,34 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:20SwiftVideoBackground0bC0C12videoGravitySo07AVLayerbE0avp"></a>
+                    <a name="//apple_ref/swift/Property/videoGravity" class="dashAnchor"></a>
+                    <a class="token" href="#/s:20SwiftVideoBackground0bC0C12videoGravitySo07AVLayerbE0avp">videoGravity</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Default is <code>.resizeAspectFill</code>. Change to <code>.resizeAspect</code> (doesn&rsquo;t fill view)
+or <code>.resize</code> (doesn&rsquo;t conserve aspect ratio)</p>
+
+                      </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">var</span> <span class="nv">videoGravity</span><span class="p">:</span> <span class="kt">AVLayerVideoGravity</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
                 <li class="item">
                   <div>
                     <code>
@@ -552,12 +580,70 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:20SwiftVideoBackground0bC0C17getThumbnailImage4from2atSo7UIImageC10Foundation3URLV_So6CMTimeatKF"></a>
+                    <a name="//apple_ref/swift/Method/getThumbnailImage(from:at:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:20SwiftVideoBackground0bC0C17getThumbnailImage4from2atSo7UIImageC10Foundation3URLV_So6CMTimeatKF">getThumbnailImage(from:at:)</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Generate an image from the video to show as thumbnail</p>
+
+                      </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="kd">func</span> <span class="nf">getThumbnailImage</span><span class="p">(</span><span class="n">from</span> <span class="nv">url</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="n">at</span> <span class="nv">time</span><span class="p">:</span> <span class="kt">CMTime</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">UIImage</span></code></pre>
+
+                        </div>
+                      </div>
+                      <div>
+                        <h4>Parameters</h4>
+                        <table class="graybox">
+                          <tbody>
+                            <tr>
+                              <td>
+                                <code>
+                                <em>url</em>
+                                </code>
+                              </td>
+                              <td>
+                                <div>
+                                  <p>video file URL</p>
+                                </div>
+                              </td>
+                            </tr>
+                            <tr>
+                              <td>
+                                <code>
+                                <em>time</em>
+                                </code>
+                              </td>
+                              <td>
+                                <div>
+                                  <p>time of video frame to make into thumbnail image</p>
+                                </div>
+                              </td>
+                            </tr>
+                          </tbody>
+                        </table>
+                      </div>
+                    </section>
+                  </div>
+                </li>
               </ul>
             </div>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-17)</p>
+          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-18)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/docsets/SwiftVideoBackground.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/SwiftVideoBackground.docset/Contents/Resources/Documents/Enums.html
@@ -89,7 +89,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-17)</p>
+          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-18)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/.../SwiftVideoBackground.docset/Contents/Resources/Documents/Enums/VideoBackgroundError.html b/.../SwiftVideoBackground.docset/Contents/Resources/Documents/Enums/VideoBackgroundError.html
@@ -121,7 +121,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-17)</p>
+          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-18)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/docsets/SwiftVideoBackground.docset/Contents/Resources/Documents/index.html b/docs/docsets/SwiftVideoBackground.docset/Contents/Resources/Documents/index.html
@@ -204,9 +204,11 @@ <h4 id='controls' class='heading'>Controls</h4>
 <li><code>pause()</code> - Pauses the video.</li>
 <li><code>resume()</code> - Resumes the video.</li>
 <li><code>restart()</code> - Restarts the video.</li>
+<li><code>getThumbnailImage(from: URL, at: CMTime)</code> - Generate an image from the video to show as thumbnail.</li>
 <li><code>darkness</code> - Change this <code>CGFloat</code> to adjust the darkness of the video. Value <code>0</code> to <code>1</code>. Higher numbers are darker. Setting to an invalid value does nothing.</li>
 <li><code>isMuted</code> - Change this <code>Bool</code> to mute/unmute the video.</li>
 <li><code>willLoopVideo</code> - Change this <code>Bool</code> to set whether the video restarts when it ends.</li>
+<li><code>videoGravity</code> - Default is <code>.resizeAspectFill</code>. Change to <code>.resizeAspect</code> (doesn&rsquo;t fill view) or <code>.resize</code> (doesn&rsquo;t conserve aspect ratio).</li>
 <li><code>playerLayer</code> - The <code>AVPlayerLayer</code> that can be accessed for advanced control and customization of the video.</li>
 </ul>
 <h4 id='singleton' class='heading'>Singleton</h4>
@@ -248,7 +250,7 @@ <h2 id='authors' class='heading'>Authors</h2>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-17)</p>
+          <p>&copy; 2019 <a class="link" href="https://github.com/dingwilson/SwiftVideoBackground" target="_blank" rel="external">Wilson Ding and Quan Vo</a>. All rights reserved. (Last updated: 2019-02-18)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>