spotifywebapiPython 1.0.78__py3-none-any.whl → 1.0.80__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.
- {spotifywebapiPython-1.0.78.dist-info → spotifywebapiPython-1.0.80.dist-info}/METADATA +1 -1
- {spotifywebapiPython-1.0.78.dist-info → spotifywebapiPython-1.0.80.dist-info}/RECORD +25 -25
- spotifywebapipython/const.py +6 -1
- spotifywebapipython/docs/__init__.html +18 -3
- spotifywebapipython/docs/index.html +2 -2
- spotifywebapipython/docs/search.js +1 -1
- spotifywebapipython/docs/spotifywebapiPython/const.html +20 -3
- spotifywebapipython/docs/spotifywebapiPython/saappmessages.html +2 -2
- spotifywebapipython/docs/spotifywebapiPython/sautils.html +2 -2
- spotifywebapipython/docs/spotifywebapiPython/spotifyapierror.html +2 -2
- spotifywebapipython/docs/spotifywebapiPython/spotifyapimessage.html +2 -2
- spotifywebapipython/docs/spotifywebapiPython/spotifyauthtoken.html +38 -2
- spotifywebapipython/docs/spotifywebapiPython/spotifyclient.html +168 -72
- spotifywebapipython/docs/spotifywebapiPython/spotifydiscovery.html +2 -2
- spotifywebapipython/docs/spotifywebapiPython/spotifywebapiauthenticationerror.html +2 -2
- spotifywebapipython/docs/spotifywebapiPython/spotifywebapierror.html +2 -2
- spotifywebapipython/models/spotifyconnectdevice.py +60 -1
- spotifywebapipython/models/spotifyconnectdevices.py +2 -0
- spotifywebapipython/spotifyauthtoken.py +26 -0
- spotifywebapipython/spotifyclient.py +440 -195
- spotifywebapipython/zeroconfapi/zeroconfconnect.py +52 -46
- spotifywebapipython/zeroconfapi/zeroconfgetinfoalias.py +8 -0
- {spotifywebapiPython-1.0.78.dist-info → spotifywebapiPython-1.0.80.dist-info}/LICENSE +0 -0
- {spotifywebapiPython-1.0.78.dist-info → spotifywebapiPython-1.0.80.dist-info}/WHEEL +0 -0
- {spotifywebapiPython-1.0.78.dist-info → spotifywebapiPython-1.0.80.dist-info}/top_level.txt +0 -0
|
@@ -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.
|
|
12
|
+
<!-- build env - Package Version = "1.0.80" -->
|
|
13
13
|
<!-- pdoc module.modulename = "spotifywebapipython.spotifyclient" -->
|
|
14
14
|
<!-- pdoc module.is_package = "False" -->
|
|
15
15
|
<!-- pdoc root_module_name = "None" -->
|
|
@@ -276,6 +276,9 @@
|
|
|
276
276
|
<li>
|
|
277
277
|
<a class="function" href="#SpotifyClient.GetShows">GetShows</a>
|
|
278
278
|
</li>
|
|
279
|
+
<li>
|
|
280
|
+
<a class="function" href="#SpotifyClient.GetSpotifyConnectDevice">GetSpotifyConnectDevice</a>
|
|
281
|
+
</li>
|
|
279
282
|
<li>
|
|
280
283
|
<a class="function" href="#SpotifyClient.GetSpotifyConnectDevices">GetSpotifyConnectDevices</a>
|
|
281
284
|
</li>
|
|
@@ -452,7 +455,7 @@
|
|
|
452
455
|
|
|
453
456
|
<footer class="footertext">
|
|
454
457
|
spotifywebapiPython</br>
|
|
455
|
-
Version 1.0.
|
|
458
|
+
Version 1.0.80</br>
|
|
456
459
|
<a href="https://developer.spotify.com/documentation/web-api" target="_blank">
|
|
457
460
|
<img src="../spotifywebapipython.ico" alt="brand icon" style="width:32px; height:32px; padding:4px;"/>
|
|
458
461
|
A Spotify Web Api Client
|
|
@@ -533,7 +536,7 @@ Default is 2 seconds.</li>
|
|
|
533
536
|
<p>The <code>spotifyConnectUsername</code>, <code>spotifyConnectPassword</code> and <code>spotifyConnectLoginId</code> arguments are only used
|
|
534
537
|
when a Spotify Connect account switch is performed on a selected player device. Note that these credentials
|
|
535
538
|
are NOT used to access the Spotify Web API (the Spotify Web API token is used for that). <br />
|
|
536
|
-
Please see the <code><a href="#SpotifyClient.
|
|
539
|
+
Please see the <code><a href="#SpotifyClient.GetSpotifyConnectDevice">GetSpotifyConnectDevice</a></code> method for more details. </p>
|
|
537
540
|
|
|
538
541
|
<p>Note that if you don't have a password setup for your Spotify account (e.g. you utilize the "Continue with Google"
|
|
539
542
|
or other non-password methods for login), then you will need to define a "device password" in order to use the
|
|
@@ -7764,6 +7767,151 @@ and the response contains error information.</li>
|
|
|
7764
7767
|
</code></pre>
|
|
7765
7768
|
</div>
|
|
7766
7769
|
|
|
7770
|
+
<p></details></p>
|
|
7771
|
+
</div>
|
|
7772
|
+
|
|
7773
|
+
|
|
7774
|
+
</div>
|
|
7775
|
+
<div id="SpotifyClient.GetSpotifyConnectDevice" class="classattr">
|
|
7776
|
+
<div class="attr function">
|
|
7777
|
+
|
|
7778
|
+
<span class="def">def</span>
|
|
7779
|
+
<span class="name">GetSpotifyConnectDevice</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">deviceValue</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">verifyUserContext</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>,</span><span class="param"> <span class="n">verifyTimeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">5.0</span>,</span><span class="param"> <span class="n">refreshDeviceList</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>,</span><span class="param"> <span class="n">activateDevice</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>,</span><span class="param"> <span class="n">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.25</span></span><span class="return-annotation">) -> <span class="n"><a href="models/device.html#Device">spotifywebapipython.models.device.Device</a></span>:</span></span>
|
|
7780
|
+
|
|
7781
|
+
|
|
7782
|
+
</div>
|
|
7783
|
+
<a class="headerlink" href="#SpotifyClient.GetSpotifyConnectDevice"></a>
|
|
7784
|
+
|
|
7785
|
+
<div class="docstring"><p>Get information about a specific Spotify Connect player device, and (optionally)
|
|
7786
|
+
activate the device if it requires it.</p>
|
|
7787
|
+
|
|
7788
|
+
<p>This method requires the <code>user-read-playback-state</code> scope.</p>
|
|
7789
|
+
|
|
7790
|
+
<p>Resolves a Spotify Connect device from a specified device id, name, alias id,
|
|
7791
|
+
or alias name. This will ensure that the device can be found on the network, as well
|
|
7792
|
+
as connect to the device if necessary with the current user context. </p>
|
|
7793
|
+
|
|
7794
|
+
<h6 id="arguments">Arguments:</h6>
|
|
7795
|
+
|
|
7796
|
+
<ul>
|
|
7797
|
+
<li><strong>deviceValue (str):</strong> The device id / name value to check.</li>
|
|
7798
|
+
<li><strong>verifyUserContext (bool):</strong> If True, the active user context of the resolved device is checked to ensure it
|
|
7799
|
+
matches the user context specified on the class constructor.
|
|
7800
|
+
If False, the user context will not be checked.
|
|
7801
|
+
Default is True.</li>
|
|
7802
|
+
<li><strong>verifyTimeout (float):</strong> Maximum time to wait (in seconds) for the device to become active in the Spotify
|
|
7803
|
+
Connect device list. This value is only used if a Connect command has to be
|
|
7804
|
+
issued to activate the device.
|
|
7805
|
+
Default is 5; value range is 0 - 10.</li>
|
|
7806
|
+
<li><strong>refreshDeviceList (bool):</strong> True to refresh the Spotify Connect device list; otherwise, False to use the
|
|
7807
|
+
Spotify Connect device list cache.</li>
|
|
7808
|
+
<li><strong>activateDevice (bool):</strong> True to activate the device if necessary; otherwise, False.</li>
|
|
7809
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing any command to the device. <br />
|
|
7810
|
+
This delay will give the spotify zeroconf api time to process the change before
|
|
7811
|
+
another command is issued. <br />
|
|
7812
|
+
Default is 0.25; value range is 0 - 10.</li>
|
|
7813
|
+
</ul>
|
|
7814
|
+
|
|
7815
|
+
<h6 id="returns">Returns:</h6>
|
|
7816
|
+
|
|
7817
|
+
<blockquote>
|
|
7818
|
+
<p>A <code>Device</code> object for the deviceValue if one could be resolved;
|
|
7819
|
+
otherwise, a null value with the understanding that subsequent operations will probably
|
|
7820
|
+
fail since it's not in the Spotify Connect discovery list. </p>
|
|
7821
|
+
</blockquote>
|
|
7822
|
+
|
|
7823
|
+
<h6 id="raises">Raises:</h6>
|
|
7824
|
+
|
|
7825
|
+
<ul>
|
|
7826
|
+
<li><strong>SpotifyWebApiError:</strong> If the Spotify Web API request was for a non-authorization service
|
|
7827
|
+
and the response contains error information.</li>
|
|
7828
|
+
<li><strong>SpotifyZeroconfApiError:</strong> If any Spotify Zeroconf API request failed.</li>
|
|
7829
|
+
<li><strong>SpotifApiError:</strong> If the method fails for any other reason.</li>
|
|
7830
|
+
</ul>
|
|
7831
|
+
|
|
7832
|
+
<p>The Spotify Connect discovery list is searched for the specified device value; the search will
|
|
7833
|
+
match on either a Device ID or RemoteName as well as any alias ID's or Names that are in use.
|
|
7834
|
+
The cached Spotify Connect discovery list will be used if the <code>refreshDeviceList</code> argument is
|
|
7835
|
+
False, or if the cache is empty; otherwise, Spotify Connect discovery list will be refreshed
|
|
7836
|
+
and the cache updated prior to the search.</p>
|
|
7837
|
+
|
|
7838
|
+
<p>The <code>SpotifyConnectDevice</code> object is returned if a match is found; otherwise, a null value is
|
|
7839
|
+
returned.</p>
|
|
7840
|
+
|
|
7841
|
+
<p>A user context switch will also be performed if a device id is resolved AND the active user of the
|
|
7842
|
+
device does not match the <code>SpotifyConnectUsername</code> argument specified on the class constructor.
|
|
7843
|
+
The user context switch is bypassed if the <code>verifyUserContext</code> argument is False, or if the
|
|
7844
|
+
<code>SpotifyConnectUsername</code> was not supplied on the class constructor. If the user context is to be
|
|
7845
|
+
switched, then a Disconnect will be issued if a user context is active on the device followed by
|
|
7846
|
+
a Connect to the user context specified on the class constructor.</p>
|
|
7847
|
+
|
|
7848
|
+
<p><details>
|
|
7849
|
+
<summary>Sample Code</summary></p>
|
|
7850
|
+
|
|
7851
|
+
<div class="pdoc-code codehilite">
|
|
7852
|
+
<pre><span></span><code><span class="kn">from</span> <span class="nn">spotifywebapipython</span> <span class="kn">import</span> <span class="o">*</span>
|
|
7853
|
+
<span class="kn">from</span> <span class="nn">spotifywebapipython.models</span> <span class="kn">import</span> <span class="o">*</span>
|
|
7854
|
+
<span class="kn">from</span> <span class="nn">spotifywebapipython.zeroconfapi</span> <span class="kn">import</span> <span class="n">ZeroconfConnect</span><span class="p">,</span> <span class="n">ZeroconfResponse</span>
|
|
7855
|
+
|
|
7856
|
+
<span class="k">try</span><span class="p">:</span>
|
|
7857
|
+
|
|
7858
|
+
<span class="c1"># this sample requires an authorization token, as it accesses protected data.</span>
|
|
7859
|
+
|
|
7860
|
+
<span class="n">CLIENT_ID</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'your_client_id'</span>
|
|
7861
|
+
<span class="n">SPOTIFY_SCOPES</span><span class="p">:</span><span class="nb">list</span> <span class="o">=</span> \
|
|
7862
|
+
<span class="p">[</span>
|
|
7863
|
+
<span class="s1">'user-read-playback-state'</span><span class="p">,</span>
|
|
7864
|
+
<span class="s1">'user-read-email'</span><span class="p">,</span>
|
|
7865
|
+
<span class="p">]</span>
|
|
7866
|
+
|
|
7867
|
+
<span class="c1"># create new spotify client instance, passing the Spotify Connect user context and discovery timeout.</span>
|
|
7868
|
+
<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>
|
|
7869
|
+
<span class="n">spotifyConnectUsername</span><span class="o">=</span><span class="s2">"yourSpotifyUsername"</span><span class="p">,</span> <span class="c1"># (e.g. 'yourname@gmail.com', '1234567890', etc)</span>
|
|
7870
|
+
<span class="n">spotifyConnectPassword</span><span class="o">=</span><span class="s2">"yourSpotifyPassword"</span><span class="p">,</span>
|
|
7871
|
+
<span class="n">spotifyConnectLoginId</span><span class="o">=</span><span class="s2">"yourSpotifyLoginId"</span><span class="p">,</span> <span class="c1"># (e.g. '31l77548798704mns987fdf0986e')</span>
|
|
7872
|
+
<span class="n">spotifyConnectDiscoveryTimeout</span><span class="o">=</span><span class="mf">1.5</span><span class="p">,</span>
|
|
7873
|
+
<span class="n">tokenStorageDir</span><span class="o">=</span><span class="s1">'./yourTokenStorageDir'</span><span class="p">,</span>
|
|
7874
|
+
<span class="p">)</span>
|
|
7875
|
+
|
|
7876
|
+
<span class="c1"># generate a spotify authorization code with PKCE access token.</span>
|
|
7877
|
+
<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>
|
|
7878
|
+
|
|
7879
|
+
<span class="c1"># log user profile info.</span>
|
|
7880
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">User:</span><span class="se">\n</span><span class="s1"> DisplayName="</span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1"> EMail="</span><span class="si">%s</span><span class="s1">"'</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>
|
|
7881
|
+
|
|
7882
|
+
<span class="n">device</span><span class="p">:</span><span class="n">SpotifyConnectDevice</span> <span class="o">=</span> <span class="kc">None</span>
|
|
7883
|
+
|
|
7884
|
+
<span class="c1"># resolve Spotify Connect player device by it's Id value.</span>
|
|
7885
|
+
<span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'30fbc80e35598f3c242f2120413c943dfd9715fe'</span>
|
|
7886
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Resolving Spotify Connect player 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="o">%</span> <span class="n">deviceId</span><span class="p">)</span>
|
|
7887
|
+
<span class="n">device</span> <span class="o">=</span> <span class="n">spotify</span><span class="o">.</span><span class="n">GetSpotifyConnectDevice</span><span class="p">(</span><span class="n">deviceId</span><span class="p">)</span>
|
|
7888
|
+
<span class="k">if</span> <span class="n">device</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
7889
|
+
<span class="nb">print</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">device</span><span class="p">))</span>
|
|
7890
|
+
|
|
7891
|
+
<span class="c1"># resolve Spotify Connect player device by it's Name value.</span>
|
|
7892
|
+
<span class="n">deviceName</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'Bose-ST10-2'</span>
|
|
7893
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Resolving Spotify Connect player device: </span><span class="se">\n</span><span class="s1">- Name = "</span><span class="si">%s</span><span class="s1">" ...</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">deviceName</span><span class="p">)</span>
|
|
7894
|
+
<span class="n">device</span> <span class="o">=</span> <span class="n">spotify</span><span class="o">.</span><span class="n">GetSpotifyConnectDevice</span><span class="p">(</span><span class="n">deviceName</span><span class="p">)</span>
|
|
7895
|
+
<span class="k">if</span> <span class="n">device</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
7896
|
+
<span class="nb">print</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">device</span><span class="p">))</span>
|
|
7897
|
+
|
|
7898
|
+
<span class="c1"># resolve Spotify Connect player device by it's Name value, using a Disconnected device.</span>
|
|
7899
|
+
<span class="n">deviceName</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'Bose-ST10-2'</span>
|
|
7900
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Forcing disconnect of Spotify Connect device: </span><span class="se">\n</span><span class="s1">- Name = "</span><span class="si">%s</span><span class="s1">" ...</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">deviceName</span><span class="p">)</span>
|
|
7901
|
+
<span class="n">zconn</span><span class="p">:</span><span class="n">ZeroconfConnect</span> <span class="o">=</span> <span class="n">ZeroconfConnect</span><span class="p">(</span><span class="s1">'192.168.1.82'</span><span class="p">,</span> <span class="mi">8200</span><span class="p">,</span> <span class="s1">'/zc'</span><span class="p">,</span> <span class="n">useSSL</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">tokenStorageDir</span><span class="o">=</span><span class="n">spotify</span><span class="o">.</span><span class="n">TokenStorageDir</span><span class="p">)</span>
|
|
7902
|
+
<span class="n">result</span><span class="p">:</span><span class="n">ZeroconfResponse</span> <span class="o">=</span> <span class="n">zconn</span><span class="o">.</span><span class="n">Disconnect</span><span class="p">()</span>
|
|
7903
|
+
|
|
7904
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Resolving Spotify Connect player disconnected device: </span><span class="se">\n</span><span class="s1">- Name = "</span><span class="si">%s</span><span class="s1">" ...</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">deviceName</span><span class="p">)</span>
|
|
7905
|
+
<span class="n">device</span> <span class="o">=</span> <span class="n">spotify</span><span class="o">.</span><span class="n">GetSpotifyConnectDevice</span><span class="p">(</span><span class="n">deviceName</span><span class="p">)</span>
|
|
7906
|
+
<span class="k">if</span> <span class="n">device</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
7907
|
+
<span class="nb">print</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">device</span><span class="p">))</span>
|
|
7908
|
+
|
|
7909
|
+
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
|
|
7910
|
+
|
|
7911
|
+
<span class="nb">print</span><span class="p">(</span><span class="s2">"** Exception: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
|
|
7912
|
+
</code></pre>
|
|
7913
|
+
</div>
|
|
7914
|
+
|
|
7767
7915
|
<p></details></p>
|
|
7768
7916
|
</div>
|
|
7769
7917
|
|
|
@@ -7773,7 +7921,7 @@ and the response contains error information.</li>
|
|
|
7773
7921
|
<div class="attr function">
|
|
7774
7922
|
|
|
7775
7923
|
<span class="def">def</span>
|
|
7776
|
-
<span class="name">GetSpotifyConnectDevices</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">True</span></span><span class="return-annotation">) -> <span class="n">spotifywebapipython</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">spotifyconnectdevices</span><span class="o">.</span><span class="n">SpotifyConnectDevices</span>:</span></span>
|
|
7924
|
+
<span class="name">GetSpotifyConnectDevices</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">True</span>,</span><span class="param"> <span class="n">sortResult</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span></span><span class="return-annotation">) -> <span class="n">spotifywebapipython</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">spotifyconnectdevices</span><span class="o">.</span><span class="n">SpotifyConnectDevices</span>:</span></span>
|
|
7777
7925
|
|
|
7778
7926
|
|
|
7779
7927
|
</div>
|
|
@@ -7788,6 +7936,9 @@ and the response contains error information.</li>
|
|
|
7788
7936
|
<ul>
|
|
7789
7937
|
<li><strong>refresh (bool):</strong> True (default) to return real-time information from the spotify zeroconf api and
|
|
7790
7938
|
update the cache; otherwise, False to just return the cached value.</li>
|
|
7939
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
7940
|
+
were returned in by the Spotify Web API. <br />
|
|
7941
|
+
Default: True</li>
|
|
7791
7942
|
</ul>
|
|
7792
7943
|
|
|
7793
7944
|
<h6 id="returns">Returns:</h6>
|
|
@@ -9299,7 +9450,8 @@ This delay will give the spotify web api time to process the change before
|
|
|
9299
9450
|
another command is issued. <br />
|
|
9300
9451
|
Default is 0.50; value range is 0 - 10.</li>
|
|
9301
9452
|
<li><strong>resolveDeviceId (bool):</strong> True to resolve the supplied <code>deviceId</code> value; otherwise, False not resolve the <code>deviceId</code>
|
|
9302
|
-
value as it has already been resolved
|
|
9453
|
+
value as it has already been resolved. <br />
|
|
9454
|
+
Default is True. </li>
|
|
9303
9455
|
</ul>
|
|
9304
9456
|
|
|
9305
9457
|
<h6 id="raises">Raises:</h6>
|
|
@@ -9533,7 +9685,8 @@ This delay will give the spotify web api time to process the change before
|
|
|
9533
9685
|
another command is issued. <br />
|
|
9534
9686
|
Default is 0.50; value range is 0 - 10.</li>
|
|
9535
9687
|
<li><strong>resolveDeviceId (bool):</strong> True to resolve the supplied <code>deviceId</code> value; otherwise, False not resolve the <code>deviceId</code>
|
|
9536
|
-
value as it has already been resolved
|
|
9688
|
+
value as it has already been resolved. <br />
|
|
9689
|
+
Default is True. </li>
|
|
9537
9690
|
<li><strong>limitTotal (int):</strong> The maximum number of items to retrieve from favorites. <br />
|
|
9538
9691
|
Default: 200</li>
|
|
9539
9692
|
</ul>
|
|
@@ -9633,7 +9786,8 @@ This delay will give the spotify web api time to process the change before
|
|
|
9633
9786
|
another command is issued. <br />
|
|
9634
9787
|
Default is 0.50; value range is 0 - 10.</li>
|
|
9635
9788
|
<li><strong>resolveDeviceId (bool):</strong> True to resolve the supplied <code>deviceId</code> value; otherwise, False not resolve the <code>deviceId</code>
|
|
9636
|
-
value as it has already been resolved
|
|
9789
|
+
value as it has already been resolved. <br />
|
|
9790
|
+
Default is True. </li>
|
|
9637
9791
|
</ul>
|
|
9638
9792
|
|
|
9639
9793
|
<h6 id="raises">Raises:</h6>
|
|
@@ -10068,7 +10222,10 @@ and the response contains error information.</li>
|
|
|
10068
10222
|
</div>
|
|
10069
10223
|
<a class="headerlink" href="#SpotifyClient.PlayerResolveDeviceId"></a>
|
|
10070
10224
|
|
|
10071
|
-
<div class="docstring"><p>
|
|
10225
|
+
<div class="docstring"><p>This method has been deprecated. <br />
|
|
10226
|
+
Use the <code><a href="#SpotifyClient.GetSpotifyConnectDevice">GetSpotifyConnectDevice</a></code> method instead.</p>
|
|
10227
|
+
|
|
10228
|
+
<p>Resolves a Spotify Connect device identifier from a specified device id, name, alias id,
|
|
10072
10229
|
or alias name. This will ensure that the device id can be found on the network, as well
|
|
10073
10230
|
as connect to the device if necessary with the current user context. </p>
|
|
10074
10231
|
|
|
@@ -10123,67 +10280,6 @@ The user context switch is bypassed if the <code>verifyUserContext</code> argume
|
|
|
10123
10280
|
<code>SpotifyConnectUsername</code> was not supplied on the class constructor. If the user context is to be
|
|
10124
10281
|
switched, then a Disconnect will be issued if a user context is active on the device followed by
|
|
10125
10282
|
a Connect to the user context specified on the class constructor.</p>
|
|
10126
|
-
|
|
10127
|
-
<p><details>
|
|
10128
|
-
<summary>Sample Code</summary></p>
|
|
10129
|
-
|
|
10130
|
-
<div class="pdoc-code codehilite">
|
|
10131
|
-
<pre><span></span><code><span class="kn">from</span> <span class="nn">spotifywebapipython</span> <span class="kn">import</span> <span class="o">*</span>
|
|
10132
|
-
<span class="kn">from</span> <span class="nn">spotifywebapipython.models</span> <span class="kn">import</span> <span class="o">*</span>
|
|
10133
|
-
<span class="kn">from</span> <span class="nn">spotifywebapipython.zeroconfapi</span> <span class="kn">import</span> <span class="n">ZeroconfConnect</span><span class="p">,</span> <span class="n">ZeroconfResponse</span>
|
|
10134
|
-
|
|
10135
|
-
<span class="k">try</span><span class="p">:</span>
|
|
10136
|
-
|
|
10137
|
-
<span class="c1"># this sample requires an authorization token, as it requires security scope to accesses user data.</span>
|
|
10138
|
-
|
|
10139
|
-
<span class="n">CLIENT_ID</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'your_client_id'</span>
|
|
10140
|
-
<span class="n">SPOTIFY_SCOPES</span><span class="p">:</span><span class="nb">list</span> <span class="o">=</span> \
|
|
10141
|
-
<span class="p">[</span>
|
|
10142
|
-
<span class="s1">'user-read-playback-state'</span><span class="p">,</span>
|
|
10143
|
-
<span class="s1">'user-read-email'</span><span class="p">,</span>
|
|
10144
|
-
<span class="p">]</span>
|
|
10145
|
-
|
|
10146
|
-
<span class="c1"># create new spotify client instance, passing the Spotify Connect user context and discovery timeout.</span>
|
|
10147
|
-
<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>
|
|
10148
|
-
<span class="n">spotifyConnectUsername</span><span class="o">=</span><span class="s2">"yourSpotifyUsername"</span><span class="p">,</span> <span class="c1"># (e.g. 'yourname@gmail.com', '1234567890', etc)</span>
|
|
10149
|
-
<span class="n">spotifyConnectPassword</span><span class="o">=</span><span class="s2">"yourSpotifyPassword"</span><span class="p">,</span>
|
|
10150
|
-
<span class="n">spotifyConnectLoginId</span><span class="o">=</span><span class="s2">"yourSpotifyLoginId"</span><span class="p">,</span> <span class="c1"># (e.g. '31l77548798704mns987fdf0986e')</span>
|
|
10151
|
-
<span class="n">spotifyConnectDiscoveryTimeout</span><span class="o">=</span><span class="mf">1.5</span><span class="p">,</span>
|
|
10152
|
-
<span class="n">tokenStorageDir</span><span class="o">=</span><span class="s1">'./yourTokenStorageDir'</span><span class="p">,</span>
|
|
10153
|
-
<span class="p">)</span>
|
|
10154
|
-
|
|
10155
|
-
<span class="c1"># generate a spotify authorization code with PKCE access token (with scope, private and public data use).</span>
|
|
10156
|
-
<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>
|
|
10157
|
-
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Auth Token:</span><span class="se">\n</span><span class="s1"> Type="</span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1"> Scope="</span><span class="si">%s</span><span class="s1">"'</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>
|
|
10158
|
-
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">User:</span><span class="se">\n</span><span class="s1"> DisplayName="</span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1"> EMail="</span><span class="si">%s</span><span class="s1">"'</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>
|
|
10159
|
-
|
|
10160
|
-
<span class="c1"># resolve Spotify Connect player device by it's Id value.</span>
|
|
10161
|
-
<span class="n">deviceId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'30fbc80e35598f3c242f2120413c943dfd9715fe'</span>
|
|
10162
|
-
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Resolving Spotify Connect player device: </span><span class="se">\n</span><span class="s1">- ID = "</span><span class="si">%s</span><span class="s1">" ...'</span> <span class="o">%</span> <span class="n">deviceId</span><span class="p">)</span>
|
|
10163
|
-
<span class="n">deviceResult</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">PlayerResolveDeviceId</span><span class="p">(</span><span class="n">deviceId</span><span class="p">)</span>
|
|
10164
|
-
<span class="nb">print</span><span class="p">(</span><span class="s1">'result "</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="n">deviceResult</span><span class="p">)</span>
|
|
10165
|
-
|
|
10166
|
-
<span class="c1"># resolve Spotify Connect player device by it's Name value.</span>
|
|
10167
|
-
<span class="n">deviceName</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'Bose-ST10-2'</span>
|
|
10168
|
-
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Resolving Spotify Connect player device: </span><span class="se">\n</span><span class="s1">- Name = "</span><span class="si">%s</span><span class="s1">" ...'</span> <span class="o">%</span> <span class="n">deviceName</span><span class="p">)</span>
|
|
10169
|
-
<span class="n">deviceResult</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">PlayerResolveDeviceId</span><span class="p">(</span><span class="n">deviceName</span><span class="p">)</span>
|
|
10170
|
-
<span class="nb">print</span><span class="p">(</span><span class="s1">' result "</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="n">deviceResult</span><span class="p">)</span>
|
|
10171
|
-
|
|
10172
|
-
<span class="c1"># resolve Spotify Connect player device by it's Name value, using a Disconnected device.</span>
|
|
10173
|
-
<span class="n">zconn</span><span class="p">:</span><span class="n">ZeroconfConnect</span> <span class="o">=</span> <span class="n">ZeroconfConnect</span><span class="p">(</span><span class="s1">'192.168.1.82'</span><span class="p">,</span> <span class="mi">8200</span><span class="p">,</span> <span class="s1">'/zc'</span><span class="p">,</span> <span class="n">useSSL</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">tokenStorageDir</span><span class="o">=</span><span class="n">spotify</span><span class="o">.</span><span class="n">TokenStorageDir</span><span class="p">)</span>
|
|
10174
|
-
<span class="n">result</span><span class="p">:</span><span class="n">ZeroconfResponse</span> <span class="o">=</span> <span class="n">zconn</span><span class="o">.</span><span class="n">Disconnect</span><span class="p">()</span>
|
|
10175
|
-
<span class="n">deviceName</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'Bose-ST10-2'</span>
|
|
10176
|
-
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Resolving Spotify Connect player disconnected device: </span><span class="se">\n</span><span class="s1">- Name = "</span><span class="si">%s</span><span class="s1">" ...'</span> <span class="o">%</span> <span class="n">deviceName</span><span class="p">)</span>
|
|
10177
|
-
<span class="n">deviceResult</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">PlayerResolveDeviceId</span><span class="p">(</span><span class="n">deviceName</span><span class="p">)</span>
|
|
10178
|
-
<span class="nb">print</span><span class="p">(</span><span class="s1">' result "</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="n">deviceResult</span><span class="p">)</span>
|
|
10179
|
-
|
|
10180
|
-
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
|
|
10181
|
-
|
|
10182
|
-
<span class="nb">print</span><span class="p">(</span><span class="s2">"** Exception: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
|
|
10183
|
-
</code></pre>
|
|
10184
|
-
</div>
|
|
10185
|
-
|
|
10186
|
-
<p></details></p>
|
|
10187
10283
|
</div>
|
|
10188
10284
|
|
|
10189
10285
|
|
|
@@ -10480,7 +10576,7 @@ and the response contains error information.</li>
|
|
|
10480
10576
|
<div class="attr function">
|
|
10481
10577
|
|
|
10482
10578
|
<span class="def">def</span>
|
|
10483
|
-
<span class="name">PlayerTransferPlayback</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">deviceId</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">play</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>,</span><span class="param"> <span class="n">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span>,</span><span class="param"> <span class="n">
|
|
10579
|
+
<span class="name">PlayerTransferPlayback</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">deviceId</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">play</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>,</span><span class="param"> <span class="n">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span>,</span><span class="param"> <span class="n">refreshDeviceList</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="kc">None</span>:</span></span>
|
|
10484
10580
|
|
|
10485
10581
|
|
|
10486
10582
|
</div>
|
|
@@ -10506,8 +10602,8 @@ Default: <code>True</code> </li>
|
|
|
10506
10602
|
This delay will give the spotify web api time to process the change before
|
|
10507
10603
|
another command is issued. <br />
|
|
10508
10604
|
Default is 0.50; value range is 0 - 10.</li>
|
|
10509
|
-
<li><strong>
|
|
10510
|
-
|
|
10605
|
+
<li><strong>refreshDeviceList (bool):</strong> True to refresh the Spotify Connect device list; otherwise, False to use the
|
|
10606
|
+
Spotify Connect device list cache.</li>
|
|
10511
10607
|
</ul>
|
|
10512
10608
|
|
|
10513
10609
|
<h6 id="raises">Raises:</h6>
|
|
@@ -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.
|
|
12
|
+
<!-- build env - Package Version = "1.0.80" -->
|
|
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.
|
|
74
|
+
Version 1.0.80</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
|
|
@@ -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.
|
|
12
|
+
<!-- build env - Package Version = "1.0.80" -->
|
|
13
13
|
<!-- pdoc module.modulename = "spotifywebapipython.spotifywebapiauthenticationerror" -->
|
|
14
14
|
<!-- pdoc module.is_package = "False" -->
|
|
15
15
|
<!-- pdoc root_module_name = "None" -->
|
|
@@ -74,7 +74,7 @@
|
|
|
74
74
|
|
|
75
75
|
<footer class="footertext">
|
|
76
76
|
spotifywebapiPython</br>
|
|
77
|
-
Version 1.0.
|
|
77
|
+
Version 1.0.80</br>
|
|
78
78
|
<a href="https://developer.spotify.com/documentation/web-api" target="_blank">
|
|
79
79
|
<img src="../spotifywebapipython.ico" alt="brand icon" style="width:32px; height:32px; padding:4px;"/>
|
|
80
80
|
A Spotify Web Api Client
|
|
@@ -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.
|
|
12
|
+
<!-- build env - Package Version = "1.0.80" -->
|
|
13
13
|
<!-- pdoc module.modulename = "spotifywebapipython.spotifywebapierror" -->
|
|
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.
|
|
74
|
+
Version 1.0.80</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
|
|
@@ -21,6 +21,9 @@ class SpotifyConnectDevice():
|
|
|
21
21
|
"""
|
|
22
22
|
self._DiscoveryResult:ZeroconfDiscoveryResult = None
|
|
23
23
|
self._DeviceInfo:ZeroconfGetInfo = None
|
|
24
|
+
self._Id:str = None
|
|
25
|
+
self._Name:str = None
|
|
26
|
+
self._WasReConnected:bool = False
|
|
24
27
|
|
|
25
28
|
|
|
26
29
|
def __repr__(self) -> str:
|
|
@@ -63,12 +66,68 @@ class SpotifyConnectDevice():
|
|
|
63
66
|
self._DeviceInfo = value
|
|
64
67
|
|
|
65
68
|
|
|
69
|
+
@property
|
|
70
|
+
def Id(self) -> str:
|
|
71
|
+
"""
|
|
72
|
+
Spotify Connect device id value (e.g. "30fbc80e35598f3c242f2120413c943dfd9715fe").
|
|
73
|
+
"""
|
|
74
|
+
return self._Id
|
|
75
|
+
|
|
76
|
+
@Id.setter
|
|
77
|
+
def Id(self, value:str):
|
|
78
|
+
"""
|
|
79
|
+
Sets the Id property value.
|
|
80
|
+
"""
|
|
81
|
+
self._Id = value
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
@property
|
|
85
|
+
def Name(self) -> str:
|
|
86
|
+
"""
|
|
87
|
+
Spotify Connect device name value (e.g. "Bose-ST10-1").
|
|
88
|
+
"""
|
|
89
|
+
return self._Name
|
|
90
|
+
|
|
91
|
+
@Name.setter
|
|
92
|
+
def Name(self, value:str):
|
|
93
|
+
"""
|
|
94
|
+
Sets the Name property value.
|
|
95
|
+
"""
|
|
96
|
+
self._Name = value
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
@property
|
|
100
|
+
def Title(self) -> str:
|
|
101
|
+
"""
|
|
102
|
+
Spotify Connect device name and id value (e.g. '"Bose-ST10-1" (30fbc80e35598f3c242f2120413c943dfd9715fe)').
|
|
103
|
+
"""
|
|
104
|
+
return '%s (%s)' % (self._Name, self._Id)
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
@property
|
|
108
|
+
def WasReConnected(self) -> bool:
|
|
109
|
+
"""
|
|
110
|
+
True if the device was re-connected, after being inactive or disconnected.
|
|
111
|
+
"""
|
|
112
|
+
return self._WasReConnected
|
|
113
|
+
|
|
114
|
+
@WasReConnected.setter
|
|
115
|
+
def WasReConnected(self, value:bool):
|
|
116
|
+
"""
|
|
117
|
+
Sets the WasReConnected property value.
|
|
118
|
+
"""
|
|
119
|
+
self._WasReConnected = value
|
|
120
|
+
|
|
121
|
+
|
|
66
122
|
def ToDictionary(self) -> dict:
|
|
67
123
|
"""
|
|
68
124
|
Returns a dictionary representation of the class.
|
|
69
125
|
"""
|
|
70
126
|
result:dict = \
|
|
71
127
|
{
|
|
128
|
+
'Id': self._Id,
|
|
129
|
+
'Name': self._Name,
|
|
130
|
+
'WasReConnected': self._WasReConnected,
|
|
72
131
|
'DeviceInfo': self._DeviceInfo.ToDictionary(),
|
|
73
132
|
'DiscoveryResult': self._DiscoveryResult.ToDictionary(),
|
|
74
133
|
}
|
|
@@ -85,7 +144,7 @@ class SpotifyConnectDevice():
|
|
|
85
144
|
"""
|
|
86
145
|
msg:str = ''
|
|
87
146
|
if includeTitle:
|
|
88
|
-
msg = 'Device: "%s" (%s)' % (self.
|
|
147
|
+
msg = 'Device: "%s" (%s)' % (self._Name, self._Id)
|
|
89
148
|
|
|
90
149
|
# build result.
|
|
91
150
|
msg = '%s\n %s\n' % (msg, str(self._DeviceInfo.ToString(True)))
|
|
@@ -119,6 +119,8 @@ class SpotifyConnectDevices():
|
|
|
119
119
|
|
|
120
120
|
# add the device.
|
|
121
121
|
scDevice:SpotifyConnectDevice = SpotifyConnectDevice()
|
|
122
|
+
scDevice.Id = info.DeviceId
|
|
123
|
+
scDevice.Name = info.RemoteName
|
|
122
124
|
scDevice.DeviceInfo = info
|
|
123
125
|
scDevice.DiscoveryResult = discoverResult
|
|
124
126
|
self._Items.append(scDevice)
|