spotifywebapiPython 1.0.42__py3-none-any.whl → 1.0.43__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of spotifywebapiPython might be problematic. Click here for more details.

@@ -9,7 +9,7 @@
9
9
  </title>
10
10
  <link rel="icon" type="image/svg+xml" href="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20role%3D%22img%22%20aria-label%3D%22pdoc%20logo%22%20width%3D%22300%22%20height%3D%22150%22%20viewBox%3D%22-1%200%2060%2030%22%3E%3Ctitle%3Epdoc%3C/title%3E%3Cpath%20d%3D%22M29.621%2021.293c-.011-.273-.214-.475-.511-.481a.5.5%200%200%200-.489.503l-.044%201.393c-.097.551-.695%201.215-1.566%201.704-.577.428-1.306.486-2.193.182-1.426-.617-2.467-1.654-3.304-2.487l-.173-.172a3.43%203.43%200%200%200-.365-.306.49.49%200%200%200-.286-.196c-1.718-1.06-4.931-1.47-7.353.191l-.219.15c-1.707%201.187-3.413%202.131-4.328%201.03-.02-.027-.49-.685-.141-1.763.233-.721.546-2.408.772-4.076.042-.09.067-.187.046-.288.166-1.347.277-2.625.241-3.351%201.378-1.008%202.271-2.586%202.271-4.362%200-.976-.272-1.935-.788-2.774-.057-.094-.122-.18-.184-.268.033-.167.052-.339.052-.516%200-1.477-1.202-2.679-2.679-2.679-.791%200-1.496.352-1.987.9a6.3%206.3%200%200%200-1.001.029c-.492-.564-1.207-.929-2.012-.929-1.477%200-2.679%201.202-2.679%202.679A2.65%202.65%200%200%200%20.97%206.554c-.383.747-.595%201.572-.595%202.41%200%202.311%201.507%204.29%203.635%205.107-.037.699-.147%202.27-.423%203.294l-.137.461c-.622%202.042-2.515%208.257%201.727%2010.643%201.614.908%203.06%201.248%204.317%201.248%202.665%200%204.492-1.524%205.322-2.401%201.476-1.559%202.886-1.854%206.491.82%201.877%201.393%203.514%201.753%204.861%201.068%202.223-1.713%202.811-3.867%203.399-6.374.077-.846.056-1.469.054-1.537zm-4.835%204.313c-.054.305-.156.586-.242.629-.034-.007-.131-.022-.307-.157-.145-.111-.314-.478-.456-.908.221.121.432.25.675.355.115.039.219.051.33.081zm-2.251-1.238c-.05.33-.158.648-.252.694-.022.001-.125-.018-.307-.157-.217-.166-.488-.906-.639-1.573.358.344.754.693%201.198%201.036zm-3.887-2.337c-.006-.116-.018-.231-.041-.342.635.145%201.189.368%201.599.625.097.231.166.481.174.642-.03.049-.055.101-.067.158-.046.013-.128.026-.298.004-.278-.037-.901-.57-1.367-1.087zm-1.127-.497c.116.306.176.625.12.71-.019.014-.117.045-.345.016-.206-.027-.604-.332-.986-.695.41-.051.816-.056%201.211-.031zm-4.535%201.535c.209.22.379.47.358.598-.006.041-.088.138-.351.234-.144.055-.539-.063-.979-.259a11.66%2011.66%200%200%200%20.972-.573zm.983-.664c.359-.237.738-.418%201.126-.554.25.237.479.548.457.694-.006.042-.087.138-.351.235-.174.064-.694-.105-1.232-.375zm-3.381%201.794c-.022.145-.061.29-.149.401-.133.166-.358.248-.69.251h-.002c-.133%200-.306-.26-.45-.621.417.091.854.07%201.291-.031zm-2.066-8.077a4.78%204.78%200%200%201-.775-.584c.172-.115.505-.254.88-.378l-.105.962zm-.331%202.302a10.32%2010.32%200%200%201-.828-.502c.202-.143.576-.328.984-.49l-.156.992zm-.45%202.157l-.701-.403c.214-.115.536-.249.891-.376a11.57%2011.57%200%200%201-.19.779zm-.181%201.716c.064.398.194.702.298.893-.194-.051-.435-.162-.736-.398.061-.119.224-.3.438-.495zM8.87%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zm-.735-.389a1.15%201.15%200%200%200-.314.783%201.16%201.16%200%200%200%201.162%201.162c.457%200%20.842-.27%201.032-.653.026.117.042.238.042.362a1.68%201.68%200%200%201-1.679%201.679%201.68%201.68%200%200%201-1.679-1.679c0-.843.626-1.535%201.436-1.654zM5.059%205.406A1.68%201.68%200%200%201%203.38%207.085a1.68%201.68%200%200%201-1.679-1.679c0-.037.009-.072.011-.109.21.3.541.508.935.508a1.16%201.16%200%200%200%201.162-1.162%201.14%201.14%200%200%200-.474-.912c.015%200%20.03-.005.045-.005.926.001%201.679.754%201.679%201.68zM3.198%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zM1.375%208.964c0-.52.103-1.035.288-1.52.466.394%201.06.64%201.717.64%201.144%200%202.116-.725%202.499-1.738.383%201.012%201.355%201.738%202.499%201.738.867%200%201.631-.421%202.121-1.062.307.605.478%201.267.478%201.942%200%202.486-2.153%204.51-4.801%204.51s-4.801-2.023-4.801-4.51zm24.342%2019.349c-.985.498-2.267.168-3.813-.979-3.073-2.281-5.453-3.199-7.813-.705-1.315%201.391-4.163%203.365-8.423.97-3.174-1.786-2.239-6.266-1.261-9.479l.146-.492c.276-1.02.395-2.457.444-3.268a6.11%206.11%200%200%200%201.18.115%206.01%206.01%200%200%200%202.536-.562l-.006.175c-.802.215-1.848.612-2.021%201.25-.079.295.021.601.274.837.219.203.415.364.598.501-.667.304-1.243.698-1.311%201.179-.02.144-.022.507.393.787.213.144.395.26.564.365-1.285.521-1.361.96-1.381%201.126-.018.142-.011.496.427.746l.854.489c-.473.389-.971.914-.999%201.429-.018.278.095.532.316.713.675.556%201.231.721%201.653.721.059%200%20.104-.014.158-.02.207.707.641%201.64%201.513%201.64h.013c.8-.008%201.236-.345%201.462-.626.173-.216.268-.457.325-.692.424.195.93.374%201.372.374.151%200%20.294-.021.423-.068.732-.27.944-.704.993-1.021.009-.061.003-.119.002-.179.266.086.538.147.789.147.15%200%20.294-.021.423-.069.542-.2.797-.489.914-.754.237.147.478.258.704.288.106.014.205.021.296.021.356%200%20.595-.101.767-.229.438.435%201.094.992%201.656%201.067.106.014.205.021.296.021a1.56%201.56%200%200%200%20.323-.035c.17.575.453%201.289.866%201.605.358.273.665.362.914.362a.99.99%200%200%200%20.421-.093%201.03%201.03%200%200%200%20.245-.164c.168.428.39.846.68%201.068.358.273.665.362.913.362a.99.99%200%200%200%20.421-.093c.317-.148.512-.448.639-.762.251.157.495.257.726.257.127%200%20.25-.024.37-.071.427-.17.706-.617.841-1.314.022-.015.047-.022.068-.038.067-.051.133-.104.196-.159-.443%201.486-1.107%202.761-2.086%203.257zM8.66%209.925a.5.5%200%201%200-1%200c0%20.653-.818%201.205-1.787%201.205s-1.787-.552-1.787-1.205a.5.5%200%201%200-1%200c0%201.216%201.25%202.205%202.787%202.205s2.787-.989%202.787-2.205zm4.4%2015.965l-.208.097c-2.661%201.258-4.708%201.436-6.086.527-1.542-1.017-1.88-3.19-1.844-4.198a.4.4%200%200%200-.385-.414c-.242-.029-.406.164-.414.385-.046%201.249.367%203.686%202.202%204.896.708.467%201.547.7%202.51.7%201.248%200%202.706-.392%204.362-1.174l.185-.086a.4.4%200%200%200%20.205-.527c-.089-.204-.326-.291-.527-.206zM9.547%202.292c.093.077.205.114.317.114a.5.5%200%200%200%20.318-.886L8.817.397a.5.5%200%200%200-.703.068.5.5%200%200%200%20.069.703l1.364%201.124zm-7.661-.065c.086%200%20.173-.022.253-.068l1.523-.893a.5.5%200%200%200-.506-.863l-1.523.892a.5.5%200%200%200-.179.685c.094.158.261.247.432.247z%22%20transform%3D%22matrix%28-1%200%200%201%2058%200%29%22%20fill%3D%22%233bb300%22/%3E%3Cpath%20d%3D%22M.3%2021.86V10.18q0-.46.02-.68.04-.22.18-.5.28-.54%201.34-.54%201.06%200%201.42.28.38.26.44.78.76-1.04%202.38-1.04%201.64%200%203.1%201.54%201.46%201.54%201.46%203.58%200%202.04-1.46%203.58-1.44%201.54-3.08%201.54-1.64%200-2.38-.92v4.04q0%20.46-.04.68-.02.22-.18.5-.14.3-.5.42-.36.12-.98.12-.62%200-1-.12-.36-.12-.52-.4-.14-.28-.18-.5-.02-.22-.02-.68zm3.96-9.42q-.46.54-.46%201.18%200%20.64.46%201.18.48.52%201.2.52.74%200%201.24-.52.52-.52.52-1.18%200-.66-.48-1.18-.48-.54-1.26-.54-.76%200-1.22.54zm14.741-8.36q.16-.3.54-.42.38-.12%201-.12.64%200%201.02.12.38.12.52.42.16.3.18.54.04.22.04.68v11.94q0%20.46-.04.7-.02.22-.18.5-.3.54-1.7.54-1.38%200-1.54-.98-.84.96-2.34.96-1.8%200-3.28-1.56-1.48-1.58-1.48-3.66%200-2.1%201.48-3.68%201.5-1.58%203.28-1.58%201.48%200%202.3%201v-4.2q0-.46.02-.68.04-.24.18-.52zm-3.24%2010.86q.52.54%201.26.54.74%200%201.22-.54.5-.54.5-1.18%200-.66-.48-1.22-.46-.56-1.26-.56-.8%200-1.28.56-.48.54-.48%201.2%200%20.66.52%201.2zm7.833-1.2q0-2.4%201.68-3.96%201.68-1.56%203.84-1.56%202.16%200%203.82%201.56%201.66%201.54%201.66%203.94%200%201.66-.86%202.96-.86%201.28-2.1%201.9-1.22.6-2.54.6-1.32%200-2.56-.64-1.24-.66-2.1-1.92-.84-1.28-.84-2.88zm4.18%201.44q.64.48%201.3.48.66%200%201.32-.5.66-.5.66-1.48%200-.98-.62-1.46-.62-.48-1.34-.48-.72%200-1.34.5-.62.5-.62%201.48%200%20.96.64%201.46zm11.412-1.44q0%20.84.56%201.32.56.46%201.18.46.64%200%201.18-.36.56-.38.9-.38.6%200%201.46%201.06.46.58.46%201.04%200%20.76-1.1%201.42-1.14.8-2.8.8-1.86%200-3.58-1.34-.82-.64-1.34-1.7-.52-1.08-.52-2.36%200-1.3.52-2.34.52-1.06%201.34-1.7%201.66-1.32%203.54-1.32.76%200%201.48.22.72.2%201.06.4l.32.2q.36.24.56.38.52.4.52.92%200%20.5-.42%201.14-.72%201.1-1.38%201.1-.38%200-1.08-.44-.36-.34-1.04-.34-.66%200-1.24.48-.58.48-.58%201.34z%22%20fill%3D%22green%22/%3E%3C/svg%3E"/>
11
11
  <!-- build env - Package Name = "spotifywebapiPython" -->
12
- <!-- build env - Package Version = "1.0.42" -->
12
+ <!-- build env - Package Version = "1.0.43" -->
13
13
  <!-- pdoc module.modulename = "spotifywebapipython.spotifyclient" -->
14
14
  <!-- pdoc module.is_package = "False" -->
15
15
  <!-- pdoc root_module_name = "None" -->
@@ -225,6 +225,9 @@
225
225
  <li>
226
226
  <a class="function" href="#SpotifyClient.GetPlayerDevice">GetPlayerDevice</a>
227
227
  </li>
228
+ <li>
229
+ <a class="function" href="#SpotifyClient.PlayerConvertDeviceNameToId">PlayerConvertDeviceNameToId</a>
230
+ </li>
228
231
  <li>
229
232
  <a class="function" href="#SpotifyClient.GetPlayerDevices">GetPlayerDevices</a>
230
233
  </li>
@@ -434,7 +437,7 @@
434
437
 
435
438
  <footer class="footertext">
436
439
  spotifywebapiPython</br>
437
- Version 1.0.42</br>
440
+ Version 1.0.43</br>
438
441
  <a href="https://developer.spotify.com/documentation/web-api" target="_blank">
439
442
  <img src="../spotifywebapipython.ico" alt="brand icon" style="width:32px; height:32px; padding:4px;"/>
440
443
  A Spotify Web Api Client
@@ -761,9 +764,10 @@ output response.</li>
761
764
  <ul>
762
765
  <li><strong>uri (str):</strong> The uri of the item to add to the queue; must be a track or an episode uri. <br />
763
766
  Example: <code>spotify:track:4iV5W9uYEdYUVa79Axb7Rh</code></li>
764
- <li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
767
+ <li><strong>deviceId (str):</strong> The id or name of the device this command is targeting. <br />
765
768
  If not supplied, the user's currently active device is the target. <br />
766
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
769
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> <br />
770
+ Example: <code>Web Player (Chrome)</code> </li>
767
771
  </ul>
768
772
 
769
773
  <h6 id="raises">Raises:</h6>
@@ -807,6 +811,8 @@ and the response contains error information.</li>
807
811
  <span class="c1"># add an item to the end of the user&#39;s current playback queue.</span>
808
812
  <span class="n">trackUri</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;spotify:track:27JODWXo4VNa6s7HqDL9yQ&#39;</span>
809
813
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
814
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
815
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
810
816
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Adding item to the users current playback queue:</span><span class="se">\n</span><span class="s1">- &quot;</span><span class="si">%s</span><span class="s1">&quot; ...&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">trackUri</span><span class="p">))</span>
811
817
  <span class="n">spotify</span><span class="o">.</span><span class="n">AddPlayerQueueItem</span><span class="p">(</span><span class="n">trackUri</span><span class="p">,</span> <span class="n">deviceId</span><span class="p">)</span>
812
818
 
@@ -5675,6 +5681,106 @@ the spotify web api request. This results in better performance.</p>
5675
5681
  </code></pre>
5676
5682
  </div>
5677
5683
 
5684
+ <p></details></p>
5685
+ </div>
5686
+
5687
+
5688
+ </div>
5689
+ <div id="SpotifyClient.PlayerConvertDeviceNameToId" class="classattr">
5690
+ <div class="attr function">
5691
+
5692
+ <span class="def">def</span>
5693
+ <span class="name">PlayerConvertDeviceNameToId</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">value</span><span class="p">:</span> <span class="nb">str</span>, </span><span class="param"><span class="n">refresh</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span></span><span class="return-annotation">) -> <span class="nb">str</span>:</span></span>
5694
+
5695
+
5696
+ </div>
5697
+ <a class="headerlink" href="#SpotifyClient.PlayerConvertDeviceNameToId"></a>
5698
+
5699
+ <div class="docstring"><p>Converts a Spotify Connect player device name to it's equivalent id value if
5700
+ the value is a device name. If the value is a device id, then the value is
5701
+ returned as-is.</p>
5702
+
5703
+ <p>This method requires the <code>user-read-playback-state</code> scope.</p>
5704
+
5705
+ <h6 id="arguments">Arguments:</h6>
5706
+
5707
+ <ul>
5708
+ <li><strong>value (str):</strong> The device id or name value to check.</li>
5709
+ <li><strong>refresh (bool):</strong> True to resolve the device real-time from the spotify web api device list;
5710
+ otherwise, False (default) to use the cached device list to resolve the device.</li>
5711
+ </ul>
5712
+
5713
+ <h6 id="returns">Returns:</h6>
5714
+
5715
+ <blockquote>
5716
+ <p>One of the following: </p>
5717
+
5718
+ <ul>
5719
+ <li>if value is a device id, then the value is returned as-is; no device list
5720
+ lookup is performed, and the value is assumed to be a valid device id. </li>
5721
+ <li>if value is not a device id, then it is assumed to be a name; a device list
5722
+ lookup is performed to retrieve it's device id. if found, then the id is
5723
+ returned; otherwise, the value is returned as-is with the understanding that
5724
+ subsequent operations will fail since it's not in the device list. </li>
5725
+ </ul>
5726
+ </blockquote>
5727
+
5728
+ <h6 id="raises">Raises:</h6>
5729
+
5730
+ <ul>
5731
+ <li><strong>SpotifyWebApiError:</strong> If the Spotify Web API request was for a non-authorization service
5732
+ and the response contains error information.</li>
5733
+ <li><strong>SpotifApiError:</strong> If the method fails for any other reason.</li>
5734
+ </ul>
5735
+
5736
+ <p>The id for the first match found on the device name will be returned if multiple devices
5737
+ are found in the Spotify Connect player device list that have the same name (with different
5738
+ id's). Care should be taken to make device names unique if using device names for
5739
+ methods that require a device id or name.</p>
5740
+
5741
+ <p>If the <code>refresh</code> argument is specified, then the <code><a href="#SpotifyClient.ConfigurationCache">ConfigurationCache</a></code> is updated with
5742
+ the latest Spotify Connect player device list. Use the <code>refresh</code> argument (with False
5743
+ value) to retrieve the cached value and avoid the spotify web api request. This results
5744
+ in better performance.</p>
5745
+
5746
+ <p><details>
5747
+ <summary>Sample Code</summary></p>
5748
+
5749
+ <div class="pdoc-code codehilite">
5750
+ <pre><span></span><code><span class="kn">from</span> <span class="nn">spotifywebapipython</span> <span class="kn">import</span> <span class="o">*</span>
5751
+ <span class="kn">from</span> <span class="nn">spotifywebapipython.models</span> <span class="kn">import</span> <span class="o">*</span>
5752
+
5753
+ <span class="k">try</span><span class="p">:</span>
5754
+
5755
+ <span class="c1"># this sample requires an authorization token, as it requires security scope to accesses user data.</span>
5756
+
5757
+ <span class="n">CLIENT_ID</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;your_client_id&#39;</span>
5758
+ <span class="n">SPOTIFY_SCOPES</span><span class="p">:</span><span class="nb">list</span> <span class="o">=</span> \
5759
+ <span class="p">[</span>
5760
+ <span class="s1">&#39;user-read-email&#39;</span><span class="p">,</span>
5761
+ <span class="s1">&#39;user-read-playback-state&#39;</span>
5762
+ <span class="p">]</span>
5763
+
5764
+ <span class="c1"># create new spotify client instance.</span>
5765
+ <span class="n">spotify</span><span class="p">:</span><span class="n">SpotifyClient</span> <span class="o">=</span> <span class="n">SpotifyClient</span><span class="p">()</span>
5766
+
5767
+ <span class="c1"># generate a spotify authorization code with PKCE access token (with scope, private and public data use).</span>
5768
+ <span class="n">spotify</span><span class="o">.</span><span class="n">SetAuthTokenAuthorizationCodePKCE</span><span class="p">(</span><span class="n">CLIENT_ID</span><span class="p">,</span> <span class="n">SPOTIFY_SCOPES</span><span class="p">)</span>
5769
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Auth Token:</span><span class="se">\n</span><span class="s1"> Type=&quot;</span><span class="si">%s</span><span class="s1">&quot;</span><span class="se">\n</span><span class="s1"> Scope=&quot;</span><span class="si">%s</span><span class="s1">&quot;&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">spotify</span><span class="o">.</span><span class="n">AuthToken</span><span class="o">.</span><span class="n">AuthorizationType</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">spotify</span><span class="o">.</span><span class="n">AuthToken</span><span class="o">.</span><span class="n">Scope</span><span class="p">)))</span>
5770
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">User:</span><span class="se">\n</span><span class="s1"> DisplayName=&quot;</span><span class="si">%s</span><span class="s1">&quot;</span><span class="se">\n</span><span class="s1"> EMail=&quot;</span><span class="si">%s</span><span class="s1">&quot;&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">spotify</span><span class="o">.</span><span class="n">UserProfile</span><span class="o">.</span><span class="n">DisplayName</span><span class="p">,</span> <span class="n">spotify</span><span class="o">.</span><span class="n">UserProfile</span><span class="o">.</span><span class="n">EMail</span><span class="p">))</span>
5771
+
5772
+ <span class="c1"># get device id for specified device name.</span>
5773
+ <span class="n">deviceName</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;Web Player (Chrome)&#39;</span>
5774
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Getting Spotify Connect Player device id for name:</span><span class="se">\n</span><span class="s1">- Name: </span><span class="si">%s</span><span class="s1"> ...&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">deviceName</span><span class="p">))</span>
5775
+ <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerConvertDeviceNameToId</span><span class="p">(</span><span class="n">deviceName</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
5776
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;- ID: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">deviceId</span><span class="p">))</span>
5777
+
5778
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
5779
+
5780
+ <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;** Exception: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
5781
+ </code></pre>
5782
+ </div>
5783
+
5678
5784
  <p></details></p>
5679
5785
  </div>
5680
5786
 
@@ -8699,9 +8805,10 @@ and the response contains error information.</li>
8699
8805
  <h6 id="arguments">Arguments:</h6>
8700
8806
 
8701
8807
  <ul>
8702
- <li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
8808
+ <li><strong>deviceId (str):</strong> The id or name of the device this command is targeting. <br />
8703
8809
  If not supplied, the user's currently active device is the target. <br />
8704
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
8810
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> <br />
8811
+ Example: <code>Web Player (Chrome)</code> </li>
8705
8812
  <li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
8706
8813
  This delay will give the spotify web api time to process the change before
8707
8814
  another command is issued. <br />
@@ -8748,6 +8855,8 @@ and the response contains error information.</li>
8748
8855
 
8749
8856
  <span class="c1"># pause play on the specified Spotify Connect device.</span>
8750
8857
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
8858
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
8859
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
8751
8860
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Pause media on Spotify Connect device:</span><span class="se">\n</span><span class="s1">- &quot;</span><span class="si">%s</span><span class="s1">&quot; ...&#39;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">deviceId</span><span class="p">))</span>
8752
8861
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerMediaPause</span><span class="p">(</span><span class="n">deviceId</span><span class="p">)</span>
8753
8862
 
@@ -8799,9 +8908,10 @@ Passing in a position that is greater than the length of the track will cause th
8799
8908
  player to start playing the next track. <br />
8800
8909
  Default is <code>0</code>. <br />
8801
8910
  Example: <code>25000</code> </li>
8802
- <li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
8911
+ <li><strong>deviceId (str):</strong> The id or name of the device this command is targeting. <br />
8803
8912
  If not supplied, the user's currently active device is the target. <br />
8804
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
8913
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> <br />
8914
+ Example: <code>Web Player (Chrome)</code> </li>
8805
8915
  <li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
8806
8916
  This delay will give the spotify web api time to process the change before
8807
8917
  another command is issued. <br />
@@ -8848,6 +8958,8 @@ and the response contains error information.</li>
8848
8958
 
8849
8959
  <span class="c1"># play album on the specified Spotify Connect device.</span>
8850
8960
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
8961
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
8962
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
8851
8963
  <span class="n">contextUri</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;spotify:album:6vc9OTcyd3hyzabCmsdnwE&#39;</span> <span class="c1"># Album = Welcome to the New</span>
8852
8964
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Playing album on Spotify Connect device: </span><span class="se">\n</span><span class="s1">ID: </span><span class="si">%s</span><span class="s1"> </span><span class="se">\n</span><span class="s1">- </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">deviceId</span><span class="p">,</span> <span class="n">contextUri</span><span class="p">))</span>
8853
8965
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerMediaPlayContext</span><span class="p">(</span><span class="n">contextUri</span><span class="p">,</span> <span class="n">deviceId</span><span class="o">=</span><span class="n">deviceId</span><span class="p">)</span>
@@ -8915,6 +9027,8 @@ and the response contains error information.</li>
8915
9027
 
8916
9028
  <span class="c1"># play artist on the specified Spotify Connect device.</span>
8917
9029
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
9030
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
9031
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
8918
9032
  <span class="n">contextUri</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;spotify:artist:6APm8EjxOHSYM5B4i3vT3q&#39;</span> <span class="c1"># Artist = MercyMe</span>
8919
9033
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Playing artist on Spotify Connect device: </span><span class="se">\n</span><span class="s1">ID: </span><span class="si">%s</span><span class="s1"> </span><span class="se">\n</span><span class="s1">- </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">deviceId</span><span class="p">,</span> <span class="n">contextUri</span><span class="p">))</span>
8920
9034
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerMediaPlayContext</span><span class="p">(</span><span class="n">contextUri</span><span class="p">,</span> <span class="n">deviceId</span><span class="o">=</span><span class="n">deviceId</span><span class="p">)</span>
@@ -8965,6 +9079,8 @@ and the response contains error information.</li>
8965
9079
 
8966
9080
  <span class="c1"># play playlist on the specified Spotify Connect device.</span>
8967
9081
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
9082
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
9083
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
8968
9084
  <span class="n">contextUri</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;spotify:playlist:5v5ETK9WFXAnGQ3MRubKuE&#39;</span> <span class="c1"># Playlist = My Playlist</span>
8969
9085
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Playing playlist on Spotify Connect device: </span><span class="se">\n</span><span class="s1">ID: </span><span class="si">%s</span><span class="s1"> </span><span class="se">\n</span><span class="s1">- </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">deviceId</span><span class="p">,</span> <span class="n">contextUri</span><span class="p">))</span>
8970
9086
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerMediaPlayContext</span><span class="p">(</span><span class="n">contextUri</span><span class="p">,</span> <span class="n">deviceId</span><span class="o">=</span><span class="n">deviceId</span><span class="p">)</span>
@@ -9023,9 +9139,10 @@ and starts playing them.</p>
9023
9139
  <h6 id="arguments">Arguments:</h6>
9024
9140
 
9025
9141
  <ul>
9026
- <li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
9142
+ <li><strong>deviceId (str):</strong> The id or name of the device this command is targeting. <br />
9027
9143
  If not supplied, the user's currently active device is the target. <br />
9028
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
9144
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> <br />
9145
+ Example: <code>Web Player (Chrome)</code> </li>
9029
9146
  <li><strong>shuffle (bool):</strong> True to set player shuffle mode to on; otherwise, False for no shuffle.</li>
9030
9147
  <li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
9031
9148
  This delay will give the spotify web api time to process the change before
@@ -9074,6 +9191,8 @@ favorite tracks (200 max), then calls the <code><a href="#SpotifyClient.PlayerMe
9074
9191
 
9075
9192
  <span class="c1"># play all track favorites on the specified Spotify Connect device.</span>
9076
9193
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
9194
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
9195
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
9077
9196
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Playing track favorites on Spotify Connect device: </span><span class="se">\n</span><span class="s1">ID: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">deviceId</span><span class="p">)</span>
9078
9197
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerMediaPlayTrackFavorites</span><span class="p">(</span><span class="n">deviceId</span><span class="p">)</span>
9079
9198
 
@@ -9117,9 +9236,10 @@ Passing in a position that is greater than the length of the track will cause th
9117
9236
  player to start playing the next track. <br />
9118
9237
  Default is <code>0</code>. <br />
9119
9238
  Example: <code>25000</code> </li>
9120
- <li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
9239
+ <li><strong>deviceId (str):</strong> The id or name of the device this command is targeting. <br />
9121
9240
  If not supplied, the user's currently active device is the target. <br />
9122
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
9241
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> <br />
9242
+ Example: <code>Web Player (Chrome)</code> </li>
9123
9243
  <li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
9124
9244
  This delay will give the spotify web api time to process the change before
9125
9245
  another command is issued. <br />
@@ -9166,6 +9286,8 @@ and the response contains error information.</li>
9166
9286
 
9167
9287
  <span class="c1"># play single track on the specified Spotify Connect device.</span>
9168
9288
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
9289
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
9290
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
9169
9291
  <span class="n">uris</span><span class="p">:</span><span class="nb">str</span><span class="o">=</span><span class="s1">&#39;spotify:track:1kWUud3vY5ij5r62zxpTRy&#39;</span> <span class="c1"># Flawless</span>
9170
9292
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Playing media on Spotify Connect device: </span><span class="se">\n</span><span class="s1">ID: </span><span class="si">%s</span><span class="s1"> </span><span class="se">\n</span><span class="s1">- </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">deviceId</span><span class="p">,</span> <span class="n">uris</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;,&#39;</span><span class="p">,</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">- &#39;</span><span class="p">)))</span>
9171
9293
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerMediaPlayTracks</span><span class="p">(</span><span class="n">uris</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">deviceId</span><span class="p">)</span>
@@ -9217,9 +9339,10 @@ and the response contains error information.</li>
9217
9339
  <h6 id="arguments">Arguments:</h6>
9218
9340
 
9219
9341
  <ul>
9220
- <li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
9342
+ <li><strong>deviceId (str):</strong> The id or name of the device this command is targeting. <br />
9221
9343
  If not supplied, the user's currently active device is the target. <br />
9222
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
9344
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> <br />
9345
+ Example: <code>Web Player (Chrome)</code> </li>
9223
9346
  <li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
9224
9347
  This delay will give the spotify web api time to process the change before
9225
9348
  another command is issued. <br />
@@ -9266,6 +9389,8 @@ and the response contains error information.</li>
9266
9389
 
9267
9390
  <span class="c1"># resume play on the specified Spotify Connect device.</span>
9268
9391
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
9392
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
9393
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
9269
9394
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Resume media on Spotify Connect device:</span><span class="se">\n</span><span class="s1">- &quot;</span><span class="si">%s</span><span class="s1">&quot; ...&#39;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">deviceId</span><span class="p">))</span>
9270
9395
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerMediaResume</span><span class="p">(</span><span class="n">deviceId</span><span class="p">)</span>
9271
9396
 
@@ -9304,9 +9429,10 @@ Spotify Connect device.</p>
9304
9429
  Passing in a position that is greater than the length of the track will cause the
9305
9430
  player to start playing the next song.
9306
9431
  Example: <code>25000</code> </li>
9307
- <li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
9432
+ <li><strong>deviceId (str):</strong> The id or name of the device this command is targeting. <br />
9308
9433
  If not supplied, the user's currently active device is the target. <br />
9309
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
9434
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> <br />
9435
+ Example: <code>Web Player (Chrome)</code> </li>
9310
9436
  <li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
9311
9437
  This delay will give the spotify web api time to process the change before
9312
9438
  another command is issued. <br />
@@ -9354,6 +9480,8 @@ and the response contains error information.</li>
9354
9480
  <span class="c1"># seek to the given position in the on the specified Spotify Connect device.</span>
9355
9481
  <span class="n">positionMS</span><span class="p">:</span><span class="nb">int</span> <span class="o">=</span> <span class="mi">25000</span>
9356
9482
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
9483
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
9484
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
9357
9485
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Seeking to </span><span class="si">%d</span><span class="s1"> milliseconds on Spotify Connect device:</span><span class="se">\n</span><span class="s1">- &quot;</span><span class="si">%s</span><span class="s1">&quot; ...&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">positionMS</span><span class="p">,</span> <span class="n">deviceId</span><span class="p">))</span>
9358
9486
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerMediaSeek</span><span class="p">(</span><span class="n">positionMS</span><span class="p">,</span> <span class="n">deviceId</span><span class="p">)</span>
9359
9487
 
@@ -9387,9 +9515,10 @@ and the response contains error information.</li>
9387
9515
  <h6 id="arguments">Arguments:</h6>
9388
9516
 
9389
9517
  <ul>
9390
- <li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
9518
+ <li><strong>deviceId (str):</strong> The id or name of the device this command is targeting. <br />
9391
9519
  If not supplied, the user's currently active device is the target. <br />
9392
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
9520
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> <br />
9521
+ Example: <code>Web Player (Chrome)</code> </li>
9393
9522
  <li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
9394
9523
  This delay will give the spotify web api time to process the change before
9395
9524
  another command is issued. <br />
@@ -9436,6 +9565,8 @@ and the response contains error information.</li>
9436
9565
 
9437
9566
  <span class="c1"># skip to next track on the specified Spotify Connect device.</span>
9438
9567
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
9568
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
9569
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
9439
9570
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Skip to next track on Spotify Connect device:</span><span class="se">\n</span><span class="s1">- &quot;</span><span class="si">%s</span><span class="s1">&quot; ...&#39;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">deviceId</span><span class="p">))</span>
9440
9571
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerMediaSkipNext</span><span class="p">(</span><span class="n">deviceId</span><span class="p">)</span>
9441
9572
 
@@ -9469,9 +9600,10 @@ and the response contains error information.</li>
9469
9600
  <h6 id="arguments">Arguments:</h6>
9470
9601
 
9471
9602
  <ul>
9472
- <li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
9603
+ <li><strong>deviceId (str):</strong> The id or name of the device this command is targeting. <br />
9473
9604
  If not supplied, the user's currently active device is the target. <br />
9474
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
9605
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> <br />
9606
+ Example: <code>Web Player (Chrome)</code> </li>
9475
9607
  <li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
9476
9608
  This delay will give the spotify web api time to process the change before
9477
9609
  another command is issued. <br />
@@ -9518,6 +9650,8 @@ and the response contains error information.</li>
9518
9650
 
9519
9651
  <span class="c1"># skip to previous track on the specified Spotify Connect device.</span>
9520
9652
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
9653
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
9654
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
9521
9655
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Skip to previous track on Spotify Connect device:</span><span class="se">\n</span><span class="s1">- &quot;</span><span class="si">%s</span><span class="s1">&quot; ...&#39;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">deviceId</span><span class="p">))</span>
9522
9656
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerMediaSkipPrevious</span><span class="p">(</span><span class="n">deviceId</span><span class="p">)</span>
9523
9657
 
@@ -9558,9 +9692,10 @@ and the response contains error information.</li>
9558
9692
  <li><code>off</code> - will turn repeat off.
9559
9693
  Default: <code>off</code> </li>
9560
9694
  </ul></li>
9561
- <li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
9695
+ <li><strong>deviceId (str):</strong> The id or name of the device this command is targeting. <br />
9562
9696
  If not supplied, the user's currently active device is the target. <br />
9563
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
9697
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> <br />
9698
+ Example: <code>Web Player (Chrome)</code> </li>
9564
9699
  <li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
9565
9700
  This delay will give the spotify web api time to process the change before
9566
9701
  another command is issued. <br />
@@ -9607,6 +9742,8 @@ and the response contains error information.</li>
9607
9742
 
9608
9743
  <span class="c1"># set repeat mode CONTEXT for the user&#39;s current playback device.</span>
9609
9744
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
9745
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
9746
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
9610
9747
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Set repeat mode CONTEXT for Spotify Connect device:</span><span class="se">\n</span><span class="s1">- &quot;</span><span class="si">%s</span><span class="s1">&quot; ...&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">deviceId</span><span class="p">)))</span>
9611
9748
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerSetRepeatMode</span><span class="p">(</span><span class="s1">&#39;context&#39;</span><span class="p">,</span> <span class="n">deviceId</span><span class="p">)</span>
9612
9749
 
@@ -9660,9 +9797,10 @@ and the response contains error information.</li>
9660
9797
  <li><code>False</code> - Do not shuffle user's playback.
9661
9798
  Default: <code>False</code> </li>
9662
9799
  </ul></li>
9663
- <li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
9800
+ <li><strong>deviceId (str):</strong> The id or name of the device this command is targeting. <br />
9664
9801
  If not supplied, the user's currently active device is the target. <br />
9665
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
9802
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> <br />
9803
+ Example: <code>Web Player (Chrome)</code> </li>
9666
9804
  <li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
9667
9805
  This delay will give the spotify web api time to process the change before
9668
9806
  another command is issued. <br />
@@ -9709,6 +9847,8 @@ and the response contains error information.</li>
9709
9847
 
9710
9848
  <span class="c1"># set shuffle mode ON for the user&#39;s current playback device.</span>
9711
9849
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
9850
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
9851
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
9712
9852
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Set shuffle mode ON for Spotify Connect device:</span><span class="se">\n</span><span class="s1">- &quot;</span><span class="si">%s</span><span class="s1">&quot; ...&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">deviceId</span><span class="p">)))</span>
9713
9853
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerSetShuffleMode</span><span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="n">deviceId</span><span class="p">)</span>
9714
9854
 
@@ -9752,9 +9892,10 @@ and the response contains error information.</li>
9752
9892
  <li><strong>volumePercent (int):</strong> The volume to set. <br />
9753
9893
  Must be a value from 0 to 100 inclusive.
9754
9894
  Example: <code>50</code></li>
9755
- <li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
9895
+ <li><strong>deviceId (str):</strong> The id or name of the device this command is targeting. <br />
9756
9896
  If not supplied, the user's currently active device is the target. <br />
9757
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
9897
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> <br />
9898
+ Example: <code>Web Player (Chrome)</code> </li>
9758
9899
  <li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
9759
9900
  This delay will give the spotify web api time to process the change before
9760
9901
  another command is issued. <br />
@@ -9797,6 +9938,8 @@ and the response contains error information.</li>
9797
9938
  <span class="c1"># set the volume for the user&#39;s current playback device.</span>
9798
9939
  <span class="n">volumePercent</span><span class="p">:</span><span class="nb">int</span> <span class="o">=</span> <span class="mi">100</span>
9799
9940
  <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># use currently playing device</span>
9941
+ <span class="c1">#deviceId:str = &quot;Web Player (Chrome)&quot; # or device name</span>
9942
+ <span class="c1">#deviceId:str = &quot;0d1841b0976bae2a3a310dd74c0f3df354899bc8&quot; # or device id</span>
9800
9943
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Set </span><span class="si">%d%%</span><span class="s1"> volume on Spotify Connect device:</span><span class="se">\n</span><span class="s1">- &quot;</span><span class="si">%s</span><span class="s1">&quot; ...&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">volumePercent</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">deviceId</span><span class="p">)))</span>
9801
9944
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerSetVolume</span><span class="p">(</span><span class="n">volumePercent</span><span class="p">,</span> <span class="n">deviceId</span><span class="p">)</span>
9802
9945
 
@@ -9830,8 +9973,9 @@ and the response contains error information.</li>
9830
9973
  <h6 id="arguments">Arguments:</h6>
9831
9974
 
9832
9975
  <ul>
9833
- <li><strong>deviceId (str):</strong> The id of the device on which playback should be started/transferred.
9834
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
9976
+ <li><strong>deviceId (str):</strong> The id or name of the device on which playback should be started/transferred.
9977
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> <br />
9978
+ Example: <code>Web Player (Chrome)</code> </li>
9835
9979
  <li><strong>play (bool):</strong> The transfer method: <br />
9836
9980
  <ul>
9837
9981
  <li><code>True</code> - ensure playback happens on new device. </li>
@@ -9884,18 +10028,16 @@ and the response contains error information.</li>
9884
10028
 
9885
10029
  <span class="c1"># transfer Spotify Connect playback control to another device.</span>
9886
10030
  <span class="c1"># the device name and id can be retrieved from `GetPlayerDevices` method.</span>
9887
- <span class="n">deviceName</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;Web Player (Chrome)&#39;</span>
9888
- <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;13c7b6361ab322f28c39bf7638f058290d88bb58&#39;</span>
9889
- <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Transfer Spotify Connect playback control to:</span><span class="se">\n</span><span class="s1">-Name: &quot;</span><span class="si">%s</span><span class="s1">&quot;</span><span class="se">\n</span><span class="s1">ID: </span><span class="si">%s</span><span class="s1"> ...&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">deviceName</span><span class="p">,</span> <span class="n">deviceId</span><span class="p">))</span>
10031
+ <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;Web Player (Chrome)&quot;</span> <span class="c1"># or device name</span>
10032
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Transfer Spotify Connect playback control to:</span><span class="se">\n</span><span class="s1">-Name: &quot;</span><span class="si">%s</span><span class="s1">&quot; ...&#39;</span> <span class="o">%</span> <span class="n">deviceId</span><span class="p">)</span>
9890
10033
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerTransferPlayback</span><span class="p">(</span><span class="n">deviceId</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
9891
10034
 
9892
10035
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - control was transferred&#39;</span><span class="p">)</span>
9893
10036
 
9894
10037
  <span class="c1"># transfer Spotify Connect playback control to another device.</span>
9895
10038
  <span class="c1"># the device name and id can be retrieved from `GetPlayerDevices` method.</span>
9896
- <span class="n">deviceName</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;Bose ST-10 Speaker&#39;</span>
9897
- <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;30fbc80e35598f3c242f2120413c943dfd9715fe&#39;</span>
9898
- <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Transfer Spotify Connect playback control to:</span><span class="se">\n</span><span class="s1">-Name: &quot;</span><span class="si">%s</span><span class="s1">&quot;</span><span class="se">\n</span><span class="s1">ID: </span><span class="si">%s</span><span class="s1"> ...&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">deviceName</span><span class="p">,</span> <span class="n">deviceId</span><span class="p">))</span>
10039
+ <span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;Bose-ST10-1&#39;</span>
10040
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Transfer Spotify Connect playback control to:</span><span class="se">\n</span><span class="s1">-Name: &quot;</span><span class="si">%s</span><span class="s1">&quot; ...&#39;</span> <span class="o">%</span> <span class="n">deviceId</span><span class="p">)</span>
9899
10041
  <span class="n">spotify</span><span class="o">.</span><span class="n">PlayerTransferPlayback</span><span class="p">(</span><span class="n">deviceId</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
9900
10042
 
9901
10043
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - control was transferred&#39;</span><span class="p">)</span>
@@ -9932,8 +10074,8 @@ and optionally start play on the device.</p>
9932
10074
 
9933
10075
  <ul>
9934
10076
  <li><strong>defaultDeviceId (str):</strong> The id of the device on which playback should be started/transferred if there is
9935
- currently no active device.
9936
- Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
10077
+ currently no active device. <br />
10078
+ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code> </li>
9937
10079
  <li><strong>play (bool):</strong> The transfer method: <br />
9938
10080
  <ul>
9939
10081
  <li><code>True</code> - ensure playback happens on new device. </li>
@@ -9,7 +9,7 @@
9
9
  </title>
10
10
  <link rel="icon" type="image/svg+xml" href="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20role%3D%22img%22%20aria-label%3D%22pdoc%20logo%22%20width%3D%22300%22%20height%3D%22150%22%20viewBox%3D%22-1%200%2060%2030%22%3E%3Ctitle%3Epdoc%3C/title%3E%3Cpath%20d%3D%22M29.621%2021.293c-.011-.273-.214-.475-.511-.481a.5.5%200%200%200-.489.503l-.044%201.393c-.097.551-.695%201.215-1.566%201.704-.577.428-1.306.486-2.193.182-1.426-.617-2.467-1.654-3.304-2.487l-.173-.172a3.43%203.43%200%200%200-.365-.306.49.49%200%200%200-.286-.196c-1.718-1.06-4.931-1.47-7.353.191l-.219.15c-1.707%201.187-3.413%202.131-4.328%201.03-.02-.027-.49-.685-.141-1.763.233-.721.546-2.408.772-4.076.042-.09.067-.187.046-.288.166-1.347.277-2.625.241-3.351%201.378-1.008%202.271-2.586%202.271-4.362%200-.976-.272-1.935-.788-2.774-.057-.094-.122-.18-.184-.268.033-.167.052-.339.052-.516%200-1.477-1.202-2.679-2.679-2.679-.791%200-1.496.352-1.987.9a6.3%206.3%200%200%200-1.001.029c-.492-.564-1.207-.929-2.012-.929-1.477%200-2.679%201.202-2.679%202.679A2.65%202.65%200%200%200%20.97%206.554c-.383.747-.595%201.572-.595%202.41%200%202.311%201.507%204.29%203.635%205.107-.037.699-.147%202.27-.423%203.294l-.137.461c-.622%202.042-2.515%208.257%201.727%2010.643%201.614.908%203.06%201.248%204.317%201.248%202.665%200%204.492-1.524%205.322-2.401%201.476-1.559%202.886-1.854%206.491.82%201.877%201.393%203.514%201.753%204.861%201.068%202.223-1.713%202.811-3.867%203.399-6.374.077-.846.056-1.469.054-1.537zm-4.835%204.313c-.054.305-.156.586-.242.629-.034-.007-.131-.022-.307-.157-.145-.111-.314-.478-.456-.908.221.121.432.25.675.355.115.039.219.051.33.081zm-2.251-1.238c-.05.33-.158.648-.252.694-.022.001-.125-.018-.307-.157-.217-.166-.488-.906-.639-1.573.358.344.754.693%201.198%201.036zm-3.887-2.337c-.006-.116-.018-.231-.041-.342.635.145%201.189.368%201.599.625.097.231.166.481.174.642-.03.049-.055.101-.067.158-.046.013-.128.026-.298.004-.278-.037-.901-.57-1.367-1.087zm-1.127-.497c.116.306.176.625.12.71-.019.014-.117.045-.345.016-.206-.027-.604-.332-.986-.695.41-.051.816-.056%201.211-.031zm-4.535%201.535c.209.22.379.47.358.598-.006.041-.088.138-.351.234-.144.055-.539-.063-.979-.259a11.66%2011.66%200%200%200%20.972-.573zm.983-.664c.359-.237.738-.418%201.126-.554.25.237.479.548.457.694-.006.042-.087.138-.351.235-.174.064-.694-.105-1.232-.375zm-3.381%201.794c-.022.145-.061.29-.149.401-.133.166-.358.248-.69.251h-.002c-.133%200-.306-.26-.45-.621.417.091.854.07%201.291-.031zm-2.066-8.077a4.78%204.78%200%200%201-.775-.584c.172-.115.505-.254.88-.378l-.105.962zm-.331%202.302a10.32%2010.32%200%200%201-.828-.502c.202-.143.576-.328.984-.49l-.156.992zm-.45%202.157l-.701-.403c.214-.115.536-.249.891-.376a11.57%2011.57%200%200%201-.19.779zm-.181%201.716c.064.398.194.702.298.893-.194-.051-.435-.162-.736-.398.061-.119.224-.3.438-.495zM8.87%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zm-.735-.389a1.15%201.15%200%200%200-.314.783%201.16%201.16%200%200%200%201.162%201.162c.457%200%20.842-.27%201.032-.653.026.117.042.238.042.362a1.68%201.68%200%200%201-1.679%201.679%201.68%201.68%200%200%201-1.679-1.679c0-.843.626-1.535%201.436-1.654zM5.059%205.406A1.68%201.68%200%200%201%203.38%207.085a1.68%201.68%200%200%201-1.679-1.679c0-.037.009-.072.011-.109.21.3.541.508.935.508a1.16%201.16%200%200%200%201.162-1.162%201.14%201.14%200%200%200-.474-.912c.015%200%20.03-.005.045-.005.926.001%201.679.754%201.679%201.68zM3.198%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zM1.375%208.964c0-.52.103-1.035.288-1.52.466.394%201.06.64%201.717.64%201.144%200%202.116-.725%202.499-1.738.383%201.012%201.355%201.738%202.499%201.738.867%200%201.631-.421%202.121-1.062.307.605.478%201.267.478%201.942%200%202.486-2.153%204.51-4.801%204.51s-4.801-2.023-4.801-4.51zm24.342%2019.349c-.985.498-2.267.168-3.813-.979-3.073-2.281-5.453-3.199-7.813-.705-1.315%201.391-4.163%203.365-8.423.97-3.174-1.786-2.239-6.266-1.261-9.479l.146-.492c.276-1.02.395-2.457.444-3.268a6.11%206.11%200%200%200%201.18.115%206.01%206.01%200%200%200%202.536-.562l-.006.175c-.802.215-1.848.612-2.021%201.25-.079.295.021.601.274.837.219.203.415.364.598.501-.667.304-1.243.698-1.311%201.179-.02.144-.022.507.393.787.213.144.395.26.564.365-1.285.521-1.361.96-1.381%201.126-.018.142-.011.496.427.746l.854.489c-.473.389-.971.914-.999%201.429-.018.278.095.532.316.713.675.556%201.231.721%201.653.721.059%200%20.104-.014.158-.02.207.707.641%201.64%201.513%201.64h.013c.8-.008%201.236-.345%201.462-.626.173-.216.268-.457.325-.692.424.195.93.374%201.372.374.151%200%20.294-.021.423-.068.732-.27.944-.704.993-1.021.009-.061.003-.119.002-.179.266.086.538.147.789.147.15%200%20.294-.021.423-.069.542-.2.797-.489.914-.754.237.147.478.258.704.288.106.014.205.021.296.021.356%200%20.595-.101.767-.229.438.435%201.094.992%201.656%201.067.106.014.205.021.296.021a1.56%201.56%200%200%200%20.323-.035c.17.575.453%201.289.866%201.605.358.273.665.362.914.362a.99.99%200%200%200%20.421-.093%201.03%201.03%200%200%200%20.245-.164c.168.428.39.846.68%201.068.358.273.665.362.913.362a.99.99%200%200%200%20.421-.093c.317-.148.512-.448.639-.762.251.157.495.257.726.257.127%200%20.25-.024.37-.071.427-.17.706-.617.841-1.314.022-.015.047-.022.068-.038.067-.051.133-.104.196-.159-.443%201.486-1.107%202.761-2.086%203.257zM8.66%209.925a.5.5%200%201%200-1%200c0%20.653-.818%201.205-1.787%201.205s-1.787-.552-1.787-1.205a.5.5%200%201%200-1%200c0%201.216%201.25%202.205%202.787%202.205s2.787-.989%202.787-2.205zm4.4%2015.965l-.208.097c-2.661%201.258-4.708%201.436-6.086.527-1.542-1.017-1.88-3.19-1.844-4.198a.4.4%200%200%200-.385-.414c-.242-.029-.406.164-.414.385-.046%201.249.367%203.686%202.202%204.896.708.467%201.547.7%202.51.7%201.248%200%202.706-.392%204.362-1.174l.185-.086a.4.4%200%200%200%20.205-.527c-.089-.204-.326-.291-.527-.206zM9.547%202.292c.093.077.205.114.317.114a.5.5%200%200%200%20.318-.886L8.817.397a.5.5%200%200%200-.703.068.5.5%200%200%200%20.069.703l1.364%201.124zm-7.661-.065c.086%200%20.173-.022.253-.068l1.523-.893a.5.5%200%200%200-.506-.863l-1.523.892a.5.5%200%200%200-.179.685c.094.158.261.247.432.247z%22%20transform%3D%22matrix%28-1%200%200%201%2058%200%29%22%20fill%3D%22%233bb300%22/%3E%3Cpath%20d%3D%22M.3%2021.86V10.18q0-.46.02-.68.04-.22.18-.5.28-.54%201.34-.54%201.06%200%201.42.28.38.26.44.78.76-1.04%202.38-1.04%201.64%200%203.1%201.54%201.46%201.54%201.46%203.58%200%202.04-1.46%203.58-1.44%201.54-3.08%201.54-1.64%200-2.38-.92v4.04q0%20.46-.04.68-.02.22-.18.5-.14.3-.5.42-.36.12-.98.12-.62%200-1-.12-.36-.12-.52-.4-.14-.28-.18-.5-.02-.22-.02-.68zm3.96-9.42q-.46.54-.46%201.18%200%20.64.46%201.18.48.52%201.2.52.74%200%201.24-.52.52-.52.52-1.18%200-.66-.48-1.18-.48-.54-1.26-.54-.76%200-1.22.54zm14.741-8.36q.16-.3.54-.42.38-.12%201-.12.64%200%201.02.12.38.12.52.42.16.3.18.54.04.22.04.68v11.94q0%20.46-.04.7-.02.22-.18.5-.3.54-1.7.54-1.38%200-1.54-.98-.84.96-2.34.96-1.8%200-3.28-1.56-1.48-1.58-1.48-3.66%200-2.1%201.48-3.68%201.5-1.58%203.28-1.58%201.48%200%202.3%201v-4.2q0-.46.02-.68.04-.24.18-.52zm-3.24%2010.86q.52.54%201.26.54.74%200%201.22-.54.5-.54.5-1.18%200-.66-.48-1.22-.46-.56-1.26-.56-.8%200-1.28.56-.48.54-.48%201.2%200%20.66.52%201.2zm7.833-1.2q0-2.4%201.68-3.96%201.68-1.56%203.84-1.56%202.16%200%203.82%201.56%201.66%201.54%201.66%203.94%200%201.66-.86%202.96-.86%201.28-2.1%201.9-1.22.6-2.54.6-1.32%200-2.56-.64-1.24-.66-2.1-1.92-.84-1.28-.84-2.88zm4.18%201.44q.64.48%201.3.48.66%200%201.32-.5.66-.5.66-1.48%200-.98-.62-1.46-.62-.48-1.34-.48-.72%200-1.34.5-.62.5-.62%201.48%200%20.96.64%201.46zm11.412-1.44q0%20.84.56%201.32.56.46%201.18.46.64%200%201.18-.36.56-.38.9-.38.6%200%201.46%201.06.46.58.46%201.04%200%20.76-1.1%201.42-1.14.8-2.8.8-1.86%200-3.58-1.34-.82-.64-1.34-1.7-.52-1.08-.52-2.36%200-1.3.52-2.34.52-1.06%201.34-1.7%201.66-1.32%203.54-1.32.76%200%201.48.22.72.2%201.06.4l.32.2q.36.24.56.38.52.4.52.92%200%20.5-.42%201.14-.72%201.1-1.38%201.1-.38%200-1.08-.44-.36-.34-1.04-.34-.66%200-1.24.48-.58.48-.58%201.34z%22%20fill%3D%22green%22/%3E%3C/svg%3E"/>
11
11
  <!-- build env - Package Name = "spotifywebapiPython" -->
12
- <!-- build env - Package Version = "1.0.42" -->
12
+ <!-- build env - Package Version = "1.0.43" -->
13
13
  <!-- pdoc module.modulename = "spotifywebapipython.spotifydiscovery" -->
14
14
  <!-- pdoc module.is_package = "False" -->
15
15
  <!-- pdoc root_module_name = "None" -->
@@ -71,7 +71,7 @@
71
71
 
72
72
  <footer class="footertext">
73
73
  spotifywebapiPython</br>
74
- Version 1.0.42</br>
74
+ Version 1.0.43</br>
75
75
  <a href="https://developer.spotify.com/documentation/web-api" target="_blank">
76
76
  <img src="../spotifywebapipython.ico" alt="brand icon" style="width:32px; height:32px; padding:4px;"/>
77
77
  A Spotify Web Api Client