spotifywebapiPython 1.0.39__py3-none-any.whl → 1.0.41__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.39.dist-info → spotifywebapiPython-1.0.41.dist-info}/METADATA +1 -1
- {spotifywebapiPython-1.0.39.dist-info → spotifywebapiPython-1.0.41.dist-info}/RECORD +24 -22
- spotifywebapipython/const.py +6 -1
- spotifywebapipython/docs/__init__.html +19 -2
- 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 +2 -2
- spotifywebapipython/docs/spotifywebapiPython/spotifyclient.html +319 -17
- spotifywebapipython/docs/spotifywebapiPython/spotifydiscovery.html +2 -2
- spotifywebapipython/docs/spotifywebapiPython/spotifywebapiauthenticationerror.html +2 -2
- spotifywebapipython/docs/spotifywebapiPython/spotifywebapierror.html +2 -2
- spotifywebapipython/models/__init__.py +2 -0
- spotifywebapipython/models/artistinfo.py +263 -0
- spotifywebapipython/models/artistinfotourevent.py +107 -0
- spotifywebapipython/sautils.py +29 -0
- spotifywebapipython/spotifyclient.py +644 -26
- {spotifywebapiPython-1.0.39.dist-info → spotifywebapiPython-1.0.41.dist-info}/LICENSE +0 -0
- {spotifywebapiPython-1.0.39.dist-info → spotifywebapiPython-1.0.41.dist-info}/WHEEL +0 -0
- {spotifywebapiPython-1.0.39.dist-info → spotifywebapiPython-1.0.41.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.41" -->
|
|
13
13
|
<!-- pdoc module.modulename = "spotifywebapipython.spotifyclient" -->
|
|
14
14
|
<!-- pdoc module.is_package = "False" -->
|
|
15
15
|
<!-- pdoc root_module_name = "None" -->
|
|
@@ -156,6 +156,9 @@
|
|
|
156
156
|
<li>
|
|
157
157
|
<a class="function" href="#SpotifyClient.GetArtistAlbums">GetArtistAlbums</a>
|
|
158
158
|
</li>
|
|
159
|
+
<li>
|
|
160
|
+
<a class="function" href="#SpotifyClient.GetArtistInfo">GetArtistInfo</a>
|
|
161
|
+
</li>
|
|
159
162
|
<li>
|
|
160
163
|
<a class="function" href="#SpotifyClient.GetArtistRelatedArtists">GetArtistRelatedArtists</a>
|
|
161
164
|
</li>
|
|
@@ -303,6 +306,9 @@
|
|
|
303
306
|
<li>
|
|
304
307
|
<a class="function" href="#SpotifyClient.PlayerMediaPlayContext">PlayerMediaPlayContext</a>
|
|
305
308
|
</li>
|
|
309
|
+
<li>
|
|
310
|
+
<a class="function" href="#SpotifyClient.PlayerMediaPlayTrackFavorites">PlayerMediaPlayTrackFavorites</a>
|
|
311
|
+
</li>
|
|
306
312
|
<li>
|
|
307
313
|
<a class="function" href="#SpotifyClient.PlayerMediaPlayTracks">PlayerMediaPlayTracks</a>
|
|
308
314
|
</li>
|
|
@@ -342,6 +348,9 @@
|
|
|
342
348
|
<li>
|
|
343
349
|
<a class="function" href="#SpotifyClient.RemoveEpisodeFavorites">RemoveEpisodeFavorites</a>
|
|
344
350
|
</li>
|
|
351
|
+
<li>
|
|
352
|
+
<a class="function" href="#SpotifyClient.RemovePlaylist">RemovePlaylist</a>
|
|
353
|
+
</li>
|
|
345
354
|
<li>
|
|
346
355
|
<a class="function" href="#SpotifyClient.RemovePlaylistItems">RemovePlaylistItems</a>
|
|
347
356
|
</li>
|
|
@@ -425,7 +434,7 @@
|
|
|
425
434
|
|
|
426
435
|
<footer class="footertext">
|
|
427
436
|
spotifywebapiPython</br>
|
|
428
|
-
Version 1.0.
|
|
437
|
+
Version 1.0.41</br>
|
|
429
438
|
<a href="https://developer.spotify.com/documentation/web-api" target="_blank">
|
|
430
439
|
<img src="../spotifywebapipython.ico" alt="brand icon" style="width:32px; height:32px; padding:4px;"/>
|
|
431
440
|
A Spotify Web Api Client
|
|
@@ -3081,6 +3090,77 @@ and the response contains error information.</li>
|
|
|
3081
3090
|
</code></pre>
|
|
3082
3091
|
</div>
|
|
3083
3092
|
|
|
3093
|
+
<p></details></p>
|
|
3094
|
+
</div>
|
|
3095
|
+
|
|
3096
|
+
|
|
3097
|
+
</div>
|
|
3098
|
+
<div id="SpotifyClient.GetArtistInfo" class="classattr">
|
|
3099
|
+
<div class="attr function">
|
|
3100
|
+
|
|
3101
|
+
<span class="def">def</span>
|
|
3102
|
+
<span class="name">GetArtistInfo</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">artistId</span><span class="p">:</span> <span class="nb">str</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">artistinfo</span><span class="o">.</span><span class="n">ArtistInfo</span>:</span></span>
|
|
3103
|
+
|
|
3104
|
+
|
|
3105
|
+
</div>
|
|
3106
|
+
<a class="headerlink" href="#SpotifyClient.GetArtistInfo"></a>
|
|
3107
|
+
|
|
3108
|
+
<div class="docstring"><p>Get artist about information from the Spotify Artist Biography page for the
|
|
3109
|
+
specified Spotify artist ID.</p>
|
|
3110
|
+
|
|
3111
|
+
<h6 id="arguments">Arguments:</h6>
|
|
3112
|
+
|
|
3113
|
+
<ul>
|
|
3114
|
+
<li><strong>artistId (str):</strong> The Spotify ID of the artist. <br />
|
|
3115
|
+
Example: <code>6APm8EjxOHSYM5B4i3vT3q</code></li>
|
|
3116
|
+
</ul>
|
|
3117
|
+
|
|
3118
|
+
<h6 id="returns">Returns:</h6>
|
|
3119
|
+
|
|
3120
|
+
<blockquote>
|
|
3121
|
+
<p>An <code>ArtistInfo</code> object that contains the artist info details.</p>
|
|
3122
|
+
</blockquote>
|
|
3123
|
+
|
|
3124
|
+
<h6 id="raises">Raises:</h6>
|
|
3125
|
+
|
|
3126
|
+
<ul>
|
|
3127
|
+
<li><strong>SpotifyWebApiError:</strong> If the Spotify Web API request was for a non-authorization service
|
|
3128
|
+
and the response contains error information.</li>
|
|
3129
|
+
<li><strong>SpotifApiError:</strong> If the method fails for any other reason.</li>
|
|
3130
|
+
</ul>
|
|
3131
|
+
|
|
3132
|
+
<p><details>
|
|
3133
|
+
<summary>Sample Code</summary></p>
|
|
3134
|
+
|
|
3135
|
+
<div class="pdoc-code codehilite">
|
|
3136
|
+
<pre><span></span><code><span class="kn">from</span> <span class="nn">spotifywebapipython</span> <span class="kn">import</span> <span class="o">*</span>
|
|
3137
|
+
<span class="kn">from</span> <span class="nn">spotifywebapipython.models</span> <span class="kn">import</span> <span class="o">*</span>
|
|
3138
|
+
|
|
3139
|
+
<span class="k">try</span><span class="p">:</span>
|
|
3140
|
+
|
|
3141
|
+
<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>
|
|
3142
|
+
<span class="n">CLIENT_SECRET</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'your_client_secret'</span>
|
|
3143
|
+
|
|
3144
|
+
<span class="c1"># create new spotify client instance.</span>
|
|
3145
|
+
<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>
|
|
3146
|
+
|
|
3147
|
+
<span class="c1"># generate a spotify client credentials access token (no scope, public data use only).</span>
|
|
3148
|
+
<span class="n">spotify</span><span class="o">.</span><span class="n">SetAuthTokenClientCredentials</span><span class="p">(</span><span class="n">CLIENT_ID</span><span class="p">,</span> <span class="n">CLIENT_SECRET</span><span class="p">)</span>
|
|
3149
|
+
<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>
|
|
3150
|
+
<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>
|
|
3151
|
+
|
|
3152
|
+
<span class="c1"># get Spotify artist biography page information.</span>
|
|
3153
|
+
<span class="n">artistId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'6APm8EjxOHSYM5B4i3vT3q'</span> <span class="c1"># MercyMe</span>
|
|
3154
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Getting details for Artist "</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">artistId</span><span class="p">)</span>
|
|
3155
|
+
<span class="n">artistInfo</span><span class="p">:</span><span class="n">ArtistInfo</span> <span class="o">=</span> <span class="n">spotify</span><span class="o">.</span><span class="n">GetArtistInfo</span><span class="p">(</span><span class="n">artistId</span><span class="p">)</span>
|
|
3156
|
+
<span class="nb">print</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">artistInfo</span><span class="p">))</span>
|
|
3157
|
+
|
|
3158
|
+
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
|
|
3159
|
+
|
|
3160
|
+
<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>
|
|
3161
|
+
</code></pre>
|
|
3162
|
+
</div>
|
|
3163
|
+
|
|
3084
3164
|
<p></details></p>
|
|
3085
3165
|
</div>
|
|
3086
3166
|
|
|
@@ -5732,7 +5812,8 @@ properly handles cases of new types in the future by checking against the type f
|
|
|
5732
5812
|
<h6 id="returns">Returns:</h6>
|
|
5733
5813
|
|
|
5734
5814
|
<blockquote>
|
|
5735
|
-
<p>A <code>PlayerPlayState</code> object that contains
|
|
5815
|
+
<p>A <code>PlayerPlayState</code> object that contains player state details as well as
|
|
5816
|
+
currently playing content.</p>
|
|
5736
5817
|
</blockquote>
|
|
5737
5818
|
|
|
5738
5819
|
<h6 id="raises">Raises:</h6>
|
|
@@ -5830,7 +5911,8 @@ properly handles cases of new types in the future by checking against the type f
|
|
|
5830
5911
|
<h6 id="returns">Returns:</h6>
|
|
5831
5912
|
|
|
5832
5913
|
<blockquote>
|
|
5833
|
-
<p>A <code>PlayerPlayState</code> object that contains
|
|
5914
|
+
<p>A <code>PlayerPlayState</code> object that contains player state details as well as
|
|
5915
|
+
currently playing content.</p>
|
|
5834
5916
|
</blockquote>
|
|
5835
5917
|
|
|
5836
5918
|
<h6 id="raises">Raises:</h6>
|
|
@@ -8604,7 +8686,7 @@ and the response contains error information.</li>
|
|
|
8604
8686
|
<div class="attr function">
|
|
8605
8687
|
|
|
8606
8688
|
<span class="def">def</span>
|
|
8607
|
-
<span class="name">PlayerMediaPause</span><span class="signature pdoc-code condensed">(<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="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
8689
|
+
<span class="name">PlayerMediaPause</span><span class="signature pdoc-code condensed">(<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">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
8608
8690
|
|
|
8609
8691
|
|
|
8610
8692
|
</div>
|
|
@@ -8620,6 +8702,10 @@ and the response contains error information.</li>
|
|
|
8620
8702
|
<li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
|
|
8621
8703
|
If not supplied, the user's currently active device is the target. <br />
|
|
8622
8704
|
Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
|
|
8705
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
|
|
8706
|
+
This delay will give the spotify web api time to process the change before
|
|
8707
|
+
another command is issued. <br />
|
|
8708
|
+
Default is 0.50; value range is 0 - 10.</li>
|
|
8623
8709
|
</ul>
|
|
8624
8710
|
|
|
8625
8711
|
<h6 id="raises">Raises:</h6>
|
|
@@ -8682,7 +8768,7 @@ and the response contains error information.</li>
|
|
|
8682
8768
|
<div class="attr function">
|
|
8683
8769
|
|
|
8684
8770
|
<span class="def">def</span>
|
|
8685
|
-
<span class="name">PlayerMediaPlayContext</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">contextUri</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">offsetUri</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">offsetPosition</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">positionMS</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</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="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
8771
|
+
<span class="name">PlayerMediaPlayContext</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">contextUri</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">offsetUri</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">offsetPosition</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">positionMS</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</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">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
8686
8772
|
|
|
8687
8773
|
|
|
8688
8774
|
</div>
|
|
@@ -8716,6 +8802,10 @@ Example: <code>25000</code> </li>
|
|
|
8716
8802
|
<li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
|
|
8717
8803
|
If not supplied, the user's currently active device is the target. <br />
|
|
8718
8804
|
Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
|
|
8805
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
|
|
8806
|
+
This delay will give the spotify web api time to process the change before
|
|
8807
|
+
another command is issued. <br />
|
|
8808
|
+
Default is 0.50; value range is 0 - 10.</li>
|
|
8719
8809
|
</ul>
|
|
8720
8810
|
|
|
8721
8811
|
<h6 id="raises">Raises:</h6>
|
|
@@ -8912,6 +9002,89 @@ and the response contains error information.</li>
|
|
|
8912
9002
|
</code></pre>
|
|
8913
9003
|
</div>
|
|
8914
9004
|
|
|
9005
|
+
<p></details></p>
|
|
9006
|
+
</div>
|
|
9007
|
+
|
|
9008
|
+
|
|
9009
|
+
</div>
|
|
9010
|
+
<div id="SpotifyClient.PlayerMediaPlayTrackFavorites" class="classattr">
|
|
9011
|
+
<div class="attr function">
|
|
9012
|
+
|
|
9013
|
+
<span class="def">def</span>
|
|
9014
|
+
<span class="name">PlayerMediaPlayTrackFavorites</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">shuffle</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="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
9015
|
+
|
|
9016
|
+
|
|
9017
|
+
</div>
|
|
9018
|
+
<a class="headerlink" href="#SpotifyClient.PlayerMediaPlayTrackFavorites"></a>
|
|
9019
|
+
|
|
9020
|
+
<div class="docstring"><p>Get a list of the tracks saved in the current Spotify user's 'Your Library'
|
|
9021
|
+
and starts playing them.</p>
|
|
9022
|
+
|
|
9023
|
+
<h6 id="arguments">Arguments:</h6>
|
|
9024
|
+
|
|
9025
|
+
<ul>
|
|
9026
|
+
<li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
|
|
9027
|
+
If not supplied, the user's currently active device is the target. <br />
|
|
9028
|
+
Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
|
|
9029
|
+
<li><strong>shuffle (bool):</strong> True to set player shuffle mode to on; otherwise, False for no shuffle.</li>
|
|
9030
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
|
|
9031
|
+
This delay will give the spotify web api time to process the change before
|
|
9032
|
+
another command is issued. <br />
|
|
9033
|
+
Default is 0.50; value range is 0 - 10.</li>
|
|
9034
|
+
</ul>
|
|
9035
|
+
|
|
9036
|
+
<h6 id="raises">Raises:</h6>
|
|
9037
|
+
|
|
9038
|
+
<ul>
|
|
9039
|
+
<li><strong>SpotifyWebApiError:</strong> If the Spotify Web API request was for a non-authorization service
|
|
9040
|
+
and the response contains error information.</li>
|
|
9041
|
+
<li><strong>SpotifApiError:</strong> If the method fails for any other reason.</li>
|
|
9042
|
+
</ul>
|
|
9043
|
+
|
|
9044
|
+
<p>This API only works for users who have Spotify Premium. </p>
|
|
9045
|
+
|
|
9046
|
+
<p>This method simply calls the <code><a href="#SpotifyClient.GetTrackFavorites">GetTrackFavorites</a></code> method to retrieve the current users
|
|
9047
|
+
favorite tracks (200 max), then calls the <code><a href="#SpotifyClient.PlayerMediaPlayTracks">PlayerMediaPlayTracks</a></code> method to play them. </p>
|
|
9048
|
+
|
|
9049
|
+
<p><details>
|
|
9050
|
+
<summary>Sample Code</summary></p>
|
|
9051
|
+
|
|
9052
|
+
<div class="pdoc-code codehilite">
|
|
9053
|
+
<pre><span></span><code><span class="kn">from</span> <span class="nn">spotifywebapipython</span> <span class="kn">import</span> <span class="o">*</span>
|
|
9054
|
+
<span class="kn">from</span> <span class="nn">spotifywebapipython.models</span> <span class="kn">import</span> <span class="o">*</span>
|
|
9055
|
+
|
|
9056
|
+
<span class="k">try</span><span class="p">:</span>
|
|
9057
|
+
|
|
9058
|
+
<span class="c1"># this sample requires an authorization token, as it requires security scope to accesses user data.</span>
|
|
9059
|
+
|
|
9060
|
+
<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>
|
|
9061
|
+
<span class="n">SPOTIFY_SCOPES</span><span class="p">:</span><span class="nb">list</span> <span class="o">=</span> \
|
|
9062
|
+
<span class="p">[</span>
|
|
9063
|
+
<span class="s1">'user-modify-playback-state'</span><span class="p">,</span>
|
|
9064
|
+
<span class="s1">'user-read-email'</span><span class="p">,</span>
|
|
9065
|
+
<span class="p">]</span>
|
|
9066
|
+
|
|
9067
|
+
<span class="c1"># create new spotify client instance.</span>
|
|
9068
|
+
<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>
|
|
9069
|
+
|
|
9070
|
+
<span class="c1"># generate a spotify authorization code with PKCE access token (with scope, private and public data use).</span>
|
|
9071
|
+
<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>
|
|
9072
|
+
<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>
|
|
9073
|
+
<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>
|
|
9074
|
+
|
|
9075
|
+
<span class="c1"># play all track favorites on the specified Spotify Connect device.</span>
|
|
9076
|
+
<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>
|
|
9077
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</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">'</span> <span class="o">%</span> <span class="n">deviceId</span><span class="p">)</span>
|
|
9078
|
+
<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
|
+
|
|
9080
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Success - media should be playing'</span><span class="p">)</span>
|
|
9081
|
+
|
|
9082
|
+
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
|
|
9083
|
+
|
|
9084
|
+
<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>
|
|
9085
|
+
</code></pre>
|
|
9086
|
+
</div>
|
|
9087
|
+
|
|
8915
9088
|
<p></details></p>
|
|
8916
9089
|
</div>
|
|
8917
9090
|
|
|
@@ -8921,7 +9094,7 @@ and the response contains error information.</li>
|
|
|
8921
9094
|
<div class="attr function">
|
|
8922
9095
|
|
|
8923
9096
|
<span class="def">def</span>
|
|
8924
|
-
<span class="name">PlayerMediaPlayTracks</span><span class="signature pdoc-code
|
|
9097
|
+
<span class="name">PlayerMediaPlayTracks</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">uris</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>,</span><span class="param"> <span class="n">positionMS</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</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">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
8925
9098
|
|
|
8926
9099
|
|
|
8927
9100
|
</div>
|
|
@@ -8947,6 +9120,10 @@ Example: <code>25000</code> </li>
|
|
|
8947
9120
|
<li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
|
|
8948
9121
|
If not supplied, the user's currently active device is the target. <br />
|
|
8949
9122
|
Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
|
|
9123
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
|
|
9124
|
+
This delay will give the spotify web api time to process the change before
|
|
9125
|
+
another command is issued. <br />
|
|
9126
|
+
Default is 0.50; value range is 0 - 10.</li>
|
|
8950
9127
|
</ul>
|
|
8951
9128
|
|
|
8952
9129
|
<h6 id="raises">Raises:</h6>
|
|
@@ -9027,7 +9204,7 @@ and the response contains error information.</li>
|
|
|
9027
9204
|
<div class="attr function">
|
|
9028
9205
|
|
|
9029
9206
|
<span class="def">def</span>
|
|
9030
|
-
<span class="name">PlayerMediaResume</span><span class="signature pdoc-code condensed">(<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="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
9207
|
+
<span class="name">PlayerMediaResume</span><span class="signature pdoc-code condensed">(<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">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
9031
9208
|
|
|
9032
9209
|
|
|
9033
9210
|
</div>
|
|
@@ -9043,6 +9220,10 @@ and the response contains error information.</li>
|
|
|
9043
9220
|
<li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
|
|
9044
9221
|
If not supplied, the user's currently active device is the target. <br />
|
|
9045
9222
|
Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
|
|
9223
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
|
|
9224
|
+
This delay will give the spotify web api time to process the change before
|
|
9225
|
+
another command is issued. <br />
|
|
9226
|
+
Default is 0.50; value range is 0 - 10.</li>
|
|
9046
9227
|
</ul>
|
|
9047
9228
|
|
|
9048
9229
|
<h6 id="raises">Raises:</h6>
|
|
@@ -9105,7 +9286,7 @@ and the response contains error information.</li>
|
|
|
9105
9286
|
<div class="attr function">
|
|
9106
9287
|
|
|
9107
9288
|
<span class="def">def</span>
|
|
9108
|
-
<span class="name">PlayerMediaSeek</span><span class="signature pdoc-code
|
|
9289
|
+
<span class="name">PlayerMediaSeek</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">positionMS</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</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">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
9109
9290
|
|
|
9110
9291
|
|
|
9111
9292
|
</div>
|
|
@@ -9126,6 +9307,10 @@ Example: <code>25000</code> </li>
|
|
|
9126
9307
|
<li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
|
|
9127
9308
|
If not supplied, the user's currently active device is the target. <br />
|
|
9128
9309
|
Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
|
|
9310
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
|
|
9311
|
+
This delay will give the spotify web api time to process the change before
|
|
9312
|
+
another command is issued. <br />
|
|
9313
|
+
Default is 0.50; value range is 0 - 10.</li>
|
|
9129
9314
|
</ul>
|
|
9130
9315
|
|
|
9131
9316
|
<h6 id="raises">Raises:</h6>
|
|
@@ -9189,7 +9374,7 @@ and the response contains error information.</li>
|
|
|
9189
9374
|
<div class="attr function">
|
|
9190
9375
|
|
|
9191
9376
|
<span class="def">def</span>
|
|
9192
|
-
<span class="name">PlayerMediaSkipNext</span><span class="signature pdoc-code condensed">(<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="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
9377
|
+
<span class="name">PlayerMediaSkipNext</span><span class="signature pdoc-code condensed">(<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">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
9193
9378
|
|
|
9194
9379
|
|
|
9195
9380
|
</div>
|
|
@@ -9205,6 +9390,10 @@ and the response contains error information.</li>
|
|
|
9205
9390
|
<li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
|
|
9206
9391
|
If not supplied, the user's currently active device is the target. <br />
|
|
9207
9392
|
Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
|
|
9393
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
|
|
9394
|
+
This delay will give the spotify web api time to process the change before
|
|
9395
|
+
another command is issued. <br />
|
|
9396
|
+
Default is 0.50; value range is 0 - 10.</li>
|
|
9208
9397
|
</ul>
|
|
9209
9398
|
|
|
9210
9399
|
<h6 id="raises">Raises:</h6>
|
|
@@ -9267,7 +9456,7 @@ and the response contains error information.</li>
|
|
|
9267
9456
|
<div class="attr function">
|
|
9268
9457
|
|
|
9269
9458
|
<span class="def">def</span>
|
|
9270
|
-
<span class="name">PlayerMediaSkipPrevious</span><span class="signature pdoc-code condensed">(<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="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
9459
|
+
<span class="name">PlayerMediaSkipPrevious</span><span class="signature pdoc-code condensed">(<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">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
9271
9460
|
|
|
9272
9461
|
|
|
9273
9462
|
</div>
|
|
@@ -9283,6 +9472,10 @@ and the response contains error information.</li>
|
|
|
9283
9472
|
<li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
|
|
9284
9473
|
If not supplied, the user's currently active device is the target. <br />
|
|
9285
9474
|
Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
|
|
9475
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
|
|
9476
|
+
This delay will give the spotify web api time to process the change before
|
|
9477
|
+
another command is issued. <br />
|
|
9478
|
+
Default is 0.50; value range is 0 - 10.</li>
|
|
9286
9479
|
</ul>
|
|
9287
9480
|
|
|
9288
9481
|
<h6 id="raises">Raises:</h6>
|
|
@@ -9345,7 +9538,7 @@ and the response contains error information.</li>
|
|
|
9345
9538
|
<div class="attr function">
|
|
9346
9539
|
|
|
9347
9540
|
<span class="def">def</span>
|
|
9348
|
-
<span class="name">PlayerSetRepeatMode</span><span class="signature pdoc-code
|
|
9541
|
+
<span class="name">PlayerSetRepeatMode</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">state</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'off'</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">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
9349
9542
|
|
|
9350
9543
|
|
|
9351
9544
|
</div>
|
|
@@ -9368,6 +9561,10 @@ Default: <code>off</code> </li>
|
|
|
9368
9561
|
<li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
|
|
9369
9562
|
If not supplied, the user's currently active device is the target. <br />
|
|
9370
9563
|
Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
|
|
9564
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
|
|
9565
|
+
This delay will give the spotify web api time to process the change before
|
|
9566
|
+
another command is issued. <br />
|
|
9567
|
+
Default is 0.50; value range is 0 - 10.</li>
|
|
9371
9568
|
</ul>
|
|
9372
9569
|
|
|
9373
9570
|
<h6 id="raises">Raises:</h6>
|
|
@@ -9444,7 +9641,7 @@ and the response contains error information.</li>
|
|
|
9444
9641
|
<div class="attr function">
|
|
9445
9642
|
|
|
9446
9643
|
<span class="def">def</span>
|
|
9447
|
-
<span class="name">PlayerSetShuffleMode</span><span class="signature pdoc-code
|
|
9644
|
+
<span class="name">PlayerSetShuffleMode</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">state</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">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">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
9448
9645
|
|
|
9449
9646
|
|
|
9450
9647
|
</div>
|
|
@@ -9466,6 +9663,10 @@ Default: <code>False</code> </li>
|
|
|
9466
9663
|
<li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
|
|
9467
9664
|
If not supplied, the user's currently active device is the target. <br />
|
|
9468
9665
|
Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
|
|
9666
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
|
|
9667
|
+
This delay will give the spotify web api time to process the change before
|
|
9668
|
+
another command is issued. <br />
|
|
9669
|
+
Default is 0.50; value range is 0 - 10.</li>
|
|
9469
9670
|
</ul>
|
|
9470
9671
|
|
|
9471
9672
|
<h6 id="raises">Raises:</h6>
|
|
@@ -9535,7 +9736,7 @@ and the response contains error information.</li>
|
|
|
9535
9736
|
<div class="attr function">
|
|
9536
9737
|
|
|
9537
9738
|
<span class="def">def</span>
|
|
9538
|
-
<span class="name">PlayerSetVolume</span><span class="signature pdoc-code
|
|
9739
|
+
<span class="name">PlayerSetVolume</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">volumePercent</span><span class="p">:</span> <span class="nb">int</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">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
9539
9740
|
|
|
9540
9741
|
|
|
9541
9742
|
</div>
|
|
@@ -9554,6 +9755,10 @@ Example: <code>50</code></li>
|
|
|
9554
9755
|
<li><strong>deviceId (str):</strong> The id of the device this command is targeting. <br />
|
|
9555
9756
|
If not supplied, the user's currently active device is the target. <br />
|
|
9556
9757
|
Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
|
|
9758
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
|
|
9759
|
+
This delay will give the spotify web api time to process the change before
|
|
9760
|
+
another command is issued. <br />
|
|
9761
|
+
Default is 0.50; value range is 0 - 10.</li>
|
|
9557
9762
|
</ul>
|
|
9558
9763
|
|
|
9559
9764
|
<h6 id="raises">Raises:</h6>
|
|
@@ -9612,7 +9817,7 @@ and the response contains error information.</li>
|
|
|
9612
9817
|
<div class="attr function">
|
|
9613
9818
|
|
|
9614
9819
|
<span class="def">def</span>
|
|
9615
|
-
<span class="name">PlayerTransferPlayback</span><span class="signature pdoc-code
|
|
9820
|
+
<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="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
9616
9821
|
|
|
9617
9822
|
|
|
9618
9823
|
</div>
|
|
@@ -9633,6 +9838,10 @@ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
|
|
|
9633
9838
|
<li><code>False</code> - keep the current playback state. <br />
|
|
9634
9839
|
Default: <code>True</code> </li>
|
|
9635
9840
|
</ul></li>
|
|
9841
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
|
|
9842
|
+
This delay will give the spotify web api time to process the change before
|
|
9843
|
+
another command is issued. <br />
|
|
9844
|
+
Default is 0.50; value range is 0 - 10.</li>
|
|
9636
9845
|
</ul>
|
|
9637
9846
|
|
|
9638
9847
|
<h6 id="raises">Raises:</h6>
|
|
@@ -9706,7 +9915,7 @@ and the response contains error information.</li>
|
|
|
9706
9915
|
<div class="attr function">
|
|
9707
9916
|
|
|
9708
9917
|
<span class="def">def</span>
|
|
9709
|
-
<span class="name">PlayerVerifyDeviceDefault</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">defaultDeviceId</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">False</span></span><span class="return-annotation">) -> <span class="n"><a href="models/playerplaystate.html#PlayerPlayState">spotifywebapipython.models.playerplaystate.PlayerPlayState</a></span>:</span></span>
|
|
9918
|
+
<span class="name">PlayerVerifyDeviceDefault</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">defaultDeviceId</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">False</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="return-annotation">) -> <span class="n"><a href="models/playerplaystate.html#PlayerPlayState">spotifywebapipython.models.playerplaystate.PlayerPlayState</a></span>:</span></span>
|
|
9710
9919
|
|
|
9711
9920
|
|
|
9712
9921
|
</div>
|
|
@@ -9731,12 +9940,17 @@ Example: <code>0d1841b0976bae2a3a310dd74c0f3df354899bc8</code></li>
|
|
|
9731
9940
|
<li><code>False</code> - keep the current playback state. <br />
|
|
9732
9941
|
Default: <code>False</code> </li>
|
|
9733
9942
|
</ul></li>
|
|
9943
|
+
<li><strong>delay (float):</strong> Time delay (in seconds) to wait AFTER issuing the command to the player. <br />
|
|
9944
|
+
This delay will give the spotify web api time to process the change before
|
|
9945
|
+
another command is issued. <br />
|
|
9946
|
+
Default is 0.50; value range is 0 - 10.</li>
|
|
9734
9947
|
</ul>
|
|
9735
9948
|
|
|
9736
9949
|
<h6 id="returns">Returns:</h6>
|
|
9737
9950
|
|
|
9738
9951
|
<blockquote>
|
|
9739
|
-
<p>A <code>PlayerPlayState</code> object that contains
|
|
9952
|
+
<p>A <code>PlayerPlayState</code> object that contains player state details as well as
|
|
9953
|
+
currently playing content.</p>
|
|
9740
9954
|
</blockquote>
|
|
9741
9955
|
|
|
9742
9956
|
<h6 id="raises">Raises:</h6>
|
|
@@ -10036,6 +10250,92 @@ in the Spotify music catalog.</p>
|
|
|
10036
10250
|
</code></pre>
|
|
10037
10251
|
</div>
|
|
10038
10252
|
|
|
10253
|
+
<p></details></p>
|
|
10254
|
+
</div>
|
|
10255
|
+
|
|
10256
|
+
|
|
10257
|
+
</div>
|
|
10258
|
+
<div id="SpotifyClient.RemovePlaylist" class="classattr">
|
|
10259
|
+
<div class="attr function">
|
|
10260
|
+
|
|
10261
|
+
<span class="def">def</span>
|
|
10262
|
+
<span class="name">RemovePlaylist</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">playlistId</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
10263
|
+
|
|
10264
|
+
|
|
10265
|
+
</div>
|
|
10266
|
+
<a class="headerlink" href="#SpotifyClient.RemovePlaylist"></a>
|
|
10267
|
+
|
|
10268
|
+
<div class="docstring"><p>Remove a user's playlist (calls the <code><a href="#SpotifyClient.UnfollowPlaylist">UnfollowPlaylist</a></code> method).</p>
|
|
10269
|
+
|
|
10270
|
+
<p>This method requires the <code>playlist-modify-public</code> and <code>playlist-modify-private</code> scope.</p>
|
|
10271
|
+
|
|
10272
|
+
<h6 id="arguments">Arguments:</h6>
|
|
10273
|
+
|
|
10274
|
+
<ul>
|
|
10275
|
+
<li><strong>playlistId (str):</strong> The Spotify ID of the playlist.
|
|
10276
|
+
Example: <code>5AC9ZXA7nJ7oGWO911FuDG</code></li>
|
|
10277
|
+
</ul>
|
|
10278
|
+
|
|
10279
|
+
<h6 id="raises">Raises:</h6>
|
|
10280
|
+
|
|
10281
|
+
<ul>
|
|
10282
|
+
<li><strong>SpotifyWebApiError:</strong> If the Spotify Web API request was for a non-authorization service
|
|
10283
|
+
and the response contains error information.</li>
|
|
10284
|
+
<li><strong>SpotifApiError:</strong> If the method fails for any other reason.</li>
|
|
10285
|
+
</ul>
|
|
10286
|
+
|
|
10287
|
+
<p>There is no Spotify Web API endpoint for deleting a playlist. The notion of deleting a playlist is
|
|
10288
|
+
not relevant within the Spotify playlist system. Even if you are the playlist owner and you choose
|
|
10289
|
+
to manually remove it from your own list of playlists, you are simply unfollowing it. Although this
|
|
10290
|
+
behavior may sound strange, it means that other users who are already following the playlist can keep
|
|
10291
|
+
enjoying it. </p>
|
|
10292
|
+
|
|
10293
|
+
<p><a href="https://www.spotify.com/us/account/recover-playlists/">Manually restoring a deleted playlist</a> through
|
|
10294
|
+
the Spotify Accounts Service is the same thing as following one of your own playlists that you have
|
|
10295
|
+
previously unfollowed.</p>
|
|
10296
|
+
|
|
10297
|
+
<p><details>
|
|
10298
|
+
<summary>Sample Code</summary></p>
|
|
10299
|
+
|
|
10300
|
+
<div class="pdoc-code codehilite">
|
|
10301
|
+
<pre><span></span><code><span class="kn">from</span> <span class="nn">spotifywebapipython</span> <span class="kn">import</span> <span class="o">*</span>
|
|
10302
|
+
<span class="kn">from</span> <span class="nn">spotifywebapipython.models</span> <span class="kn">import</span> <span class="o">*</span>
|
|
10303
|
+
|
|
10304
|
+
<span class="k">try</span><span class="p">:</span>
|
|
10305
|
+
|
|
10306
|
+
<span class="c1"># this sample requires an authorization token, as it requires security scope to accesses user data.</span>
|
|
10307
|
+
|
|
10308
|
+
<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>
|
|
10309
|
+
<span class="n">SPOTIFY_SCOPES</span><span class="p">:</span><span class="nb">list</span> <span class="o">=</span> \
|
|
10310
|
+
<span class="p">[</span>
|
|
10311
|
+
<span class="s1">'user-read-email'</span><span class="p">,</span>
|
|
10312
|
+
<span class="s1">'user-library-read'</span><span class="p">,</span>
|
|
10313
|
+
<span class="s1">'user-library-modify'</span><span class="p">,</span>
|
|
10314
|
+
<span class="s1">'playlist-modify-private'</span><span class="p">,</span>
|
|
10315
|
+
<span class="s1">'playlist-modify-public'</span>
|
|
10316
|
+
<span class="p">]</span>
|
|
10317
|
+
|
|
10318
|
+
<span class="c1"># create new spotify client instance.</span>
|
|
10319
|
+
<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>
|
|
10320
|
+
|
|
10321
|
+
<span class="c1"># generate a spotify authorization code with PKCE access token (with scope, private and public data use).</span>
|
|
10322
|
+
<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>
|
|
10323
|
+
<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>
|
|
10324
|
+
<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>
|
|
10325
|
+
|
|
10326
|
+
<span class="c1"># remove playlist (ie. unfollow it).</span>
|
|
10327
|
+
<span class="n">playlistId</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'4yptcTKnXjCu3V92tVVafS'</span>
|
|
10328
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Removing playlist id "</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="n">playlistId</span><span class="p">)</span>
|
|
10329
|
+
<span class="n">spotify</span><span class="o">.</span><span class="n">RemovePlaylist</span><span class="p">(</span><span class="n">playlistId</span><span class="p">)</span>
|
|
10330
|
+
|
|
10331
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Playlist removed successfully'</span><span class="p">)</span>
|
|
10332
|
+
|
|
10333
|
+
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
|
|
10334
|
+
|
|
10335
|
+
<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>
|
|
10336
|
+
</code></pre>
|
|
10337
|
+
</div>
|
|
10338
|
+
|
|
10039
10339
|
<p></details></p>
|
|
10040
10340
|
</div>
|
|
10041
10341
|
|
|
@@ -10068,6 +10368,7 @@ If null, the currently playing context uri value is used.</li>
|
|
|
10068
10368
|
The API will validate that the specified items exist and in the specified positions and
|
|
10069
10369
|
make the changes, even if more recent changes have been made to the playlist.
|
|
10070
10370
|
If null, the current playlist is updated. <br />
|
|
10371
|
+
Example: <code>MTk3LGEzMjUwZGYwODljNmI5ZjAxZTRjZThiOGI4NzZhM2U5M2IxOWUyMDQ</code>
|
|
10071
10372
|
Default is null.</li>
|
|
10072
10373
|
</ul>
|
|
10073
10374
|
|
|
@@ -10347,6 +10648,7 @@ The range of items to be reordered begins from the <code>rangeStart</code> posit
|
|
|
10347
10648
|
the <code>rangeLength</code> subsequent items. </li>
|
|
10348
10649
|
<li><strong>snapshotId (str):</strong> The playlist's snapshot ID against which you want to make the changes. <br />
|
|
10349
10650
|
If null, the current playlist is updated. <br />
|
|
10651
|
+
Example: <code>MTk3LGEzMjUwZGYwODljNmI5ZjAxZTRjZThiOGI4NzZhM2U5M2IxOWUyMDQ</code>
|
|
10350
10652
|
Default is null.</li>
|
|
10351
10653
|
</ul>
|
|
10352
10654
|
|