update docs

piemonte · Sep 5, 2018 · 644360e · 644360e
1 parent c236e37
commit 644360e
Show file tree

Hide file tree

Showing 33 changed files with 181 additions and 74 deletions.
diff --git a/docs/Classes.html b/docs/Classes.html
@@ -13,7 +13,7 @@
     <a title="Classes  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">Player Docs</a> (57% documented)</p>
+        <p><a href="index.html">Player Docs</a> (58% documented)</p>
         <p class="header-right"><a href="https://github.com/piemonte/Player"><img src="img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -162,7 +162,7 @@ <h3 class="section-name">PlayerView</h3>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-03)</p>
+          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-04)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/Player.html b/docs/Classes/Player.html
@@ -14,7 +14,7 @@
     <a title="Player Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">Player Docs</a> (57% documented)</p>
+        <p><a href="../index.html">Player Docs</a> (58% documented)</p>
         <p class="header-right"><a href="https://github.com/piemonte/Player"><img src="../img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -745,8 +745,7 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Return the av player layer for consumption by
-things such as Picture in Picture</p>
+                        <p>Return the av player layer for consumption by things such as Picture in Picture</p>
 
                       </div>
                       <div class="declaration">
@@ -787,6 +786,60 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:6PlayerAAC20preferredPeakBitRateSdvp"></a>
+                    <a name="//apple_ref/swift/Property/preferredPeakBitRate" class="dashAnchor"></a>
+                    <a class="token" href="#/s:6PlayerAAC20preferredPeakBitRateSdvp">preferredPeakBitRate</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Indicates the desired limit of network bandwidth consumption for this item.</p>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight"><code><span class="n">open</span> <span class="k">var</span> <span class="nv">preferredPeakBitRate</span><span class="p">:</span> <span class="kt">Double</span> <span class="o">=</span> <span class="mi">0</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:6PlayerAAC26preferredMaximumResolutionSC6CGSizeVvp"></a>
+                    <a name="//apple_ref/swift/Property/preferredMaximumResolution" class="dashAnchor"></a>
+                    <a class="token" href="#/s:6PlayerAAC26preferredMaximumResolutionSC6CGSizeVvp">preferredMaximumResolution</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Indicates a preferred upper limit on the resolution of the video to be downloaded.</p>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight"><code><span class="n">open</span> <span class="k">var</span> <span class="nv">preferredMaximumResolution</span><span class="p">:</span> <span class="kt">CGSize</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
               </ul>
             </div>
             <div class="task-group">
@@ -1274,7 +1327,7 @@ <h4>Parameters</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-03)</p>
+          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-04)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/PlayerView.html b/docs/Classes/PlayerView.html
@@ -14,7 +14,7 @@
     <a title="PlayerView Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">Player Docs</a> (57% documented)</p>
+        <p><a href="../index.html">Player Docs</a> (58% documented)</p>
         <p class="header-right"><a href="https://github.com/piemonte/Player"><img src="../img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -240,7 +240,7 @@ <h3 class="section-name">object lifecycle</h3>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-03)</p>
+          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-04)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Enums.html b/docs/Enums.html
@@ -13,7 +13,7 @@
     <a title="Enumerations  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">Player Docs</a> (57% documented)</p>
+        <p><a href="index.html">Player Docs</a> (58% documented)</p>
         <p class="header-right"><a href="https://github.com/piemonte/Player"><img src="img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -198,7 +198,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-03)</p>
+          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-04)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Enums/BufferingState.html b/docs/Enums/BufferingState.html
@@ -14,7 +14,7 @@
     <a title="BufferingState Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">Player Docs</a> (57% documented)</p>
+        <p><a href="../index.html">Player Docs</a> (58% documented)</p>
         <p class="header-right"><a href="https://github.com/piemonte/Player"><img src="../img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -222,7 +222,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-03)</p>
+          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-04)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Enums/PlaybackState.html b/docs/Enums/PlaybackState.html
@@ -14,7 +14,7 @@
     <a title="PlaybackState Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">Player Docs</a> (57% documented)</p>
+        <p><a href="../index.html">Player Docs</a> (58% documented)</p>
         <p class="header-right"><a href="https://github.com/piemonte/Player"><img src="../img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -253,7 +253,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-03)</p>
+          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-04)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Enums/PlayerError.html b/docs/Enums/PlayerError.html
@@ -14,7 +14,7 @@
     <a title="PlayerError Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">Player Docs</a> (57% documented)</p>
+        <p><a href="../index.html">Player Docs</a> (58% documented)</p>
         <p class="header-right"><a href="https://github.com/piemonte/Player"><img src="../img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -160,7 +160,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-03)</p>
+          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-04)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Global Variables.html b/docs/Global Variables.html
@@ -13,7 +13,7 @@
     <a title="Global Variables  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">Player Docs</a> (57% documented)</p>
+        <p><a href="index.html">Player Docs</a> (58% documented)</p>
         <p class="header-right"><a href="https://github.com/piemonte/Player"><img src="img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -130,7 +130,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-03)</p>
+          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-04)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Protocols.html b/docs/Protocols.html
@@ -13,7 +13,7 @@
     <a title="Protocols  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">Player Docs</a> (57% documented)</p>
+        <p><a href="index.html">Player Docs</a> (58% documented)</p>
         <p class="header-right"><a href="https://github.com/piemonte/Player"><img src="img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -159,7 +159,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-03)</p>
+          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-04)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Protocols/PlayerDelegate.html b/docs/Protocols/PlayerDelegate.html
@@ -14,7 +14,7 @@
     <a title="PlayerDelegate Protocol Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">Player Docs</a> (57% documented)</p>
+        <p><a href="../index.html">Player Docs</a> (58% documented)</p>
         <p class="header-right"><a href="https://github.com/piemonte/Player"><img src="../img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -238,7 +238,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-03)</p>
+          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-04)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Protocols/PlayerPlaybackDelegate.html b/docs/Protocols/PlayerPlaybackDelegate.html
@@ -14,7 +14,7 @@
     <a title="PlayerPlaybackDelegate Protocol Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">Player Docs</a> (57% documented)</p>
+        <p><a href="../index.html">Player Docs</a> (58% documented)</p>
         <p class="header-right"><a href="https://github.com/piemonte/Player"><img src="../img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -211,7 +211,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-03)</p>
+          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-04)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Typealiases.html b/docs/Typealiases.html
@@ -13,7 +13,7 @@
     <a title="Type Aliases  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">Player Docs</a> (57% documented)</p>
+        <p><a href="index.html">Player Docs</a> (58% documented)</p>
         <p class="header-right"><a href="https://github.com/piemonte/Player"><img src="img/gh.png"/>View on GitHub</a></p>
       </div>
     </header>
@@ -136,7 +136,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-03)</p>
+          <p>&copy; 2018 <a class="link" href="https://patrickpiemonte.com" target="_blank" rel="external">Patrick Piemonte</a>. All rights reserved. (Last updated: 2018-09-04)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/badge.svg b/docs/badge.svg