Skip to content

Commit 784f1c1

Browse files
author
Travis-CI
committed
Regen jazzy docs [ci skip]
1 parent 2ae4f15 commit 784f1c1

File tree

14 files changed

+188
-12
lines changed

14 files changed

+188
-12
lines changed

‎docs/Classes.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h4>Declaration</h4>
8989
</section>
9090
</section>
9191
<section id="footer">
92-
<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>
92+
<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>
9393
<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>
9494
</section>
9595
</article>

‎docs/Classes/VideoBackground.html‎

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,34 @@ <h4>Declaration</h4>
171171
</section>
172172
</div>
173173
</li>
174+
<li class="item">
175+
<div>
176+
<code>
177+
<a name="/s:20SwiftVideoBackground0bC0C12videoGravitySo07AVLayerbE0avp"></a>
178+
<a name="//apple_ref/swift/Property/videoGravity" class="dashAnchor"></a>
179+
<a class="token" href="#/s:20SwiftVideoBackground0bC0C12videoGravitySo07AVLayerbE0avp">videoGravity</a>
180+
</code>
181+
</div>
182+
<div class="height-container">
183+
<div class="pointer-container"></div>
184+
<section class="section">
185+
<div class="pointer"></div>
186+
<div class="abstract">
187+
<p>Default is <code>.resizeAspectFill</code>. Change to <code>.resizeAspect</code> (doesn&rsquo;t fill view)
188+
or <code>.resize</code> (doesn&rsquo;t conserve aspect ratio)</p>
189+
190+
</div>
191+
<div class="declaration">
192+
<h4>Declaration</h4>
193+
<div class="language">
194+
<p class="aside-title">Swift</p>
195+
<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>
196+
197+
</div>
198+
</div>
199+
</section>
200+
</div>
201+
</li>
174202
<li class="item">
175203
<div>
176204
<code>
@@ -552,12 +580,70 @@ <h4>Declaration</h4>
552580
</section>
553581
</div>
554582
</li>
583+
<li class="item">
584+
<div>
585+
<code>
586+
<a name="/s:20SwiftVideoBackground0bC0C17getThumbnailImage4from2atSo7UIImageC10Foundation3URLV_So6CMTimeatKF"></a>
587+
<a name="//apple_ref/swift/Method/getThumbnailImage(from:at:)" class="dashAnchor"></a>
588+
<a class="token" href="#/s:20SwiftVideoBackground0bC0C17getThumbnailImage4from2atSo7UIImageC10Foundation3URLV_So6CMTimeatKF">getThumbnailImage(from:at:)</a>
589+
</code>
590+
</div>
591+
<div class="height-container">
592+
<div class="pointer-container"></div>
593+
<section class="section">
594+
<div class="pointer"></div>
595+
<div class="abstract">
596+
<p>Generate an image from the video to show as thumbnail</p>
597+
598+
</div>
599+
<div class="declaration">
600+
<h4>Declaration</h4>
601+
<div class="language">
602+
<p class="aside-title">Swift</p>
603+
<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>
604+
605+
</div>
606+
</div>
607+
<div>
608+
<h4>Parameters</h4>
609+
<table class="graybox">
610+
<tbody>
611+
<tr>
612+
<td>
613+
<code>
614+
<em>url</em>
615+
</code>
616+
</td>
617+
<td>
618+
<div>
619+
<p>video file URL</p>
620+
</div>
621+
</td>
622+
</tr>
623+
<tr>
624+
<td>
625+
<code>
626+
<em>time</em>
627+
</code>
628+
</td>
629+
<td>
630+
<div>
631+
<p>time of video frame to make into thumbnail image</p>
632+
</div>
633+
</td>
634+
</tr>
635+
</tbody>
636+
</table>
637+
</div>
638+
</section>
639+
</div>
640+
</li>
555641
</ul>
556642
</div>
557643
</section>
558644
</section>
559645
<section id="footer">
560-
<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>
646+
<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>
561647
<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>
562648
</section>
563649
</article>

‎docs/Enums.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h4>Declaration</h4>
8989
</section>
9090
</section>
9191
<section id="footer">
92-
<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>
92+
<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>
9393
<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>
9494
</section>
9595
</article>

‎docs/Enums/VideoBackgroundError.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h4>Declaration</h4>
121121
</section>
122122
</section>
123123
<section id="footer">
124-
<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>
124+
<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>
125125
<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>
126126
</section>
127127
</article>

‎docs/docsets/SwiftVideoBackground.docset/Contents/Resources/Documents/Classes.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h4>Declaration</h4>
8989
</section>
9090
</section>
9191
<section id="footer">
92-
<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>
92+
<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>
9393
<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>
9494
</section>
9595
</article>

‎docs/docsets/SwiftVideoBackground.docset/Contents/Resources/Documents/Classes/VideoBackground.html‎

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,34 @@ <h4>Declaration</h4>
171171
</section>
172172
</div>
173173
</li>
174+
<li class="item">
175+
<div>
176+
<code>
177+
<a name="/s:20SwiftVideoBackground0bC0C12videoGravitySo07AVLayerbE0avp"></a>
178+
<a name="//apple_ref/swift/Property/videoGravity" class="dashAnchor"></a>
179+
<a class="token" href="#/s:20SwiftVideoBackground0bC0C12videoGravitySo07AVLayerbE0avp">videoGravity</a>
180+
</code>
181+
</div>
182+
<div class="height-container">
183+
<div class="pointer-container"></div>
184+
<section class="section">
185+
<div class="pointer"></div>
186+
<div class="abstract">
187+
<p>Default is <code>.resizeAspectFill</code>. Change to <code>.resizeAspect</code> (doesn&rsquo;t fill view)
188+
or <code>.resize</code> (doesn&rsquo;t conserve aspect ratio)</p>
189+
190+
</div>
191+
<div class="declaration">
192+
<h4>Declaration</h4>
193+
<div class="language">
194+
<p class="aside-title">Swift</p>
195+
<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>
196+
197+
</div>
198+
</div>
199+
</section>
200+
</div>
201+
</li>
174202
<li class="item">
175203
<div>
176204
<code>
@@ -552,12 +580,70 @@ <h4>Declaration</h4>
552580
</section>
553581
</div>
554582
</li>
583+
<li class="item">
584+
<div>
585+
<code>
586+
<a name="/s:20SwiftVideoBackground0bC0C17getThumbnailImage4from2atSo7UIImageC10Foundation3URLV_So6CMTimeatKF"></a>
587+
<a name="//apple_ref/swift/Method/getThumbnailImage(from:at:)" class="dashAnchor"></a>
588+
<a class="token" href="#/s:20SwiftVideoBackground0bC0C17getThumbnailImage4from2atSo7UIImageC10Foundation3URLV_So6CMTimeatKF">getThumbnailImage(from:at:)</a>
589+
</code>
590+
</div>
591+
<div class="height-container">
592+
<div class="pointer-container"></div>
593+
<section class="section">
594+
<div class="pointer"></div>
595+
<div class="abstract">
596+
<p>Generate an image from the video to show as thumbnail</p>
597+
598+
</div>
599+
<div class="declaration">
600+
<h4>Declaration</h4>
601+
<div class="language">
602+
<p class="aside-title">Swift</p>
603+
<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>
604+
605+
</div>
606+
</div>
607+
<div>
608+
<h4>Parameters</h4>
609+
<table class="graybox">
610+
<tbody>
611+
<tr>
612+
<td>
613+
<code>
614+
<em>url</em>
615+
</code>
616+
</td>
617+
<td>
618+
<div>
619+
<p>video file URL</p>
620+
</div>
621+
</td>
622+
</tr>
623+
<tr>
624+
<td>
625+
<code>
626+
<em>time</em>
627+
</code>
628+
</td>
629+
<td>
630+
<div>
631+
<p>time of video frame to make into thumbnail image</p>
632+
</div>
633+
</td>
634+
</tr>
635+
</tbody>
636+
</table>
637+
</div>
638+
</section>
639+
</div>
640+
</li>
555641
</ul>
556642
</div>
557643
</section>
558644
</section>
559645
<section id="footer">
560-
<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>
646+
<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>
561647
<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>
562648
</section>
563649
</article>

‎docs/docsets/SwiftVideoBackground.docset/Contents/Resources/Documents/Enums.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h4>Declaration</h4>
8989
</section>
9090
</section>
9191
<section id="footer">
92-
<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>
92+
<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>
9393
<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>
9494
</section>
9595
</article>

‎docs/docsets/SwiftVideoBackground.docset/Contents/Resources/Documents/Enums/VideoBackgroundError.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h4>Declaration</h4>
121121
</section>
122122
</section>
123123
<section id="footer">
124-
<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>
124+
<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>
125125
<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>
126126
</section>
127127
</article>

‎docs/docsets/SwiftVideoBackground.docset/Contents/Resources/Documents/index.html‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,9 +204,11 @@ <h4 id='controls' class='heading'>Controls</h4>
204204
<li><code>pause()</code> - Pauses the video.</li>
205205
<li><code>resume()</code> - Resumes the video.</li>
206206
<li><code>restart()</code> - Restarts the video.</li>
207+
<li><code>getThumbnailImage(from: URL, at: CMTime)</code> - Generate an image from the video to show as thumbnail.</li>
207208
<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>
208209
<li><code>isMuted</code> - Change this <code>Bool</code> to mute/unmute the video.</li>
209210
<li><code>willLoopVideo</code> - Change this <code>Bool</code> to set whether the video restarts when it ends.</li>
211+
<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>
210212
<li><code>playerLayer</code> - The <code>AVPlayerLayer</code> that can be accessed for advanced control and customization of the video.</li>
211213
</ul>
212214
<h4 id='singleton' class='heading'>Singleton</h4>
@@ -248,7 +250,7 @@ <h2 id='authors' class='heading'>Authors</h2>
248250
</section>
249251
</section>
250252
<section id="footer">
251-
<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>
253+
<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>
252254
<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>
253255
</section>
254256
</article>

0 commit comments

Comments
 (0)