Skip to content

Commit

Permalink
Regen jazzy docs [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
Travis-CI committed Aug 18, 2019
1 parent a63c7cb commit 211e70c
Show file tree
Hide file tree
Showing 14 changed files with 76 additions and 28 deletions.
2 changes: 1 addition & 1 deletion docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-12)</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-08-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.10.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
42 changes: 33 additions & 9 deletions docs/Classes/VideoBackground.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -257,9 +257,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:20SwiftVideoBackground0bC0C4play4view9videoName0F4Type7isMuted8darkness08willLoopB022setAudioSessionAmbientySo6UIViewC_S2SSb12CoreGraphics7CGFloatVS2btKF"></a>
<a name="//apple_ref/swift/Method/play(view:videoName:videoType:isMuted:darkness:willLoopVideo:setAudioSessionAmbient:)" class="dashAnchor"></a>
<a class="token" href="#/s:20SwiftVideoBackground0bC0C4play4view9videoName0F4Type7isMuted8darkness08willLoopB022setAudioSessionAmbientySo6UIViewC_S2SSb12CoreGraphics7CGFloatVS2btKF">play(view:videoName:videoType:isMuted:darkness:willLoopVideo:setAudioSessionAmbient:)</a>
<a name="/s:20SwiftVideoBackground0bC0C4play4view9videoName0F4Type7isMuted8darkness08willLoopB022setAudioSessionAmbient026preventsDisplaySleepDuringB8PlaybackySo6UIViewC_S2SSb12CoreGraphics7CGFloatVS3btKF"></a>
<a name="//apple_ref/swift/Method/play(view:videoName:videoType:isMuted:darkness:willLoopVideo:setAudioSessionAmbient:preventsDisplaySleepDuringVideoPlayback:)" class="dashAnchor"></a>
<a class="token" href="#/s:20SwiftVideoBackground0bC0C4play4view9videoName0F4Type7isMuted8darkness08willLoopB022setAudioSessionAmbient026preventsDisplaySleepDuringB8PlaybackySo6UIViewC_S2SSb12CoreGraphics7CGFloatVS3btKF">play(view:videoName:videoType:isMuted:darkness:willLoopVideo:setAudioSessionAmbient:preventsDisplaySleepDuringVideoPlayback:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -272,6 +272,13 @@ <h4>Declaration</h4>
<p class="aside-title">Throws</p>
<code>VideoBackgroundError.videoNotFound</code> if the video cannot be found.

<ul>
<li>preventsDisplaySleepDuringVideoPlayback: If automatic lock is being used on the device
setting this property to false will not hold the device awake.
default value for iOS is true.
Only has an effect in iOS 12.0+</li>
</ul>

</div>

</div>
Expand All @@ -285,7 +292,8 @@ <h4>Declaration</h4>
<span class="nv">isMuted</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
<span class="nv">darkness</span><span class="p">:</span> <span class="kt">CGFloat</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="nv">willLoopVideo</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
<span class="nv">setAudioSessionAmbient</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span> <span class="k">throws</span></code></pre>
<span class="nv">setAudioSessionAmbient</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
<span class="nv">preventsDisplaySleepDuringVideoPlayback</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span> <span class="k">throws</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -388,9 +396,9 @@ <h4>Parameters</h4>
<li class="item">
<div>
<code>
<a name="/s:20SwiftVideoBackground0bC0C4play4view3url8darkness7isMuted08willLoopB022setAudioSessionAmbientySo6UIViewC_10Foundation3URLV12CoreGraphics7CGFloatVS3btF"></a>
<a name="//apple_ref/swift/Method/play(view:url:darkness:isMuted:willLoopVideo:setAudioSessionAmbient:)" class="dashAnchor"></a>
<a class="token" href="#/s:20SwiftVideoBackground0bC0C4play4view3url8darkness7isMuted08willLoopB022setAudioSessionAmbientySo6UIViewC_10Foundation3URLV12CoreGraphics7CGFloatVS3btF">play(view:url:darkness:isMuted:willLoopVideo:setAudioSessionAmbient:)</a>
<a name="/s:20SwiftVideoBackground0bC0C4play4view3url8darkness7isMuted08willLoopB022setAudioSessionAmbient026preventsDisplaySleepDuringB8PlaybackySo6UIViewC_10Foundation3URLV12CoreGraphics7CGFloatVS4btF"></a>
<a name="//apple_ref/swift/Method/play(view:url:darkness:isMuted:willLoopVideo:setAudioSessionAmbient:preventsDisplaySleepDuringVideoPlayback:)" class="dashAnchor"></a>
<a class="token" href="#/s:20SwiftVideoBackground0bC0C4play4view3url8darkness7isMuted08willLoopB022setAudioSessionAmbient026preventsDisplaySleepDuringB8PlaybackySo6UIViewC_10Foundation3URLV12CoreGraphics7CGFloatVS4btF">play(view:url:darkness:isMuted:willLoopVideo:setAudioSessionAmbient:preventsDisplaySleepDuringVideoPlayback:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -410,7 +418,8 @@ <h4>Declaration</h4>
<span class="nv">darkness</span><span class="p">:</span> <span class="kt">CGFloat</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="nv">isMuted</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
<span class="nv">willLoopVideo</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
<span class="nv">setAudioSessionAmbient</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span></code></pre>
<span class="nv">setAudioSessionAmbient</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
<span class="nv">preventsDisplaySleepDuringVideoPlayback</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -493,6 +502,21 @@ <h4>Parameters</h4>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>preventsDisplaySleepDuringVideoPlayback</em>
</code>
</td>
<td>
<div>
<p>If automatic lock is being used on the device
setting this property to false will not hold the device awake.
default value for iOS is true.
Only has an effect in iOS 12.0+</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
Expand Down Expand Up @@ -643,7 +667,7 @@ <h4>Parameters</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-08-12)</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-08-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.10.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-12)</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-08-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.10.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Enums/VideoBackgroundError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-12)</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-08-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.10.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/docsets/SwiftVideoBackground.docset/Contents/Resources/Documents/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-12)</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-08-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.10.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
42 changes: 33 additions & 9 deletions ...ets/SwiftVideoBackground.docset/Contents/Resources/Documents/Classes/VideoBackground.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -257,9 +257,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:20SwiftVideoBackground0bC0C4play4view9videoName0F4Type7isMuted8darkness08willLoopB022setAudioSessionAmbientySo6UIViewC_S2SSb12CoreGraphics7CGFloatVS2btKF"></a>
<a name="//apple_ref/swift/Method/play(view:videoName:videoType:isMuted:darkness:willLoopVideo:setAudioSessionAmbient:)" class="dashAnchor"></a>
<a class="token" href="#/s:20SwiftVideoBackground0bC0C4play4view9videoName0F4Type7isMuted8darkness08willLoopB022setAudioSessionAmbientySo6UIViewC_S2SSb12CoreGraphics7CGFloatVS2btKF">play(view:videoName:videoType:isMuted:darkness:willLoopVideo:setAudioSessionAmbient:)</a>
<a name="/s:20SwiftVideoBackground0bC0C4play4view9videoName0F4Type7isMuted8darkness08willLoopB022setAudioSessionAmbient026preventsDisplaySleepDuringB8PlaybackySo6UIViewC_S2SSb12CoreGraphics7CGFloatVS3btKF"></a>
<a name="//apple_ref/swift/Method/play(view:videoName:videoType:isMuted:darkness:willLoopVideo:setAudioSessionAmbient:preventsDisplaySleepDuringVideoPlayback:)" class="dashAnchor"></a>
<a class="token" href="#/s:20SwiftVideoBackground0bC0C4play4view9videoName0F4Type7isMuted8darkness08willLoopB022setAudioSessionAmbient026preventsDisplaySleepDuringB8PlaybackySo6UIViewC_S2SSb12CoreGraphics7CGFloatVS3btKF">play(view:videoName:videoType:isMuted:darkness:willLoopVideo:setAudioSessionAmbient:preventsDisplaySleepDuringVideoPlayback:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -272,6 +272,13 @@ <h4>Declaration</h4>
<p class="aside-title">Throws</p>
<code>VideoBackgroundError.videoNotFound</code> if the video cannot be found.

<ul>
<li>preventsDisplaySleepDuringVideoPlayback: If automatic lock is being used on the device
setting this property to false will not hold the device awake.
default value for iOS is true.
Only has an effect in iOS 12.0+</li>
</ul>

</div>

</div>
Expand All @@ -285,7 +292,8 @@ <h4>Declaration</h4>
<span class="nv">isMuted</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
<span class="nv">darkness</span><span class="p">:</span> <span class="kt">CGFloat</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="nv">willLoopVideo</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
<span class="nv">setAudioSessionAmbient</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span> <span class="k">throws</span></code></pre>
<span class="nv">setAudioSessionAmbient</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
<span class="nv">preventsDisplaySleepDuringVideoPlayback</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span> <span class="k">throws</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -388,9 +396,9 @@ <h4>Parameters</h4>
<li class="item">
<div>
<code>
<a name="/s:20SwiftVideoBackground0bC0C4play4view3url8darkness7isMuted08willLoopB022setAudioSessionAmbientySo6UIViewC_10Foundation3URLV12CoreGraphics7CGFloatVS3btF"></a>
<a name="//apple_ref/swift/Method/play(view:url:darkness:isMuted:willLoopVideo:setAudioSessionAmbient:)" class="dashAnchor"></a>
<a class="token" href="#/s:20SwiftVideoBackground0bC0C4play4view3url8darkness7isMuted08willLoopB022setAudioSessionAmbientySo6UIViewC_10Foundation3URLV12CoreGraphics7CGFloatVS3btF">play(view:url:darkness:isMuted:willLoopVideo:setAudioSessionAmbient:)</a>
<a name="/s:20SwiftVideoBackground0bC0C4play4view3url8darkness7isMuted08willLoopB022setAudioSessionAmbient026preventsDisplaySleepDuringB8PlaybackySo6UIViewC_10Foundation3URLV12CoreGraphics7CGFloatVS4btF"></a>
<a name="//apple_ref/swift/Method/play(view:url:darkness:isMuted:willLoopVideo:setAudioSessionAmbient:preventsDisplaySleepDuringVideoPlayback:)" class="dashAnchor"></a>
<a class="token" href="#/s:20SwiftVideoBackground0bC0C4play4view3url8darkness7isMuted08willLoopB022setAudioSessionAmbient026preventsDisplaySleepDuringB8PlaybackySo6UIViewC_10Foundation3URLV12CoreGraphics7CGFloatVS4btF">play(view:url:darkness:isMuted:willLoopVideo:setAudioSessionAmbient:preventsDisplaySleepDuringVideoPlayback:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -410,7 +418,8 @@ <h4>Declaration</h4>
<span class="nv">darkness</span><span class="p">:</span> <span class="kt">CGFloat</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="nv">isMuted</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
<span class="nv">willLoopVideo</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
<span class="nv">setAudioSessionAmbient</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span></code></pre>
<span class="nv">setAudioSessionAmbient</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
<span class="nv">preventsDisplaySleepDuringVideoPlayback</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -493,6 +502,21 @@ <h4>Parameters</h4>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>preventsDisplaySleepDuringVideoPlayback</em>
</code>
</td>
<td>
<div>
<p>If automatic lock is being used on the device
setting this property to false will not hold the device awake.
default value for iOS is true.
Only has an effect in iOS 12.0+</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
Expand Down Expand Up @@ -643,7 +667,7 @@ <h4>Parameters</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-08-12)</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-08-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.10.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/docsets/SwiftVideoBackground.docset/Contents/Resources/Documents/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-12)</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-08-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.10.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit 211e70c

Please sign in to comment.