spotifywebapiPython 1.0.35__py3-none-any.whl → 1.0.147__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.35.dist-info → spotifywebapiPython-1.0.147.dist-info}/LICENSE +1 -1
- {spotifywebapiPython-1.0.35.dist-info → spotifywebapiPython-1.0.147.dist-info}/METADATA +7 -6
- spotifywebapiPython-1.0.147.dist-info/RECORD +117 -0
- spotifywebapipython/__init__.py +2 -0
- spotifywebapipython/const.py +19 -1
- spotifywebapipython/docs/__init__.html +799 -3
- spotifywebapipython/docs/index.html +21 -3
- spotifywebapipython/docs/search.js +1 -1
- spotifywebapipython/docs/{spotifywebapiPython → spotifywebapipython}/const.html +72 -4
- spotifywebapipython/docs/{spotifywebapiPython → spotifywebapipython}/saappmessages.html +77 -3
- spotifywebapipython/docs/{spotifywebapiPython → spotifywebapipython}/sautils.html +63 -3
- spotifywebapipython/docs/{spotifywebapiPython → spotifywebapipython}/spotifyapierror.html +3 -3
- spotifywebapipython/docs/{spotifywebapiPython → spotifywebapipython}/spotifyapimessage.html +20 -3
- spotifywebapipython/docs/{spotifywebapiPython → spotifywebapipython}/spotifyauthtoken.html +39 -3
- spotifywebapipython/docs/{spotifywebapiPython → spotifywebapipython}/spotifyclient.html +2553 -364
- spotifywebapipython/docs/{spotifywebapiPython → spotifywebapipython}/spotifydiscovery.html +85 -52
- spotifywebapipython/docs/{spotifywebapiPython → spotifywebapipython}/spotifywebapiauthenticationerror.html +3 -3
- spotifywebapipython/docs/{spotifywebapiPython → spotifywebapipython}/spotifywebapierror.html +3 -3
- spotifywebapipython/models/__init__.py +8 -0
- spotifywebapipython/models/albumpagesaved.py +2 -1
- spotifywebapipython/models/albumpagesimplified.py +2 -1
- spotifywebapipython/models/albumsimplified.py +4 -5
- spotifywebapipython/models/artist.py +4 -5
- spotifywebapipython/models/artistinfo.py +282 -0
- spotifywebapipython/models/artistinfotourevent.py +127 -0
- spotifywebapipython/models/artistpage.py +2 -1
- spotifywebapipython/models/artistsimplified.py +4 -0
- spotifywebapipython/models/audiobookpagesimplified.py +2 -1
- spotifywebapipython/models/audiobooksimplified.py +4 -5
- spotifywebapipython/models/category.py +16 -0
- spotifywebapipython/models/categorypage.py +2 -1
- spotifywebapipython/models/chapterpagesimplified.py +2 -1
- spotifywebapipython/models/chaptersimplified.py +6 -7
- spotifywebapipython/models/context.py +1 -3
- spotifywebapipython/models/device.py +85 -2
- spotifywebapipython/models/episodepagesaved.py +2 -1
- spotifywebapipython/models/episodepagesimplified.py +2 -1
- spotifywebapipython/models/episodesaved.py +2 -2
- spotifywebapipython/models/episodesimplified.py +5 -6
- spotifywebapipython/models/imageobject.py +98 -0
- spotifywebapipython/models/pageobject.py +29 -4
- spotifywebapipython/models/playeractions.py +33 -11
- spotifywebapipython/models/playerplaystate.py +128 -13
- spotifywebapipython/models/playerqueueinfo.py +61 -4
- spotifywebapipython/models/playhistorypage.py +2 -1
- spotifywebapipython/models/playlist.py +6 -3
- spotifywebapipython/models/playlistpage.py +2 -1
- spotifywebapipython/models/playlistpagesimplified.py +2 -1
- spotifywebapipython/models/playlistsimplified.py +49 -7
- spotifywebapipython/models/playlisttrack.py +1 -0
- spotifywebapipython/models/playlisttracksummary.py +3 -1
- spotifywebapipython/models/searchresponse.py +1 -1
- spotifywebapipython/models/showpagesaved.py +2 -1
- spotifywebapipython/models/showpagesimplified.py +2 -1
- spotifywebapipython/models/showsaved.py +2 -2
- spotifywebapipython/models/showsimplified.py +8 -5
- spotifywebapipython/models/spotifyconnectdevice.py +188 -0
- spotifywebapipython/models/spotifyconnectdevices.py +628 -0
- spotifywebapipython/models/track.py +2 -1
- spotifywebapipython/models/trackpage.py +42 -1
- spotifywebapipython/models/trackpagesaved.py +2 -1
- spotifywebapipython/models/trackpagesimplified.py +2 -1
- spotifywebapipython/models/trackrecommendations.py +5 -5
- spotifywebapipython/models/tracksimplified.py +10 -3
- spotifywebapipython/models/userprofile.py +25 -1
- spotifywebapipython/models/userprofilesimplified.py +4 -5
- spotifywebapipython/models/zeroconfdiscoveryresult.py +599 -0
- spotifywebapipython/models/zeroconfproperty.py +93 -0
- spotifywebapipython/oauthcli/authclient.py +119 -19
- spotifywebapipython/saappmessages.py +21 -1
- spotifywebapipython/sautils.py +88 -1
- spotifywebapipython/spotifyapimessage.py +18 -1
- spotifywebapipython/spotifyauthtoken.py +26 -0
- spotifywebapipython/spotifyclient.py +4311 -525
- spotifywebapipython/spotifyconnectdeviceeventargs.py +67 -0
- spotifywebapipython/spotifydiscovery.py +326 -136
- spotifywebapipython/zeroconfapi/__init__.py +23 -0
- spotifywebapipython/zeroconfapi/authenticationtypes.py +38 -0
- spotifywebapipython/zeroconfapi/blobbuilder.py +370 -0
- spotifywebapipython/zeroconfapi/credentials.py +37 -0
- spotifywebapipython/zeroconfapi/cryptodiffiehellman.py +89 -0
- spotifywebapipython/zeroconfapi/helpers.py +64 -0
- spotifywebapipython/zeroconfapi/spotifyzeroconfapierror.py +108 -0
- spotifywebapipython/zeroconfapi/zeroconfconnect.py +1315 -0
- spotifywebapipython/zeroconfapi/zeroconfgetinfo.py +619 -0
- spotifywebapipython/zeroconfapi/zeroconfgetinfoalias.py +105 -0
- spotifywebapipython/zeroconfapi/zeroconfgetinfodrmmediaformat.py +90 -0
- spotifywebapipython/zeroconfapi/zeroconfresponse.py +141 -0
- spotifywebapiPython-1.0.35.dist-info/RECORD +0 -98
- {spotifywebapiPython-1.0.35.dist-info → spotifywebapiPython-1.0.147.dist-info}/WHEEL +0 -0
- {spotifywebapiPython-1.0.35.dist-info → spotifywebapiPython-1.0.147.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.147" -->
|
|
13
13
|
<!-- pdoc module.modulename = "__init__" -->
|
|
14
14
|
<!-- pdoc module.is_package = "False" -->
|
|
15
15
|
<!-- pdoc root_module_name = "None" -->
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
<style>/*! theme.css */:root{--pdoc-background:#212529;}.pdoc{--text:#f7f7f7;--muted:#9d9d9d;--link:#58a6ff;--link-hover:#3989ff;--code:#333;--active:#555;--accent:#343434;--accent2:#555;--nav-hover:rgba(0, 0, 0, 0.1);--name:#77C1FF;--def:#0cdd0c;--annotation:#00c037;}</style>
|
|
22
22
|
<style>/*! layout.css */html, body{width:100%;height:100%;}html, main{scroll-behavior:smooth;}body{background-color:var(--pdoc-background);}@media (max-width:769px){#navtoggle{cursor:pointer;position:absolute;width:50px;height:40px;top:1rem;right:1rem;border-color:var(--text);color:var(--text);display:flex;opacity:0.8;z-index:999;}#navtoggle:hover{opacity:1;}#togglestate + div{display:none;}#togglestate:checked + div{display:inherit;}main, header{padding:2rem 3vw;}header + main{margin-top:-3rem;}.git-button{display:none !important;}nav input[type="search"]{max-width:77%;}nav input[type="search"]:first-child{margin-top:-6px;}nav input[type="search"]:valid ~ *{display:none !important;}}@media (min-width:770px){:root{--sidebar-width:clamp(12.5rem, 28vw, 22rem);}nav{position:fixed;overflow:auto;height:100vh;width:var(--sidebar-width);}main, header{padding:3rem 2rem 3rem calc(var(--sidebar-width) + 3rem);width:calc(54rem + var(--sidebar-width));max-width:100%;}header + main{margin-top:-4rem;}#navtoggle{display:none;}}#togglestate{position:absolute;height:0;opacity:0;}nav.pdoc{--pad:clamp(0.5rem, 2vw, 1.75rem);--indent:1.5rem;background-color:var(--accent);border-right:1px solid var(--accent2);box-shadow:0 0 20px rgba(50, 50, 50, .2) inset;padding:0 0 0 var(--pad);overflow-wrap:anywhere;scrollbar-width:thin; scrollbar-color:var(--accent2) transparent; z-index:1}nav.pdoc::-webkit-scrollbar{width:.4rem; }nav.pdoc::-webkit-scrollbar-thumb{background-color:var(--accent2); }nav.pdoc > div{padding:var(--pad) 0;}nav.pdoc .module-list-button{display:inline-flex;align-items:center;color:var(--text);border-color:var(--muted);margin-bottom:1rem;}nav.pdoc .module-list-button:hover{border-color:var(--text);}nav.pdoc input[type=search]{display:block;outline-offset:0;width:calc(100% - var(--pad));}nav.pdoc .logo{max-width:calc(100% - var(--pad));max-height:35vh;display:block;margin:0 auto 1rem;transform:translate(calc(-.5 * var(--pad)), 0);}nav.pdoc ul{list-style:none;padding-left:0;}nav.pdoc > div > ul{margin-left:calc(0px - var(--pad));}nav.pdoc li a{padding:.2rem 0 .2rem calc(var(--pad) + var(--indent));}nav.pdoc > div > ul > li > a{padding-left:var(--pad);}nav.pdoc li{transition:all 100ms;}nav.pdoc li:hover{background-color:var(--nav-hover);}nav.pdoc a, nav.pdoc a:hover{color:var(--text);}nav.pdoc a{display:block;}nav.pdoc > h2:first-of-type{margin-top:1.5rem;}nav.pdoc .class:before{content:"class ";color:var(--muted);}nav.pdoc .function:after{content:"()";color:var(--muted);}nav.pdoc footer:before{content:"";display:block;width:calc(100% - var(--pad));border-top:solid var(--accent2) 1px;margin-top:1.5rem;padding-top:.5rem;}nav.pdoc footer{font-size:small;}</style>
|
|
23
23
|
<style>/*! content.css */.pdoc{color:var(--text);box-sizing:border-box;line-height:1.5;background:none;}.pdoc .pdoc-button{cursor:pointer;display:inline-block;border:solid black 1px;border-radius:2px;font-size:.75rem;padding:calc(0.5em - 1px) 1em;transition:100ms all;}.pdoc .pdoc-alert{padding:1rem 1rem 1rem calc(1.5rem + 24px);border:1px solid transparent;border-radius:.25rem;background-repeat:no-repeat;background-position:1rem center;margin-bottom:1rem;}.pdoc .pdoc-alert > *:last-child{margin-bottom:0;}.pdoc .pdoc-alert-note {color:#084298;background-color:#cfe2ff;border-color:#b6d4fe;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23084298%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M8%2016A8%208%200%201%200%208%200a8%208%200%200%200%200%2016zm.93-9.412-1%204.705c-.07.34.029.533.304.533.194%200%20.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703%200-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381%202.29-.287zM8%205.5a1%201%200%201%201%200-2%201%201%200%200%201%200%202z%22/%3E%3C/svg%3E");}.pdoc .pdoc-alert-warning{color:#664d03;background-color:#fff3cd;border-color:#ffecb5;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23664d03%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M8.982%201.566a1.13%201.13%200%200%200-1.96%200L.165%2013.233c-.457.778.091%201.767.98%201.767h13.713c.889%200%201.438-.99.98-1.767L8.982%201.566zM8%205c.535%200%20.954.462.9.995l-.35%203.507a.552.552%200%200%201-1.1%200L7.1%205.995A.905.905%200%200%201%208%205zm.002%206a1%201%200%201%201%200%202%201%201%200%200%201%200-2z%22/%3E%3C/svg%3E");}.pdoc .pdoc-alert-danger{color:#842029;background-color:#f8d7da;border-color:#f5c2c7;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23842029%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M5.52.359A.5.5%200%200%201%206%200h4a.5.5%200%200%201%20.474.658L8.694%206H12.5a.5.5%200%200%201%20.395.807l-7%209a.5.5%200%200%201-.873-.454L6.823%209.5H3.5a.5.5%200%200%201-.48-.641l2.5-8.5z%22/%3E%3C/svg%3E");}.pdoc .visually-hidden{position:absolute !important;width:1px !important;height:1px !important;padding:0 !important;margin:-1px !important;overflow:hidden !important;clip:rect(0, 0, 0, 0) !important;white-space:nowrap !important;border:0 !important;}.pdoc h1, .pdoc h2, .pdoc h3{font-weight:300;margin:.3em 0;padding:.2em 0;}.pdoc > section:not(.module-info) h1{font-size:1.5rem;font-weight:500;}.pdoc > section:not(.module-info) h2{font-size:1.4rem;font-weight:500;}.pdoc > section:not(.module-info) h3{font-size:1.3rem;font-weight:500;}.pdoc > section:not(.module-info) h4{font-size:1.2rem;}.pdoc > section:not(.module-info) h5{font-size:1.1rem;}.pdoc a{text-decoration:none;color:var(--link);}.pdoc a:hover{color:var(--link-hover);}.pdoc blockquote{margin-left:2rem;}.pdoc pre{border-top:1px solid var(--accent2);border-bottom:1px solid var(--accent2);margin-top:0;margin-bottom:1em;padding:.5rem 0 .5rem .5rem;overflow-x:auto;background-color:var(--code);}.pdoc code{color:var(--text);padding:.2em .4em;margin:0;font-size:85%;background-color:var(--accent);border-radius:6px;}.pdoc a > code{color:inherit;}.pdoc pre > code{display:inline-block;font-size:inherit;background:none;border:none;padding:0;}.pdoc > section:not(.module-info){margin-bottom:1.5rem;}.pdoc .modulename{margin-top:0;font-weight:bold;}.pdoc .modulename a{color:var(--link);transition:100ms all;}.pdoc .git-button{float:right;border:solid var(--link) 1px;}.pdoc .git-button:hover{background-color:var(--link);color:var(--pdoc-background);}.view-source-toggle-state,.view-source-toggle-state ~ .pdoc-code{display:none;}.view-source-toggle-state:checked ~ .pdoc-code{display:block;}.view-source-button{display:inline-block;float:right;font-size:.75rem;line-height:1.5rem;color:var(--muted);padding:0 .4rem 0 1.3rem;cursor:pointer;text-indent:-2px;}.view-source-button > span{visibility:hidden;}.module-info .view-source-button{float:none;display:flex;justify-content:flex-end;margin:-1.2rem .4rem -.2rem 0;}.view-source-button::before{position:absolute;content:"View Source";display:list-item;list-style-type:disclosure-closed;}.view-source-toggle-state:checked ~ .attr .view-source-button::before,.view-source-toggle-state:checked ~ .view-source-button::before{list-style-type:disclosure-open;}.pdoc .docstring{margin-bottom:1.5rem;}.pdoc section:not(.module-info) .docstring{margin-left:clamp(0rem, 5vw - 2rem, 1rem);}.pdoc .docstring .pdoc-code{margin-left:1em;margin-right:1em;}.pdoc h1:target,.pdoc h2:target,.pdoc h3:target,.pdoc h4:target,.pdoc h5:target,.pdoc h6:target,.pdoc .pdoc-code > pre > span:target{background-color:var(--active);box-shadow:-1rem 0 0 0 var(--active);}.pdoc .pdoc-code > pre > span:target{display:block;}.pdoc div:target > .attr,.pdoc section:target > .attr,.pdoc dd:target > a{background-color:var(--active);}.pdoc *{scroll-margin:2rem;}.pdoc .pdoc-code .linenos{user-select:none;}.pdoc .attr:hover{filter:contrast(0.95);}.pdoc section, .pdoc .classattr{position:relative;}.pdoc .headerlink{--width:clamp(1rem, 3vw, 2rem);position:absolute;top:0;left:calc(0rem - var(--width));transition:all 100ms ease-in-out;opacity:0;}.pdoc .headerlink::before{content:"#";display:block;text-align:center;width:var(--width);height:2.3rem;line-height:2.3rem;font-size:1.5rem;}.pdoc .attr:hover ~ .headerlink,.pdoc *:target > .headerlink,.pdoc .headerlink:hover{opacity:1;}.pdoc .attr{display:block;margin:.5rem 0 .5rem;padding:.4rem .4rem .4rem 1rem;background-color:var(--accent);overflow-x:auto;}.pdoc .classattr{margin-left:2rem;}.pdoc .name{color:var(--name);font-weight:bold;}.pdoc .def{color:var(--def);font-weight:bold;}.pdoc .signature{background-color:transparent;}.pdoc .param, .pdoc .return-annotation{white-space:pre;}.pdoc .signature.multiline .param{display:block;}.pdoc .signature.condensed .param{display:inline-block;}.pdoc .annotation{color:var(--annotation);}.pdoc .view-value-toggle-state,.pdoc .view-value-toggle-state ~ .default_value{display:none;}.pdoc .view-value-toggle-state:checked ~ .default_value{display:inherit;}.pdoc .view-value-button{font-size:.5rem;vertical-align:middle;border-style:dashed;margin-top:-0.1rem;}.pdoc .view-value-button:hover{background:white;}.pdoc .view-value-button::before{content:"show";text-align:center;width:2.2em;display:inline-block;}.pdoc .view-value-toggle-state:checked ~ .view-value-button::before{content:"hide";}.pdoc .inherited{margin-left:2rem;}.pdoc .inherited dt{font-weight:700;}.pdoc .inherited dt, .pdoc .inherited dd{display:inline;margin-left:0;margin-bottom:.5rem;}.pdoc .inherited dd:not(:last-child):after{content:", ";}.pdoc .inherited .class:before{content:"class ";}.pdoc .inherited .function a:after{content:"()";}.pdoc .search-result .docstring{overflow:auto;max-height:25vh;}.pdoc .search-result.focused > .attr{background-color:var(--active);}.pdoc .attribution{margin-top:2rem;display:block;opacity:0.5;transition:all 200ms;filter:grayscale(100%);}.pdoc .attribution:hover{opacity:1;filter:grayscale(0%);}.pdoc .attribution img{margin-left:5px;height:35px;vertical-align:middle;width:70px;transition:all 200ms;}.pdoc table{display:block;width:max-content;max-width:100%;overflow:auto;margin-bottom:1rem;}.pdoc table th{font-weight:600;}.pdoc table th, .pdoc table td{padding:6px 13px;border:1px solid var(--accent2);}</style>
|
|
24
|
-
<style>/*! custom.css */.modulename{color:#58a6ff;}.signature .param span{color:#ffc633;}.docstring #arguments ~ ul strong{color:#ffc633;}.docstring #raises ~ ul strong{color:#f62817 !important;}#change-log ~ h6{ color:#ffc633;}details summary{ color:#58a6ff;}.footertext{ color:#58a6ff;}.pdoc .docstring .pdoc-code{ margin-left:0; margin-right:0;}div.codehilite{ background-color:var(--code); border-bottom:1px solid var(--accent2);}div.codehilite button{ color:var(--link); background:var(--pdoc-background); background-color:var(--code); border:none; box-sizing:border-box; transition:0.2s ease-out; cursor:pointer; user-select:none; padding:5px 10px; font-size:0.8em; z-index:9999; margin:2px; border-radius:0 0.15rem;}div.codehilite pre{ margin-bottom:0px;}</style></head>
|
|
24
|
+
<style>/*! custom.css */.deprecated{ color:#f62817; font-weight:bolder;}.modulename{color:#58a6ff;}.signature .param span{color:#ffc633;}.docstring #arguments ~ ul strong{color:#ffc633;}.docstring #raises ~ ul strong{color:#f62817 !important;}#change-log ~ h6{ color:#ffc633;}details summary{ color:#58a6ff;}.footertext{ color:#58a6ff;}.pdoc .docstring .pdoc-code{ margin-left:0; margin-right:0;}div.codehilite{ background-color:var(--code); border-bottom:1px solid var(--accent2);}div.codehilite button{ color:var(--link); background:var(--pdoc-background); background-color:var(--code); border:none; box-sizing:border-box; transition:0.2s ease-out; cursor:pointer; user-select:none; padding:5px 10px; font-size:0.8em; z-index:9999; margin:2px; border-radius:0 0.15rem;}div.codehilite pre{ margin-bottom:0px;}</style></head>
|
|
25
25
|
<body>
|
|
26
26
|
<nav class="pdoc">
|
|
27
27
|
<label id="navtoggle" for="togglestate" class="pdoc-button"><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 30 30'><path stroke-linecap='round' stroke="currentColor" stroke-miterlimit='10' stroke-width='2' d='M4 7h22M4 15h22M4 23h22'/></svg></label>
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
|
|
62
62
|
<footer class="footertext">
|
|
63
63
|
spotifywebapiPython</br>
|
|
64
|
-
Version 1.0.
|
|
64
|
+
Version 1.0.147</br>
|
|
65
65
|
<a href="https://developer.spotify.com/documentation/web-api" target="_blank">
|
|
66
66
|
<img src="spotifywebapipython.ico" alt="brand icon" style="width:32px; height:32px; padding:4px;"/>
|
|
67
67
|
A Spotify Web Api Client
|
|
@@ -303,6 +303,802 @@ Click on the topics below to expand the section and reveal more information. </
|
|
|
303
303
|
|
|
304
304
|
<p><span class="changelog"></p>
|
|
305
305
|
|
|
306
|
+
<p>UpdateActiveDevice</p>
|
|
307
|
+
|
|
308
|
+
<h6 id="10147-20250113">[ 1.0.147 ] - 2025/01/13</h6>
|
|
309
|
+
|
|
310
|
+
<ul>
|
|
311
|
+
<li>Added <code>SpotifyConnectDevices.UpdateActiveDevice</code> method to update the currently active device based on playerState.</li>
|
|
312
|
+
<li>Added <code>ZeroconfDiscoveryResult.Description</code> property that returns a basic description of the device, and how source info was obtained. This is a helper property, and not part of the Zeroconf ServiceInfo result.</li>
|
|
313
|
+
</ul>
|
|
314
|
+
|
|
315
|
+
<h6 id="10146-20250112">[ 1.0.146 ] - 2025/01/12</h6>
|
|
316
|
+
|
|
317
|
+
<ul>
|
|
318
|
+
<li>Added <code>SpotifyConnectDevices.RemoveDevice</code> method to remove existing device entry(s) from the <code>Items</code> collection by device id value.</li>
|
|
319
|
+
</ul>
|
|
320
|
+
|
|
321
|
+
<h6 id="10145-20250112">[ 1.0.145 ] - 2025/01/12</h6>
|
|
322
|
+
|
|
323
|
+
<ul>
|
|
324
|
+
<li>Added <code>SpotifyConnectDevices.GetActiveDevice</code> method to return a Spotify Connect device if one is currently marked as the active device; otherwise, null if there is no active device.</li>
|
|
325
|
+
<li>Updated <code>SpotifyConnectDevices.UpdatePlayerDevices</code> method to return the currently active Spotify Player device instance as determined by the Spotify Player PlayState if one was supplied; otherwise, null if not active device.</li>
|
|
326
|
+
</ul>
|
|
327
|
+
|
|
328
|
+
<h6 id="10144-20250110">[ 1.0.144 ] - 2025/01/10</h6>
|
|
329
|
+
|
|
330
|
+
<ul>
|
|
331
|
+
<li>Added <code>SpotifyConnectDevices.UpdatePlayerDevices</code> method to add a list of dynamic player device entries to the <code>Items</code> collection, remove any existing dynamic devices from the collection that are not in the <code>playerDevices</code> list, and update the currently active device based on playerState.</li>
|
|
332
|
+
</ul>
|
|
333
|
+
|
|
334
|
+
<h6 id="10143-20250110">[ 1.0.143 ] - 2025/01/10</h6>
|
|
335
|
+
|
|
336
|
+
<ul>
|
|
337
|
+
<li>Added <code>SpotifyConnectDevices.GetDeviceIndexByDiscoveryName</code> method to return the index of the <code>Items</code> collection entry that contains the specified device Zeroconf discovery results name value, or -1 if not found.</li>
|
|
338
|
+
</ul>
|
|
339
|
+
|
|
340
|
+
<h6 id="10142-20250110">[ 1.0.142 ] - 2025/01/10</h6>
|
|
341
|
+
|
|
342
|
+
<ul>
|
|
343
|
+
<li>Added <code>ZeroconfDiscoveryResult.Equals</code> method to compare object argument values to determine equality.</li>
|
|
344
|
+
<li>Added <code>ZeroconfGetInfo.Equals</code> method to compare object argument values to determine equality.</li>
|
|
345
|
+
<li>Added <code>SpotifyConnectDevice.Equals</code> method to compare object argument values to determine equality.</li>
|
|
346
|
+
</ul>
|
|
347
|
+
|
|
348
|
+
<h6 id="10141-20250109">[ 1.0.141 ] - 2025/01/09</h6>
|
|
349
|
+
|
|
350
|
+
<ul>
|
|
351
|
+
<li>Added <code>SpotifyConnectDevices.GetDeviceByDiscoveryKey</code> method to return the device of the <code>Items</code> collection entry that contains the specified device Zeroconf discovery results key value, or null if not found.</li>
|
|
352
|
+
</ul>
|
|
353
|
+
|
|
354
|
+
<h6 id="10140-20250109">[ 1.0.140 ] - 2025/01/09</h6>
|
|
355
|
+
|
|
356
|
+
<ul>
|
|
357
|
+
<li>Added <code>SpotifyConnectDevices.GetDeviceIndexByDiscoveryKey</code> method to return the index of the <code>Items</code> collection entry that contains the specified device Zeroconf discovery results key value, or -1 if not found.</li>
|
|
358
|
+
</ul>
|
|
359
|
+
|
|
360
|
+
<h6 id="10139-20250107">[ 1.0.139 ] - 2025/01/07</h6>
|
|
361
|
+
|
|
362
|
+
<ul>
|
|
363
|
+
<li>Updated <code>SpotifyDiscovery._OnServiceStateChange</code> method to correctly update the Zeroconf DiscoveryResults instance. The serviceinfo <code>Key</code> value must be used to update the device entry (not its <code>Id</code> value).</li>
|
|
364
|
+
</ul>
|
|
365
|
+
|
|
366
|
+
<h6 id="10138-20250106">[ 1.0.138 ] - 2025/01/06</h6>
|
|
367
|
+
|
|
368
|
+
<ul>
|
|
369
|
+
<li>Updated <code>SpotifyDiscovery._OnServiceStateChange</code> method to correctly update the Zeroconf DiscoveryResults instance.</li>
|
|
370
|
+
</ul>
|
|
371
|
+
|
|
372
|
+
<h6 id="10137-20250106">[ 1.0.137 ] - 2025/01/06</h6>
|
|
373
|
+
|
|
374
|
+
<ul>
|
|
375
|
+
<li>Added <code>PlayerPlayState.IsEmpty</code> property setter.</li>
|
|
376
|
+
</ul>
|
|
377
|
+
|
|
378
|
+
<h6 id="10136-20250105">[ 1.0.136 ] - 2025/01/05</h6>
|
|
379
|
+
|
|
380
|
+
<ul>
|
|
381
|
+
<li>Updated <code>SpotifyClient.PlayerTransferPlayback</code> method to check player state before trying to transfer playback. If nothing is playing, then issue a call to <code>PlayTrackFavorites</code> instead. This will avoid the <code>Restriction violated</code> error which results from a transfer playback to the player when nothing is currently playing.</li>
|
|
382
|
+
</ul>
|
|
383
|
+
|
|
384
|
+
<h6 id="10135-20250105">[ 1.0.135 ] - 2025/01/05</h6>
|
|
385
|
+
|
|
386
|
+
<ul>
|
|
387
|
+
<li>Updated <code>SpotifyClient</code> class to include properties for <code>SpotifyConnectLoginId</code> and <code>SpotifyConnectUsername</code>.</li>
|
|
388
|
+
</ul>
|
|
389
|
+
|
|
390
|
+
<h6 id="10134-20250104">[ 1.0.134 ] - 2025/01/04</h6>
|
|
391
|
+
|
|
392
|
+
<ul>
|
|
393
|
+
<li>Updated <code>SpotifyClient</code> methods <code>PlayerActivateDevices</code> and <code>GetSpotifyConnectDevice</code> to re-create the ZeroconfConnect connection instance if the device IP address or port changed after Zeroconf rediscovery on a Disconnect call sequence.</li>
|
|
394
|
+
</ul>
|
|
395
|
+
|
|
396
|
+
<h6 id="10133-20250104">[ 1.0.133 ] - 2025/01/04</h6>
|
|
397
|
+
|
|
398
|
+
<ul>
|
|
399
|
+
<li>Modified <code>SpotifyDiscovery._OnServiceStateChange</code> method to process Zeroconf Update and Remove notifications.</li>
|
|
400
|
+
</ul>
|
|
401
|
+
|
|
402
|
+
<h6 id="10132-20250102">[ 1.0.132 ] - 2025/01/02</h6>
|
|
403
|
+
|
|
404
|
+
<ul>
|
|
405
|
+
<li>Modified <code>ZeroconfConnect.GetInformation</code> method logic to automatically retry the connection (after 250ms, 2s max) to the Spotify Connect Zeroconf device service if a "connection refused" was returned while trying to get device information. This was originally set to 10 seconds, which is far too long to wait for a device to become available.</li>
|
|
406
|
+
<li>Updated <code>SpotifyClient</code> methods <code>PlayerActivateDevices</code> and <code>GetSpotifyConnectDevice</code> to rediscover the Spotify Connect Zeroconf device after a Disconnect call is issued. It has been found that some device manufacturers (e.g. Denon) stop and restart the Zeroconf server on the device after a <code>resetUsers</code> (e.g. disconnect) call is made, which changes the IP Port number that the device listens on for incoming connections.</li>
|
|
407
|
+
<li>Removed the deprecated function <code>SpotifyConnect.PlayerResolveDeviceId</code> (since 2024/08/15); use the <code>GetSpotifyConnectDevice</code> method instead.</li>
|
|
408
|
+
</ul>
|
|
409
|
+
|
|
410
|
+
<h6 id="10131-20250101">[ 1.0.131 ] - 2025/01/01</h6>
|
|
411
|
+
|
|
412
|
+
<ul>
|
|
413
|
+
<li>Modified <code>ZeroconfConnect.GetInformation</code> method logic to automatically retry the connection (after 250ms, 10s max) to the Spotify Connect Zeroconf device service if a "connection refused" was returned while trying to get device information. The previous logic used a simple delay prior to the call and did not retry the connection, which resulted in the "connection refused" exceptions while trying to awaken devices. Some Spotify Connect devices take a little bit longer to start accepting connections again after a change.</li>
|
|
414
|
+
<li>Added <code>lxml</code> package requirement to <code>setup.py</code>.</li>
|
|
415
|
+
</ul>
|
|
416
|
+
|
|
417
|
+
<h6 id="10130-20241227">[ 1.0.130 ] - 2024/12/27</h6>
|
|
418
|
+
|
|
419
|
+
<ul>
|
|
420
|
+
<li>Added <code>PlayerPlayState.IsEmpty</code> property; returns True if Spotify playstate returned an empty response; otherwise, false. This is a helper property, and is not part of the Spotify Web API specification.</li>
|
|
421
|
+
</ul>
|
|
422
|
+
|
|
423
|
+
<h6 id="10129-20241221">[ 1.0.129 ] - 2024/12/21</h6>
|
|
424
|
+
|
|
425
|
+
<ul>
|
|
426
|
+
<li>Added <code>SpotifyClient.GetCoverImageFile</code> that gets the contents of an image url and transfers the contents to the local file system. This method should only be used to download images for playlists that contain public domain images.</li>
|
|
427
|
+
<li>Added <code>ImageObject.GetImageHighestResolutionWidth</code> that returns the highest resolution order image width from a list of <code>ImageObject</code> items.</li>
|
|
428
|
+
</ul>
|
|
429
|
+
|
|
430
|
+
<h6 id="10128-20241220">[ 1.0.128 ] - 2024/12/20</h6>
|
|
431
|
+
|
|
432
|
+
<ul>
|
|
433
|
+
<li>Updated <code>PlayerActions</code> model to load the correct action values for <code>TogglingRepeatTrack</code> and <code>TogglingShuffle</code>. These were switched, which was causing shuffle and repeat actions to be misinterpreted.</li>
|
|
434
|
+
</ul>
|
|
435
|
+
|
|
436
|
+
<h6 id="10127-20241219">[ 1.0.127 ] - 2024/12/19</h6>
|
|
437
|
+
|
|
438
|
+
<ul>
|
|
439
|
+
<li>Updated <code>SpotifyClient.PlayerMediaPlayTrackFavorites</code> to default and validate limitTotal argument. It has been found that approximately 750 items can be retrieved and played successfully (anything more generates request size errors).</li>
|
|
440
|
+
</ul>
|
|
441
|
+
|
|
442
|
+
<h6 id="10126-20241218">[ 1.0.126 ] - 2024/12/18</h6>
|
|
443
|
+
|
|
444
|
+
<ul>
|
|
445
|
+
<li>Updated <code>SpotifyClient.PlayerMediaPlayTrackFavorites</code> to retrieve unsorted track favorites, so that the most recently added favorites are played instead of the first alphabetical favorites.</li>
|
|
446
|
+
</ul>
|
|
447
|
+
|
|
448
|
+
<h6 id="10125-20241209">[ 1.0.125 ] - 2024/12/09</h6>
|
|
449
|
+
|
|
450
|
+
<ul>
|
|
451
|
+
<li>Added <code>PlaylistSimplified</code> property setters for the the following properties: <code>Description</code>, <code>Id</code>, <code>Name</code>, <code>Type</code>, <code>Uri</code>.</li>
|
|
452
|
+
</ul>
|
|
453
|
+
|
|
454
|
+
<h6 id="10124-20241207">[ 1.0.124 ] - 2024/12/07</h6>
|
|
455
|
+
|
|
456
|
+
<ul>
|
|
457
|
+
<li>Updated various <code>SpotifyClient</code> methods to discard favorites that do not contain a valid URI value. Sometimes the Spotify Web API returns favorite items with no information! The following methods were updated: <code>GetAlbumFavorites</code>, <code>GetEpisodeFavorites</code>, <code>GetShowFavorites</code>, <code>GetTrackFavorites</code>.</li>
|
|
458
|
+
</ul>
|
|
459
|
+
|
|
460
|
+
<h6 id="10123-20241206">[ 1.0.123 ] - 2024/12/06</h6>
|
|
461
|
+
|
|
462
|
+
<ul>
|
|
463
|
+
<li>Updated various methods to validate boolean arguments - if value was not passed (e.g. None), then set to documented value (True or False).</li>
|
|
464
|
+
<li>Fixed a bug in <code>SpotifyClient.PlayerTransferPlayback</code> method that was causing play not to resume if <code>Play=True</code> and <code>forceActivateDevice=True</code>. If forceActivateDevice=True, then we need to resume play manually if play=True was specified; this is due to the device losing its current status since it was being forcefully activated (e.g. disconnected and reconnected).</li>
|
|
465
|
+
</ul>
|
|
466
|
+
|
|
467
|
+
<h6 id="10122-20241202">[ 1.0.122 ] - 2024/12/02</h6>
|
|
468
|
+
|
|
469
|
+
<ul>
|
|
470
|
+
<li>Updated <code>SpotifyClient</code> methods to return an exception due to the functions being deprecated by the Spotify development team. More information can be found on the <a href="https://developer.spotify.com/blog/2024-11-27-changes-to-the-web-api">Spotify Developer Forum Blog post</a> that was conveyed on November 27, 2024. The following methods will now raise a <code>SpotifyApiError</code> exception due to the Spotify development team changes: <code>GetArtistRelatedArtists</code>, <code>GetTrackRecommendations</code>, <code>GetTrackAudioFeatures</code>, <code>GetFeaturedPlaylists</code>, <code>GetCategoryPlaylists</code>, <code>GetGenres</code>. The following properties were also marked as deprecated for the same reason: <code>TrackSimplified.PreviewUrl</code>.</li>
|
|
471
|
+
<li>Due to the above chnages made by Spotify, any Algorithmic and Spotify-owned editorial playlists are no longer accessible or have more limited functionality. This means that you can no longer obtain details via the <code>SpotifyClient.GetPlaylist</code> and <code>SpotifyClient.GetPlaylistItems</code> methods for Spotify-owned / generated content (e.g. "Made For You", etc). A <code>404 - Not Found</code> error will be returned when trying to retrieve information for these playlist types.</li>
|
|
472
|
+
</ul>
|
|
473
|
+
|
|
474
|
+
<h6 id="10121-20241120">[ 1.0.121 ] - 2024/11/20</h6>
|
|
475
|
+
|
|
476
|
+
<ul>
|
|
477
|
+
<li>Updated <code>AuthTokenGenerator.py</code> sample code to correctly reference the token cache file.</li>
|
|
478
|
+
</ul>
|
|
479
|
+
|
|
480
|
+
<h6 id="10120-20241118">[ 1.0.120 ] - 2024/11/18</h6>
|
|
481
|
+
|
|
482
|
+
<ul>
|
|
483
|
+
<li>Updated <code>SpotifyClient.ReorderPlaylistItems</code> to validate required input parameters were supplied.</li>
|
|
484
|
+
<li>Updated <code>SpotifyClient.ReplacePlaylistItems</code> to check for no uris argument; this can occur if you want to clear the playlist.</li>
|
|
485
|
+
<li>Updated <code>SpotifyClient.GetPlaylistCoverImage</code> method to make the <code>playlistId</code> argument optional; if not supplied, the currently playing playlist id value is used instead.</li>
|
|
486
|
+
<li>Added <code>SpotifyClient.Version</code> property.</li>
|
|
487
|
+
</ul>
|
|
488
|
+
|
|
489
|
+
<h6 id="10119-20241115">[ 1.0.119 ] - 2024/11/15</h6>
|
|
490
|
+
|
|
491
|
+
<ul>
|
|
492
|
+
<li>Updated <code>TrackRecommendations</code> model to return empty arrays (instead of None) if seeds or tracks items were not found.</li>
|
|
493
|
+
</ul>
|
|
494
|
+
|
|
495
|
+
<h6 id="10118-20241107">[ 1.0.118 ] - 2024/11/07</h6>
|
|
496
|
+
|
|
497
|
+
<ul>
|
|
498
|
+
<li>Updated <code>SpotifyClient.GetArtistInfo</code> method to handle the <code>see more</code> suffix in the <code>BioHtml</code> property.</li>
|
|
499
|
+
<li>Updated <code>SpotifyClient.GetArtistInfo</code> method to correctly parse tour event dates.</li>
|
|
500
|
+
</ul>
|
|
501
|
+
|
|
502
|
+
<h6 id="10117-20241107">[ 1.0.117 ] - 2024/11/07</h6>
|
|
503
|
+
|
|
504
|
+
<ul>
|
|
505
|
+
<li>Updated <code>SpotifyClient.GetArtistInfo</code> method to force all links in the <code>BioHtml</code> property to open in a new browser window / tab (e.g. added <code>target="_blank"</code>).</li>
|
|
506
|
+
</ul>
|
|
507
|
+
|
|
508
|
+
<h6 id="10116-20241107">[ 1.0.116 ] - 2024/11/07</h6>
|
|
509
|
+
|
|
510
|
+
<ul>
|
|
511
|
+
<li>Updated <code>ArtistInfoTourEvent</code> model to include the concert link.</li>
|
|
512
|
+
<li>Fixed <code>SpotifyClient.GetArtistInfo</code> method to correctly parse Spotify artist info and tour events.</li>
|
|
513
|
+
</ul>
|
|
514
|
+
|
|
515
|
+
<h6 id="10115-20241104">[ 1.0.115 ] - 2024/11/04</h6>
|
|
516
|
+
|
|
517
|
+
<ul>
|
|
518
|
+
<li>Updated <code>PlayerQueueInfo</code> model to include the <code>DateLastRefreshed</code> property, which contains the date and time items were was last refreshed in unix epoch format (e.g. 1669123919.331225). A value of zero indicates the date was unknown. Note that this attribute does not exist in the Spotify Web API; it was added here for convenience.</li>
|
|
519
|
+
<li>Updated <code>Category</code> model to include the <code>Type</code> property, which contains a simulated data type. This is a helper property - no value with this name is returned from the Spotify Web API.</li>
|
|
520
|
+
<li>Updated <code>Category</code> model to add the <code>uri</code> and <code>type</code> values to data returned by the <code>ToDictionary</code> method.</li>
|
|
521
|
+
</ul>
|
|
522
|
+
|
|
523
|
+
<h6 id="10114-20241103">[ 1.0.114 ] - 2024/11/03</h6>
|
|
524
|
+
|
|
525
|
+
<ul>
|
|
526
|
+
<li>Added <code>sortResult</code> argument to the following <code>SpotifyClient</code> methods: <code>GetArtistRelatedArtists</code>, <code>GetArtistTopTracks</code>. If True (default), result items are sorted by name prior to returning to the caller; otherwise, results are left in the order that the Spotify Web API returned them.</li>
|
|
527
|
+
</ul>
|
|
528
|
+
|
|
529
|
+
<h6 id="10113-20241030">[ 1.0.113 ] - 2024/10/30</h6>
|
|
530
|
+
|
|
531
|
+
<ul>
|
|
532
|
+
<li>Updated <code>PlayerQueueInfo</code> model to remove repeated items when retrieving player queue information. For some reason, the Spotify Web API will return up to 10 duplicate items with the same information. For example: if there is only 1 item in the queue, then 10 duplicate items are returned by the Spotify Web API; if there are 5 items in the queue, then 5 duplicate items are returned by the Spotify Web API. We will check for this scenario, and only return non-duplicate items if so.</li>
|
|
533
|
+
<li>Updated <code>PageObject</code> model to include the <code>DateLastRefreshed</code> property, which contains the date and time items were was last refreshed in unix epoch format (e.g. 1669123919.331225). A value of zero indicates the date was unknown. Note that this attribute does not exist in the Spotify Web API; it was added here for convenience.</li>
|
|
534
|
+
<li>Added <code>SpotifyClient.AddPlayerQueueItems</code> method that will add one or more items to the end of the user's current playback queue. </li>
|
|
535
|
+
<li>Marked <code>SpotifyClient.AddPlayerQueueItem</code> method as deprecated; use the new <code>AddPlayerQueueItems</code> method instead.</li>
|
|
536
|
+
</ul>
|
|
537
|
+
|
|
538
|
+
<h6 id="10112-20241019">[ 1.0.112 ] - 2024/10/19</h6>
|
|
539
|
+
|
|
540
|
+
<ul>
|
|
541
|
+
<li>Updated <code>SpotifyClient.GetSpotifyConnectDevice</code> method to issue a slight delay after disconnecting the device. This should prevent <code>Getinformation</code> exceptions for devices that require a little bit of extra time after a Disconnect (e.g. zeroconf <code>resetUsers</code>) request in order to be ready for a Connect (e.g. zeroconf <code>addUser</code>) request.</li>
|
|
542
|
+
</ul>
|
|
543
|
+
|
|
544
|
+
<h6 id="10111-20241014">[ 1.0.111 ] - 2024/10/14</h6>
|
|
545
|
+
|
|
546
|
+
<ul>
|
|
547
|
+
<li>Updated <code>SpotifyClient.GetChapter</code> method to make the <code>chapterId</code> argument optional; if not supplied, the currently playing chapter id value is used instead.</li>
|
|
548
|
+
</ul>
|
|
549
|
+
|
|
550
|
+
<h6 id="10110-20241010">[ 1.0.110 ] - 2024/10/10</h6>
|
|
551
|
+
|
|
552
|
+
<ul>
|
|
553
|
+
<li>Updated <code>ImageObject.GetImageHighestResolution</code> method to account for null width values.</li>
|
|
554
|
+
</ul>
|
|
555
|
+
|
|
556
|
+
<h6 id="10109-20241010">[ 1.0.109 ] - 2024/10/10</h6>
|
|
557
|
+
|
|
558
|
+
<ul>
|
|
559
|
+
<li>Correctly Updated various methods that return an ImageUrl property to return the highest resolution image from the Images collection instead of the first image. For some reason, the Spotify Web API sets the first Images collection image to the lowest resolution (e.g. 64x64); for all other Images, the highest resolution image is listed first (e.g. 640x640).</li>
|
|
560
|
+
</ul>
|
|
561
|
+
|
|
562
|
+
<h6 id="10108-20241010">[ 1.0.108 ] - 2024/10/10</h6>
|
|
563
|
+
|
|
564
|
+
<ul>
|
|
565
|
+
<li>Updated various methods that return an ImageUrl property to return the highest resolution image from the Images collection instead of the first image. For some reason, the Spotify Web API sets the first Images collection image to the lowest resolution (e.g. 64x64); for all other Images, the highest resolution image is listed first (e.g. 640x640).</li>
|
|
566
|
+
</ul>
|
|
567
|
+
|
|
568
|
+
<h6 id="10107-20241009">[ 1.0.107 ] - 2024/10/09</h6>
|
|
569
|
+
|
|
570
|
+
<ul>
|
|
571
|
+
<li>Updated <code>SpotifyClient.RemoveShowFavorites</code> method to account for Spotify Web API changes to remove show favorites.</li>
|
|
572
|
+
<li>Updated <code>SpotifyClient.SaveShowFavorites</code> method to account for Spotify Web API changes to save show favorites.</li>
|
|
573
|
+
<li>Updated <code>SpotifyClient.CheckPlaylistFollowers</code> method to account for Spotify Web API changes to <code>userIds</code> argument, which is now deprecated. A single item list containing current user's Spotify Username must now be used.</li>
|
|
574
|
+
</ul>
|
|
575
|
+
|
|
576
|
+
<h6 id="10106-20241004">[ 1.0.106 ] - 2024/10/04</h6>
|
|
577
|
+
|
|
578
|
+
<ul>
|
|
579
|
+
<li>Fixed various python <code>SyntaxWarning: invalid escape sequence '\ '</code> warnings that were being generated when code was executed. Something changed with Home Assistant recently that turned these "used to be ignored" warnings into actual warnings that wind up in the HA System Log! This is due to invalid escaped characters in various string comments that are used for documentation purposes (e.g. """ this is a code comment """).</li>
|
|
580
|
+
</ul>
|
|
581
|
+
|
|
582
|
+
<h6 id="10105-20241004">[ 1.0.105 ] - 2024/10/04</h6>
|
|
583
|
+
|
|
584
|
+
<ul>
|
|
585
|
+
<li>Updated Spotify Connect device processing to only require the userid and password parameters when authenticating to devices that require user and password values. Some devices only require a loginid value (e.g. spotifyd, Spotify Connect AddOn, librespot, Sonos, etc). The user should not have to specify userid and password values if they are not required!</li>
|
|
586
|
+
<li>Cleaned up some documentation, as well as some of the code examples.</li>
|
|
587
|
+
</ul>
|
|
588
|
+
|
|
589
|
+
<h6 id="10104-20241003">[ 1.0.104 ] - 2024/10/03</h6>
|
|
590
|
+
|
|
591
|
+
<ul>
|
|
592
|
+
<li>Updated <code>SpotifyClient.PlayerMediaSeek</code> method to change the <code>progressMS</code> check to <code><= 0</code> when invoking relative positioning.</li>
|
|
593
|
+
</ul>
|
|
594
|
+
|
|
595
|
+
<h6 id="10103-20241003">[ 1.0.103 ] - 2024/10/03</h6>
|
|
596
|
+
|
|
597
|
+
<ul>
|
|
598
|
+
<li>Updated <code>SpotifyClient.PlayerMediaSeek</code> method to add relative positioning capability. This allows you to seek ahead / behind by a specified <code>relativePositionMS</code> positioning amount. The <code>positionMS</code> argument must be zero to enable this functionality. Note that the relative position functionality is not defined by the Spotify Web API. The functionality was added to this API to support "skip" seeking.</li>
|
|
599
|
+
</ul>
|
|
600
|
+
|
|
601
|
+
<h6 id="10102-20240929">[ 1.0.102 ] - 2024/09/29</h6>
|
|
602
|
+
|
|
603
|
+
<ul>
|
|
604
|
+
<li>Updated <code>SpotifyClient.GetShowFavorites</code> method to only return podcast show items by default. Prior to this fix, it was returning both audiobook and podcast shows. The new <code>excludeAudiobooks</code> argument allows you to return both audiobook and podcast shows (default returned by Spotify Web API).</li>
|
|
605
|
+
</ul>
|
|
606
|
+
|
|
607
|
+
<h6 id="10101-20240928">[ 1.0.101 ] - 2024/09/28</h6>
|
|
608
|
+
|
|
609
|
+
<ul>
|
|
610
|
+
<li>Updated <code>ZeroconfConnect.Connect</code> method to load authorization credentials for the Spotify Connect <code>addUser</code> blob from a <code>credentials.json</code> file for devices that utilize librespot / spotifyd. Spotify no longer supports uername / password authentication via librespot (always returns "Bad Credentials" exceptions. This allows the librespot <code>credentials.json</code> file to be copied to the spotifywebapiPython storage folder, and used for calls to the librespot <code>addUser</code> zeroconf endpoint.</li>
|
|
611
|
+
<li>Updated <code>SpotifyClient.GetSpotifyConnectDevice</code> and <code>PlayerActivateDevices</code> methods to bypass the call to Spotify Connect Zeroconf Disconnect for devices that utilize librespot / spotifyd. librespot does not implement the Spotify Connect Zeroconf <code>resetUsers</code> endpoint, so the request always fails with a 404.</li>
|
|
612
|
+
</ul>
|
|
613
|
+
|
|
614
|
+
<h6 id="10100-20240926">[ 1.0.100 ] - 2024/09/26</h6>
|
|
615
|
+
|
|
616
|
+
<ul>
|
|
617
|
+
<li>Updated <code>SpotifyClient.GetSpotifyConnectDevice</code> method to force a Spotify Connect Disconnect call to the device if <code>activateDevice</code> argument is <code>True</code>. The <code>verifyUserContext</code> argument is deprecated as well. This was necessary, as Spotify Connect device manufacturers do not use the Spotify Connect Zeroconf Information <code>ActiveUser</code> property consistently.</li>
|
|
618
|
+
<li>Added <code>PlayerTransferPlayback.forceActivateDevice</code> argument that allows you to force activate the Spotify Connect device as part of the transfer of playback.</li>
|
|
619
|
+
</ul>
|
|
620
|
+
|
|
621
|
+
<h6 id="1099-20240924">[ 1.0.99 ] - 2024/09/24</h6>
|
|
622
|
+
|
|
623
|
+
<ul>
|
|
624
|
+
<li>Added <code>PlayerPlayState.ItemType</code> property that denotes the type of episode being played: <code>podcast</code> or <code>audiobook</code>. This property is only loaded when the <code>SpotifyClient</code> <code>GetPlayerNowPlaying</code> or <code>GetPlayerPlaybackState</code> method is called with <code>additionalTypes='episode'</code>.</li>
|
|
625
|
+
</ul>
|
|
626
|
+
|
|
627
|
+
<h6 id="1098-20240924">[ 1.0.98 ] - 2024/09/24</h6>
|
|
628
|
+
|
|
629
|
+
<ul>
|
|
630
|
+
<li>Added <code>SpotifyClient.IsAudiobookEpisode</code> method that returns true if the specified episode id is an audiobook chapter; otherwise, false. This allows you to programatically determine the difference between a podcast / show episode, and an audiobook episode.</li>
|
|
631
|
+
</ul>
|
|
632
|
+
|
|
633
|
+
<h6 id="1097-20240920">[ 1.0.97 ] - 2024/09/20</h6>
|
|
634
|
+
|
|
635
|
+
<ul>
|
|
636
|
+
<li>Updated <code>ZeroconfGetInfoAlias</code> to fix a bug related to Spotify Connect devices that define aliases (introduced with v1.0.93). This was causing <code>TypeError: unsupported operand type(s) for &: 'str' and 'tuple'</code> exceptions if a device had aliases defined.</li>
|
|
637
|
+
</ul>
|
|
638
|
+
|
|
639
|
+
<h6 id="1096-20240919">[ 1.0.96 ] - 2024/09/19</h6>
|
|
640
|
+
|
|
641
|
+
<ul>
|
|
642
|
+
<li>Added defensive code in various parsers to account for the Spotify Web API returning an invalid / incomplete object. This was noticed with the <code>GetAlbumFavorites</code> method, but also applied to other models that inherited from PageObject.</li>
|
|
643
|
+
</ul>
|
|
644
|
+
|
|
645
|
+
<h6 id="1095-20240912">[ 1.0.95 ] - 2024/09/12</h6>
|
|
646
|
+
|
|
647
|
+
<ul>
|
|
648
|
+
<li>Added <code>image_url</code> attribute value to all models that support a <code>ToDictionary()</code> method (some that were previously missed in 1.0.94 release).</li>
|
|
649
|
+
</ul>
|
|
650
|
+
|
|
651
|
+
<h6 id="1094-20240912">[ 1.0.94 ] - 2024/09/12</h6>
|
|
652
|
+
|
|
653
|
+
<ul>
|
|
654
|
+
<li>Added <code>image_url</code> attribute value to all models that support a <code>ToDictionary()</code> method.</li>
|
|
655
|
+
<li>Miscellaneous documentation updates.</li>
|
|
656
|
+
</ul>
|
|
657
|
+
|
|
658
|
+
<h6 id="1093-20240910">[ 1.0.93 ] - 2024/09/10</h6>
|
|
659
|
+
|
|
660
|
+
<ul>
|
|
661
|
+
<li>Updated <code>SpotifyClient.GetAlbumFavorites</code> method to correctly sort results based upon the <code>sortResult</code> argument setting; true to sort by name ascending, false to sort by AddedAt descending.</li>
|
|
662
|
+
<li>Updated <code>SpotifyClient.GetEpisodeFavorites</code> method to correctly sort results based upon the <code>sortResult</code> argument setting; true to sort by name ascending, false to sort by AddedAt descending.</li>
|
|
663
|
+
<li>Updated <code>SpotifyClient.GetShowFavorites</code> method to correctly sort results based upon the <code>sortResult</code> argument setting; true to sort by name ascending, false to sort by AddedAt descending.</li>
|
|
664
|
+
<li>Updated <code>SpotifyClient.GetTrackFavorites</code> method to correctly sort results based upon the <code>sortResult</code> argument setting; true to sort by name ascending, false to sort by AddedAt descending.</li>
|
|
665
|
+
</ul>
|
|
666
|
+
|
|
667
|
+
<h6 id="1092-20240823">[ 1.0.92 ] - 2024/08/23</h6>
|
|
668
|
+
|
|
669
|
+
<ul>
|
|
670
|
+
<li>Updated <code>SpotifyClient.FollowPlaylist</code> method to make the <code>playlistId</code> argument optional; if not supplied, the currently playing playlist id value is used instead.</li>
|
|
671
|
+
<li>Updated <code>SpotifyClient.GetAlbum</code> method to make the <code>albumId</code> argument optional; if not supplied, the currently playing album id value is used instead.</li>
|
|
672
|
+
<li>Updated <code>SpotifyClient.GetAlbumTracks</code> method to make the <code>albumId</code> argument optional; if not supplied, the currently playing album id value is used instead.</li>
|
|
673
|
+
<li>Updated <code>SpotifyClient.GetArtist</code> method to make the <code>artistId</code> argument optional; if not supplied, the currently playing artist id value is used instead.</li>
|
|
674
|
+
<li>Updated <code>SpotifyClient.GetArtistAlbums</code> method to make the <code>artistId</code> argument optional; if not supplied, the currently playing artist id value is used instead.</li>
|
|
675
|
+
<li>Updated <code>SpotifyClient.GetArtistInfo</code> method to make the <code>artistId</code> argument optional; if not supplied, the currently playing artist id value is used instead.</li>
|
|
676
|
+
<li>Updated <code>SpotifyClient.GetArtistRelatedArtists</code> method to make the <code>artistId</code> argument optional; if not supplied, the currently playing artist id value is used instead.</li>
|
|
677
|
+
<li>Updated <code>SpotifyClient.GetArtistTopTracks</code> method to make the <code>artistId</code> argument optional; if not supplied, the currently playing artist id value is used instead.</li>
|
|
678
|
+
<li>Updated <code>SpotifyClient.GetAudiobook</code> method to make the <code>audiobookId</code> argument optional; if not supplied, the currently playing audiobook id value is used instead.</li>
|
|
679
|
+
<li>Updated <code>SpotifyClient.GetAudiobookChapters</code> method to make the <code>audiobookId</code> argument optional; if not supplied, the currently playing audiobook id value is used instead.</li>
|
|
680
|
+
<li>Updated <code>SpotifyClient.GetEpisode</code> method to make the <code>episodeId</code> argument optional; if not supplied, the currently playing episode id value is used instead.</li>
|
|
681
|
+
<li>Updated <code>SpotifyClient.GetPlaylist</code> method to make the <code>playlistId</code> argument optional; if not supplied, the currently playing playlist id value is used instead.</li>
|
|
682
|
+
<li>Updated <code>SpotifyClient.GetPlaylistItems</code> method to make the <code>playlistId</code> argument optional; if not supplied, the currently playing playlist id value is used instead.</li>
|
|
683
|
+
<li>Updated <code>SpotifyClient.GetShow</code> method to make the <code>showId</code> argument optional; if not supplied, the currently playing show id value is used instead.</li>
|
|
684
|
+
<li>Updated <code>SpotifyClient.GetShowEpisodes</code> method to make the <code>showId</code> argument optional; if not supplied, the currently playing show id value is used instead.</li>
|
|
685
|
+
<li>Updated <code>SpotifyClient.GetTrack</code> method to make the <code>trackId</code> argument optional; if not supplied, the currently playing track id value is used instead.</li>
|
|
686
|
+
<li>Updated <code>SpotifyClient.GetTrackAudioFeatures</code> method to make the <code>trackId</code> argument optional; if not supplied, the currently playing track id value is used instead.</li>
|
|
687
|
+
<li>Updated <code>SpotifyClient.UnfollowPlaylist</code> method to make the <code>playlistId</code> argument optional; if not supplied, the currently playing playlist id value is used instead.</li>
|
|
688
|
+
</ul>
|
|
689
|
+
|
|
690
|
+
<h6 id="1091-20240822">[ 1.0.91 ] - 2024/08/22</h6>
|
|
691
|
+
|
|
692
|
+
<ul>
|
|
693
|
+
<li>Updated <code>CheckTrackFavorites</code>, <code>RemoveTrackFavorites</code>, and <code>SaveTrackFavorites</code> methods to ensure that nowplaying item was a track and not an episode item.</li>
|
|
694
|
+
</ul>
|
|
695
|
+
|
|
696
|
+
<h6 id="1090-20240822">[ 1.0.90 ] - 2024/08/22</h6>
|
|
697
|
+
|
|
698
|
+
<ul>
|
|
699
|
+
<li>Updated various methods to not log handled exception data as unhandled exceptions.</li>
|
|
700
|
+
</ul>
|
|
701
|
+
|
|
702
|
+
<h6 id="1089-20240822">[ 1.0.89 ] - 2024/08/22</h6>
|
|
703
|
+
|
|
704
|
+
<ul>
|
|
705
|
+
<li>Updated <code>SpotifyClient.CheckAlbumFavorites</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing album id value is used instead.</li>
|
|
706
|
+
<li>Updated <code>SpotifyClient.CheckArtistsFollowing</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing artist id value is used instead.</li>
|
|
707
|
+
<li>Updated <code>SpotifyClient.CheckAudiobookFavorites</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing audiobook id value is used instead.</li>
|
|
708
|
+
<li>Updated <code>SpotifyClient.CheckEpisodeFavorites</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing episode id value is used instead.</li>
|
|
709
|
+
<li>Updated <code>SpotifyClient.CheckShowFavorites</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing show id value is used instead.</li>
|
|
710
|
+
<li>Updated <code>SpotifyClient.CheckTrackFavorites</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing track id value is used instead.</li>
|
|
711
|
+
</ul>
|
|
712
|
+
|
|
713
|
+
<h6 id="1088-20240820">[ 1.0.88 ] - 2024/08/20</h6>
|
|
714
|
+
|
|
715
|
+
<ul>
|
|
716
|
+
<li>Updated <code>SpotifyClient.DefaultDeviceId</code> property to setter to account for empty string values.</li>
|
|
717
|
+
</ul>
|
|
718
|
+
|
|
719
|
+
<h6 id="1087-20240820">[ 1.0.87 ] - 2024/08/20</h6>
|
|
720
|
+
|
|
721
|
+
<ul>
|
|
722
|
+
<li>Added <code>SpotifyClient.DefaultDeviceId</code> property to get / set the default device id (or name) to use for player transport methods (e.g. play, pause, skip, etc) that do not specify a device id and there is no active Spotify player detected (e.g. "Office", "5d4931f9d0684b625d702eaa24137b2c1d99539c", etc). This should avoid the <code>No Active Device</code> exceptions returned from the Spotify Web API when playback transport methods are called after long pauses of inactivity.</li>
|
|
723
|
+
</ul>
|
|
724
|
+
|
|
725
|
+
<h6 id="1086-20240819">[ 1.0.86 ] - 2024/08/19</h6>
|
|
726
|
+
|
|
727
|
+
<ul>
|
|
728
|
+
<li>Updated <code>SpotifyClient</code>, <code>ZeroconfConnect</code>, and <code>AuthClient</code> class constructors to include the <code>tokenStorageFile</code> argument that specifies the filename and extension of the authorization Token Cache file. This is used for Spotify Connect devices that utilize the <code>authorization_code</code> token type.</li>
|
|
729
|
+
</ul>
|
|
730
|
+
|
|
731
|
+
<h6 id="1085-20240819">[ 1.0.85 ] - 2024/08/19</h6>
|
|
732
|
+
|
|
733
|
+
<ul>
|
|
734
|
+
<li>Updated <code>SpotifyClient.RemoveAudiobookFavorites</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing audiobook id value is used instead.</li>
|
|
735
|
+
<li>Updated <code>SpotifyClient.RemoveEpisodeFavorites</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing episode id value is used instead.</li>
|
|
736
|
+
<li>Updated <code>SpotifyClient.RemoveShowFavorites</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing show id value is used instead.</li>
|
|
737
|
+
<li>Updated <code>SpotifyClient.SaveAudiobookFavorites</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing audiobook id value is used instead.</li>
|
|
738
|
+
<li>Updated <code>SpotifyClient.SaveEpisodeFavorites</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing episode id value is used instead.</li>
|
|
739
|
+
<li>Updated <code>SpotifyClient.SaveShowFavorites</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing show id value is used instead.</li>
|
|
740
|
+
</ul>
|
|
741
|
+
|
|
742
|
+
<h6 id="1084-20240818">[ 1.0.84 ] - 2024/08/18</h6>
|
|
743
|
+
|
|
744
|
+
<ul>
|
|
745
|
+
<li>Updated <code>SpotifyClient.PlayerTransferPlayback</code> method to default the <code>refreshDeviceList</code> argument to True so that the Spotify Connect device list is refreshed by default before transferring playback.</li>
|
|
746
|
+
<li>Updated <code>ZeroconfConnect</code> methods to use <code>connection:close</code> headers for requests to the Spotify Connect Zeroconf API endpoints.</li>
|
|
747
|
+
</ul>
|
|
748
|
+
|
|
749
|
+
<h6 id="1083-20240815">[ 1.0.83 ] - 2024/08/15</h6>
|
|
750
|
+
|
|
751
|
+
<ul>
|
|
752
|
+
<li>Updated <code>SpotifyClient.GetSpotifyConnectDevice</code> method to check if a Spotify Desktop Client Application OAuth2 token exists when a PlayerTransfer targets a Sonos device. If not found, then control will be transferred to the Sonos device using it's local queue; if found, then Spotify Connect will reconnect to the device and control will be transferred to the Sonos device using Spotify Connect.</li>
|
|
753
|
+
</ul>
|
|
754
|
+
|
|
755
|
+
<h6 id="1082-20240815">[ 1.0.82 ] - 2024/08/15</h6>
|
|
756
|
+
|
|
757
|
+
<ul>
|
|
758
|
+
<li>Updated <code>SpotifyClient.GetSpotifyConnectDevice</code> method to get real-time information for some portions of the device info for devices detected by zeroconf discovery (non-dynamic), even when using the cache. Prior to this fix, transfer of playback failed for dynamic devices (web player, mobile app player, etc).</li>
|
|
759
|
+
</ul>
|
|
760
|
+
|
|
761
|
+
<h6 id="1081-20240815">[ 1.0.81 ] - 2024/08/15</h6>
|
|
762
|
+
|
|
763
|
+
<ul>
|
|
764
|
+
<li>Updated <code>SpotifyClient.GetSpotifyConnectDevice</code> method to get real-time information for some portions of the device info, even when using the cache. Prior to this, stale information was being used that had been updated since the last cache update.</li>
|
|
765
|
+
</ul>
|
|
766
|
+
|
|
767
|
+
<h6 id="1080-20240815">[ 1.0.80 ] - 2024/08/15</h6>
|
|
768
|
+
|
|
769
|
+
<ul>
|
|
770
|
+
<li>Added <code>SpotifyClient.GetSpotifyConnectDevice</code> method that will get information about a specific Spotify Connect player device, and (optionally) activate the device if it requires it.</li>
|
|
771
|
+
<li>Marked the <code>SpotifyClient.PlayerResolveDeviceId</code> method as deprecated, and it will be removed in a future release; use the <code>GetSpotifyConnectDevice</code> instead.</li>
|
|
772
|
+
<li>Removed <code>SpotifyClient.PlayerTransferPlayback</code> method argument <code>resolveDeviceId</code> as it is no longer used.</li>
|
|
773
|
+
<li>Added <code>SpotifyClient.PlayerTransferPlayback</code> method argument <code>refreshDeviceList</code> to refresh the Spotify Connect device list (True) or use the Spotify Connect device list cache (False) when resolving a Spotify Connect device value.</li>
|
|
774
|
+
</ul>
|
|
775
|
+
|
|
776
|
+
<h6 id="1079-20240813">[ 1.0.79 ] - 2024/08/13</h6>
|
|
777
|
+
|
|
778
|
+
<ul>
|
|
779
|
+
<li>Updated <code>ZeroconfConnect._GetSpotifyConnectAuthorizationCodeToken</code> method to raise an exception if the Spotify Client Application authorization access token could not be found. Prior logic was causing the process to wait for a user response to a token authorization request, which would never happen since the process was running on a server.</li>
|
|
780
|
+
</ul>
|
|
781
|
+
|
|
782
|
+
<h6 id="1078-20240812">[ 1.0.78 ] - 2024/08/12</h6>
|
|
783
|
+
|
|
784
|
+
<ul>
|
|
785
|
+
<li>Updated <code>ZeroconfConnect</code> class constructor to include the <code>tokenStorageDir</code> argument that specified the directory path that will contain the <code>tokens.json</code> cache file. This is used for Spotify Connect devices that utilize the <code>authorization_code</code> token type.</li>
|
|
786
|
+
</ul>
|
|
787
|
+
|
|
788
|
+
<h6 id="1077-20240812">[ 1.0.77 ] - 2024/08/12</h6>
|
|
789
|
+
|
|
790
|
+
<ul>
|
|
791
|
+
<li>Updated <code>AuthClient.AuthorizeWithServer</code> method to specify a redirect uri with host, port, and path values. Prior code was only allowing a redirect uri with host and port values.</li>
|
|
792
|
+
<li>Added <code>SpotifyClient.SetAuthTokenAuthorizationCode</code> method argument <code>redirectUriPath</code> to allow a redirect_uri path value to be specified for OAuth authorization requests.</li>
|
|
793
|
+
<li>Added <code>SpotifyClient.SetAuthTokenAuthorizationCodePKCE</code> method argument <code>redirectUriPath</code> to allow a redirect_uri path value to be specified for OAuth authorization requests.</li>
|
|
794
|
+
<li>Updated <code>ZeronconfConnect</code> class to correctly process Spotify Connect requests for token type <code>authorization_code</code> devices.</li>
|
|
795
|
+
<li>Updated <code>SpotifyClient.PlayerMediaPlayTrackFavorites</code> method to add the <code>limitTotal</code> argument that limits the number of tracks retrieved from favorites.</li>
|
|
796
|
+
<li>Added <code>sortResult</code> argument to the following <code>SpotifyClient</code> methods: <code>GetAlbumFavorites</code>, <code>GetAlbumNewReleases</code>, <code>GetArtistAlbums</code>, <code>GetArtistsFollowed</code>, <code>GetAudiobookFavorites</code>, <code>GetBrowseCategorys</code>, <code>GetCategoryPlaylists</code>, <code>GetEpisodeFavorites</code>, <code>GetFeaturedPlaylists</code>, <code>GetPlayerDevices</code>, <code>GetPlaylistFavorites</code>, <code>GetPlaylistsForUser</code>, <code>GetShowFavorites</code>, <code>GetSpotifyConnectDevices</code>, <code>GetTrackFavorites</code>, <code>GetUsersTopArtists</code>, <code>GetUsersTopTracks</code>. If True (default), result items are sorted by name prior to returning to the caller; otherwise, results are left in the order that the Spotify Web API returned them.</li>
|
|
797
|
+
</ul>
|
|
798
|
+
|
|
799
|
+
<h6 id="1076-20240718">[ 1.0.76 ] - 2024/07/18</h6>
|
|
800
|
+
|
|
801
|
+
<ul>
|
|
802
|
+
<li>Updated <code>ZeroconfConnect</code> class to remove some test code that was accidentally left in place for tokentype <code>authorization_code</code> research.</li>
|
|
803
|
+
</ul>
|
|
804
|
+
|
|
805
|
+
<h6 id="1075-20240717">[ 1.0.75 ] - 2024/07/17</h6>
|
|
806
|
+
|
|
807
|
+
<ul>
|
|
808
|
+
<li>Updated <code>PlayerPlayState.ShuffleState</code> method to return a boolean True or False value to account for changes to underlying Spotify Web API.</li>
|
|
809
|
+
<li>Updated <code>PlayerPlayState.SmartShuffle</code> method to return a boolean True or False value to account for changes to underlying Spotify Web API.</li>
|
|
810
|
+
</ul>
|
|
811
|
+
|
|
812
|
+
<h6 id="1074-20240715">[ 1.0.74 ] - 2024/07/15</h6>
|
|
813
|
+
|
|
814
|
+
<ul>
|
|
815
|
+
<li>Added <code>SpotifyConnectDevices.GetDeviceById</code> method to return a <code>SpotifyConnectDevice</code> instance if the collection contains the specified device id value; otherwise, None.</li>
|
|
816
|
+
<li>Added <code>SpotifyConnectDevices.GetDeviceByName</code> method to return a <code>SpotifyConnectDevice</code> instance if the collection contains the specified device name value; otherwise, None.</li>
|
|
817
|
+
<li>Updated <code>ZeroconfConnect</code> class to use a '2.7.1' version indicator if no version argument was specified on the class contructor.</li>
|
|
818
|
+
<li>Updated <code>ZeroconfConnect.Disconnect</code> to check for an invalid JSON response. It has been found that some devices (Sonos, etc) do not return a proper JSON response for the <code>resetUsers</code> action. If a JSON response was not returned, then it will treat the http status code as the response code; if it's not a 200, then it will raise an exception.</li>
|
|
819
|
+
<li>Updated <code>SpotifyClient.PlayerResolveDeviceId</code> method to not switch the active user context for Sonos devices. Sonos devices are restricted, and (currently) cannot be controlled by the Spotify Web-Services API player methods.</li>
|
|
820
|
+
</ul>
|
|
821
|
+
|
|
822
|
+
<h6 id="1073-20240702">[ 1.0.73 ] - 2024/07/02</h6>
|
|
823
|
+
|
|
824
|
+
<ul>
|
|
825
|
+
<li>Updated <code>SpotifyClient.GetSpotifyConnectDevices</code> to gracefully handle device unavailable scenarios. It will try to reach the device by its direct HostIpAddress first; if that fails, then it will try to reach the device by its Server alias; if that fails, then it will log a warning that the device could not be reached and press on.</li>
|
|
826
|
+
<li>Updated <code>ZeroconfConnect.Disconnect</code> to check for an invalid JSON response. It has been found that some devices (Sonos, etc) do not return a proper JSON response for the <code>resetUsers</code> action. If a JSON response was not returned, then it will treat the http status code as the response code; if it's not a 200, then it will raise an exception.</li>
|
|
827
|
+
<li>Updated <code>BlobBuilder</code> methods to add tracing of blob data contents.</li>
|
|
828
|
+
</ul>
|
|
829
|
+
|
|
830
|
+
<h6 id="1072-20240628">[ 1.0.72 ] - 2024/06/28</h6>
|
|
831
|
+
|
|
832
|
+
<ul>
|
|
833
|
+
<li>Updated <code>ZeroconfConnect.Connect</code> method to handle the <code>authorization_code</code> token type for Zeroconf API <code>addUser</code> requests.</li>
|
|
834
|
+
</ul>
|
|
835
|
+
|
|
836
|
+
<h6 id="1071-20240627">[ 1.0.71 ] - 2024/06/27</h6>
|
|
837
|
+
|
|
838
|
+
<ul>
|
|
839
|
+
<li>Updated <code>ZeroconfConnect.Connect</code> method to properly return the response data from the <code>addUser</code> request and process the results.</li>
|
|
840
|
+
</ul>
|
|
841
|
+
|
|
842
|
+
<h6 id="1070-20240627">[ 1.0.70 ] - 2024/06/27</h6>
|
|
843
|
+
|
|
844
|
+
<ul>
|
|
845
|
+
<li>Updated <code>ZeroconfConnect.Connect</code> method to properly wait for device to become fully availabile if need be.</li>
|
|
846
|
+
</ul>
|
|
847
|
+
|
|
848
|
+
<h6 id="1069-20240626">[ 1.0.69 ] - 2024/06/26</h6>
|
|
849
|
+
|
|
850
|
+
<ul>
|
|
851
|
+
<li>Added properties and arguments to support the Zeroconf API <code>loginId</code> argument for the <code>addUser</code> request.</li>
|
|
852
|
+
<li>Updated <code>ZeroconfConnect.Connect</code> method to include the <code>deviceName</code> and <code>deviceId</code> keys for the <code>addUser</code> request for certain device manufacturer conditions.</li>
|
|
853
|
+
<li>Updated <code>ZeroconfConnect.Connect</code> method to not issue a Disconnect to reset the user context if the public key value is "INVALID", as the logic did not work as expected.</li>
|
|
854
|
+
</ul>
|
|
855
|
+
|
|
856
|
+
<h6 id="1068-20240626">[ 1.0.68 ] - 2024/06/26</h6>
|
|
857
|
+
|
|
858
|
+
<ul>
|
|
859
|
+
<li>Updated <code>ZeroconfConnect._CheckResponseForErrors</code> method to not process the Spotify Zeroconf API response, as each method calling the check response method will process the returned status.</li>
|
|
860
|
+
</ul>
|
|
861
|
+
|
|
862
|
+
<h6 id="1067-20240625">[ 1.0.67 ] - 2024/06/25</h6>
|
|
863
|
+
|
|
864
|
+
<ul>
|
|
865
|
+
<li>Updated <code>SpotifyClient.IsDeviceId</code> class to recognize UUID-formatted device id's (e.g. "48b677ca-ef9b-516f-b702-93bf2e8c67ba").</li>
|
|
866
|
+
<li>Updated <code>ZeroconfConnect</code> class to not default the <code>version</code> value to <code>1.0</code>, in the event that newer devices may not support that version identifier.</li>
|
|
867
|
+
<li>Updated <code>ZeroconfConnect.Connect</code> method to not pass the <code>loginId</code> parameter to the request.</li>
|
|
868
|
+
<li>Updated <code>ZeroconfConnect.Connect</code> method to issue a Disconnect to reset the user context if the public key value is "INVALID".</li>
|
|
869
|
+
</ul>
|
|
870
|
+
|
|
871
|
+
<h6 id="1066-20240625">[ 1.0.66 ] - 2024/06/25</h6>
|
|
872
|
+
|
|
873
|
+
<ul>
|
|
874
|
+
<li>Updated <code>ZeroconfResponse</code> class to convert the <code>status</code> and <code>spotifyError</code> values to numeric from string. Some Spotify Connect devices return them as strings, while other return them as numerics. </li>
|
|
875
|
+
</ul>
|
|
876
|
+
|
|
877
|
+
<h6 id="1065-20240625">[ 1.0.65 ] - 2024/06/25</h6>
|
|
878
|
+
|
|
879
|
+
<ul>
|
|
880
|
+
<li>Updated <code>ZeroconfConnect.Connect</code> method to account for "ERROR-INVALID-PUBLICKEY" statuses returned for some devices. This will retry the connection request with the PublicKey value returned from the initial request.</li>
|
|
881
|
+
</ul>
|
|
882
|
+
|
|
883
|
+
<h6 id="1064-20240624">[ 1.0.64 ] - 2024/06/24</h6>
|
|
884
|
+
|
|
885
|
+
<ul>
|
|
886
|
+
<li>Updated <code>SpotifyClient.GetSpotifyConnectDevices</code> method to correctly set the currently active device.</li>
|
|
887
|
+
</ul>
|
|
888
|
+
|
|
889
|
+
<h6 id="1063-20240624">[ 1.0.63 ] - 2024/06/24</h6>
|
|
890
|
+
|
|
891
|
+
<ul>
|
|
892
|
+
<li>Updated <code>ZeroconfConnect</code> class to process the Spotify Zeroconf API status code from the JSON response instead of processing the HTTP request status code. It has been found that some Spotify Connect manufacturers return different HTTP status codes than other manufacturers; but the Spotify Connect <code>status</code>, <code>statusString</code> and <code>spotifyError</code> JSON properties seem to be consistent across the board.</li>
|
|
893
|
+
<li>Updated <code>SpotifyClient.GetSpotifyConnectDevices</code> method to filter out duplicate Spotify Connect Device entries for devices that have been grouped together. For example, the "Bose-ST10-1" and "Bose-ST10-2" are grouped as a stereo pair; there will be two Zeroconf discovery result entries with different instance names, but their Zeroconf getInfo endpoint url will be the same. When this happens, it causes the values to show up as duplicates if we process both of them.</li>
|
|
894
|
+
</ul>
|
|
895
|
+
|
|
896
|
+
<h6 id="1062-20240621">[ 1.0.62 ] - 2024/06/21</h6>
|
|
897
|
+
|
|
898
|
+
<ul>
|
|
899
|
+
<li>Updated <code>SpotifyDiscovery.DiscoverDevices</code> method to properly free Zeroconf resources after service discovery, and prevent possible memory leaks and crashes due to running out of resources.</li>
|
|
900
|
+
</ul>
|
|
901
|
+
|
|
902
|
+
<h6 id="1061-20240621">[ 1.0.61 ] - 2024/06/21</h6>
|
|
903
|
+
|
|
904
|
+
<ul>
|
|
905
|
+
<li>Added <code>ZeroconfGetInfo.IsInDeviceList</code> property that returns the status of active device list verification process (Verification not Performed, Verified Active, Verified Inactive). </li>
|
|
906
|
+
</ul>
|
|
907
|
+
|
|
908
|
+
<h6 id="1060-20240621">[ 1.0.60 ] - 2024/06/21</h6>
|
|
909
|
+
|
|
910
|
+
<ul>
|
|
911
|
+
<li>Updated <code>ZeroconfConnect</code> class to process all responses as JSON responses. It was found that some Spotify Zeroconf API capable devices were not properly setting the <code>Content-Type</code> in the returned http response header.</li>
|
|
912
|
+
<li>Updated <code>SpotifyDiscovery</code> class to process the individual Spotify Connect instance names that were discovered via Zeroconf. Prior logic was adding a device for every IPV4 address that was found for an instance, assuming that each instance only contained one IP address; some services contain multiple IP addressess for the same instance name (specifically, the <code>SpotifyConnect</code> add-on, which runs in a docker container).</li>
|
|
913
|
+
<li>Updated <code>SpotifyDiscovery</code> class to rename the <code>HostIpv4Address</code> property (and method arguments) to <code>HostIpAddress</code>. The address specified in this argument can be an IP address (e.g. "192.168.1.81") or an alias (e.g. "bose.speaker.kitchen").</li>
|
|
914
|
+
<li>Updated <code>ZeroconfConnect</code> class to rename the <code>HostIpv4Address</code> property (and method arguments) to <code>HostIpAddress</code>. The address specified in this argument can be an IP address (e.g. "192.168.1.81") or an alias (e.g. "bose.speaker.kitchen").</li>
|
|
915
|
+
<li>Updated various <code>SpotifyClient</code> methods to utilize the default <code>HostIpAddress</code> (or <code>Server</code> value if default <code>HostIpAddress</code> was not discovered) when connecting to a Spotify Connect capable device. Methods updated were: <code>PlayerActivateDevices</code>, <code>GetSpotifyConnectDevices</code>, <code>PlayerResolveDeviceId</code>.</li>
|
|
916
|
+
</ul>
|
|
917
|
+
|
|
918
|
+
<h6 id="1059-20240619">[ 1.0.59 ] - 2024/06/19</h6>
|
|
919
|
+
|
|
920
|
+
<ul>
|
|
921
|
+
<li>Updated <code>SpotifyClient</code> methods that call <code>PlayerResolveDeviceId</code> with a new parameter that indicates if the device should be resolved (true) or not (False). This allows multiple methods that call <code>PlayerResolveDeviceId</code> to be called from the same method, and only resolve the device one time. This was sone to ensure that device resolution did not occur more than once, as it's such a time consuming operation. Methods updated were: <code>PlayerMediaPlayContext</code>, <code>PlayerMediaPlayTrackFavorites</code>, <code>PlayerMediaPlayTracks</code>, <code>PlayerTransferPlayback</code>.</li>
|
|
922
|
+
</ul>
|
|
923
|
+
|
|
924
|
+
<h6 id="1058-20240619">[ 1.0.58 ] - 2024/06/19</h6>
|
|
925
|
+
|
|
926
|
+
<ul>
|
|
927
|
+
<li>Updated <code>SpotifyClient.PlayerResolveDeviceId</code> method callers to log a warning message if the specified device value could not be resolved and just return a null value.</li>
|
|
928
|
+
</ul>
|
|
929
|
+
|
|
930
|
+
<h6 id="1057-20240619">[ 1.0.57 ] - 2024/06/19</h6>
|
|
931
|
+
|
|
932
|
+
<ul>
|
|
933
|
+
<li>Updated <code>SpotifyClient.PlayerResolveDeviceId</code> method callers to gracefully handle the <code>SpotifyApiError</code> error if the specified device value could not be resolved.</li>
|
|
934
|
+
</ul>
|
|
935
|
+
|
|
936
|
+
<h6 id="1056-20240619">[ 1.0.56 ] - 2024/06/19</h6>
|
|
937
|
+
|
|
938
|
+
<ul>
|
|
939
|
+
<li>Updated <code>SpotifyClient.PlayerResolveDeviceId</code> method to raise a <code>SpotifyApiError</code> error if the specified device value could not be resolved.</li>
|
|
940
|
+
</ul>
|
|
941
|
+
|
|
942
|
+
<h6 id="1055-20240619">[ 1.0.55 ] - 2024/06/19</h6>
|
|
943
|
+
|
|
944
|
+
<ul>
|
|
945
|
+
<li>Updated <code>SpotifyConnectDevices</code> model to include a <code>DateLastRefreshed</code> property that indicates when the device list was last refreshed.</li>
|
|
946
|
+
</ul>
|
|
947
|
+
|
|
948
|
+
<h6 id="1054-20240619">[ 1.0.54 ] - 2024/06/19</h6>
|
|
949
|
+
|
|
950
|
+
<ul>
|
|
951
|
+
<li>Updated <code>SpotifyClient.GetSpotifyConnectDevices</code> method to store results to the configuration cache.</li>
|
|
952
|
+
</ul>
|
|
953
|
+
|
|
954
|
+
<h6 id="1053-20240618">[ 1.0.53 ] - 2024/06/18</h6>
|
|
955
|
+
|
|
956
|
+
<ul>
|
|
957
|
+
<li>Updated <code>ZeroconfConnect.Connect</code> method to provide a small delay after processing the Spotify Zeroconf API command, which will give the device some time to process the change.</li>
|
|
958
|
+
<li>Updated <code>ZeroconfConnect.Disconnect</code> method to provide a small delay after processing the Spotify Zeroconf API command, which will give the device some time to process the change.</li>
|
|
959
|
+
</ul>
|
|
960
|
+
|
|
961
|
+
<h6 id="1052-20240618">[ 1.0.52 ] - 2024/06/18</h6>
|
|
962
|
+
|
|
963
|
+
<ul>
|
|
964
|
+
<li>Updated <code>SpotifyClient.GetSpotifyConnectDevices</code> method to retrieve dynamic Spotify Connect devices as well as static devices. Dynamic devices are Spotify Connect devices that are not found in Zeroconf discovery process, but still exist in the player device list. These are usually Spotify Connect web or mobile players with temporary device id's.</li>
|
|
965
|
+
</ul>
|
|
966
|
+
|
|
967
|
+
<h6 id="1051-20240618">[ 1.0.51 ] - 2024/06/18</h6>
|
|
968
|
+
|
|
969
|
+
<ul>
|
|
970
|
+
<li>Added <code>SpotifyClient.GetSpotifyConnectDevices</code> method that gets information about all available Spotify Connect player devices (not just ones controlled by a user).</li>
|
|
971
|
+
</ul>
|
|
972
|
+
|
|
973
|
+
<h6 id="1050-20240618">[ 1.0.50 ] - 2024/06/18</h6>
|
|
974
|
+
|
|
975
|
+
<ul>
|
|
976
|
+
<li>Added <code>SpotifyClient.ZeroconfClient</code> property that contains a reference to the Zeroconf client instance used to discover Spotify Connect devices.</li>
|
|
977
|
+
<li>Added <code>SpotifyDiscovery.ZeroconfClient</code> property that contains a reference to the Zeroconf client instance used to discover Spotify Connect devices.</li>
|
|
978
|
+
</ul>
|
|
979
|
+
|
|
980
|
+
<h6 id="1049-20240618">[ 1.0.49 ] - 2024/06/18</h6>
|
|
981
|
+
|
|
982
|
+
<ul>
|
|
983
|
+
<li>Added <code>SpotifyClient.PlayerActivateDevices</code> method that activates all Spotify Connect player devices, and (optionally) switches the active user context to the current user context. Note that you can still activate individual devices using the <code>ZeroconfConnect.Connect</code> method if you wish.</li>
|
|
984
|
+
<li>Added <code>SpotifyClient.PlayerResolveDeviceId</code> method that resolves a Spotify Connect device identifier from a specified device id, name, alias id, or alias name. This will ensure that the device id can be found on the network, as well as connect to the device (if necessary) with the current user context. </li>
|
|
985
|
+
<li>Updated various <code>SpotifyClient</code> methods to utilize the new <code>SpotifyClient.PlayerResolveDeviceId</code> method so that device id's are automatically activated if they are currently deactivated but available on the local network. Methods updated were: <code>PlayerMediaPlayContext</code>, <code>PlayerMediaPlayTrackFavorites</code>, <code>PlayerMediaPlayTracks</code>, <code>PlayerTransferPlayback</code>.</li>
|
|
986
|
+
<li>Updated <code>SpotifyClient</code> class constructor so that Spotify Connect user context credentials (e.g. username and password) may be supplied for the resolution of device id / name. Note these credentials are only used for Spotify Connect device resolution, and are not used by method calls that are made to the underlying Spotify Web API.</li>
|
|
987
|
+
<li>Updated <code>SpotifyDiscovery</code> class constructor so that a <code>Zeroconf</code> instance can be provided. This allows Home Assistant integrations to use the HA Zeroconf instance and avoid the log warnings of multiple Zeroconf instances in use.</li>
|
|
988
|
+
<li>Removed <code>SpotifyClient</code> processing from the <code>SpotifyDiscovery</code> class, as the processing was moved into the <code>SpotifyClient</code> class itself.</li>
|
|
989
|
+
</ul>
|
|
990
|
+
|
|
991
|
+
<h6 id="1048-20240610">[ 1.0.48 ] - 2024/06/10</h6>
|
|
992
|
+
|
|
993
|
+
<ul>
|
|
994
|
+
<li>Forgot to re-build prior to deploying!</li>
|
|
995
|
+
</ul>
|
|
996
|
+
|
|
997
|
+
<h6 id="1047-20240610">[ 1.0.47 ] - 2024/06/10</h6>
|
|
998
|
+
|
|
999
|
+
<ul>
|
|
1000
|
+
<li>Moved all Spotify Zeroconf API related classes to a new namespace called <code>zeroconfapi</code>. Classes moved were: <code>ZeroconfResponse</code>, <code>ZeroconfGetInfo</code>, <code>ZeroconfGetInfoAlias</code>, <code>ZeroconfGetInfoDrmMediaFormat</code>.</li>
|
|
1001
|
+
<li>Added <code>ZeroconfConnect</code> class that contains various methods that support interfacing with the Spotify Zeroconf API.</li>
|
|
1002
|
+
<li>Added <code>ZeroconfConnect.Connect</code> method that calls the <code>addUser</code> Spotify Zeroconf API endpoint to issue a call to SpConnectionLoginBlob. If successful, the associated device id is added to the Spotify Connect active device list for the specified user account.</li>
|
|
1003
|
+
<li>Added <code>ZeroconfConnect.Disconnect</code> method that calls the <code>resetUsers</code> Spotify Zeroconf API endpoint to issue a call to SpConnectionLogout; the currently logged in user (if any) will be logged out of Spotify Connect, and the device id removed from the active Spotify Connect device list.</li>
|
|
1004
|
+
<li>Added <code>ZeroconfConnect.GetInformation</code> method that calls the <code>getInfo</code> Spotify Zeroconf API endpoint to return information about the device.</li>
|
|
1005
|
+
<li>Removed <code>SpotifyClient.ZeroconfAddUser</code> method, and replaced it with method <code>ZeroconfConnect.Connect</code>.</li>
|
|
1006
|
+
<li>Removed <code>SpotifyClient.ZeroconfResetUsers</code> method, and replaced it with method <code>ZeroconfConnect.Disconnect</code>.</li>
|
|
1007
|
+
<li>Removed <code>SpotifyClient.ZeroconfGetInformation</code> method, and replaced it with method <code>ZeroconfConnect.GetInformation</code>.</li>
|
|
1008
|
+
</ul>
|
|
1009
|
+
|
|
1010
|
+
<h6 id="1046-20240607">[ 1.0.46 ] - 2024/06/07</h6>
|
|
1011
|
+
|
|
1012
|
+
<ul>
|
|
1013
|
+
<li>Updated the following requirements due to Home Assistant dependency issues: 'oauthlib>=3.2.2', 'platformdirs>=4.1.0', 'requests>=2.31.0', 'requests_oauthlib>=1.3.1', 'zeroconf>=0.132.2'.</li>
|
|
1014
|
+
</ul>
|
|
1015
|
+
|
|
1016
|
+
<h6 id="1045-20240607">[ 1.0.45 ] - 2024/06/07</h6>
|
|
1017
|
+
|
|
1018
|
+
<ul>
|
|
1019
|
+
<li>Updated <code>zeroconf</code> requirements to "zeroconf>=0.132.2". This was causing installation issues with other components that utilize zeroconf.</li>
|
|
1020
|
+
</ul>
|
|
1021
|
+
|
|
1022
|
+
<h6 id="1044-20240607">[ 1.0.44 ] - 2024/06/07</h6>
|
|
1023
|
+
|
|
1024
|
+
<ul>
|
|
1025
|
+
<li>Added <code>SpotifyDiscovery.DiscoveredResults</code> class property that will contain an array of <code>ZeroconfDiscoveryResult</code> items that contain discovery details for each service that was discovered.</li>
|
|
1026
|
+
<li>Added model <code>ZeroconfDiscoveryResult</code> class that contains detailed Zeroconf ServiceInfo details that were discovered via Zeroconf.</li>
|
|
1027
|
+
<li>Added model <code>ZeroconfProperty</code> class that contains Zeroconf ServiceInfo property details that were discovered via Zeroconf.</li>
|
|
1028
|
+
<li>Added model <code>ZeroconfResponse</code> class that contains Zeroconf basic response variables.</li>
|
|
1029
|
+
<li>Added model <code>ZeroconfGetInfo</code> class that contains Zeroconf action=getInfo response variables.</li>
|
|
1030
|
+
<li>Added model <code>ZeroconfGetInfoAlias</code> class that contains Zeroconf action=getInfo Alias response variables.</li>
|
|
1031
|
+
<li>Added model <code>ZeroconfGetInfoDrmMediaFormat</code> class that contains Zeroconf action=getInfo DRM Media format response variables.</li>
|
|
1032
|
+
<li>Added logic to handle <code>503 Server Error</code> responses from the Spotify Web API.</li>
|
|
1033
|
+
<li>Added support for Spotify DJ playlist retrieval. As the Spotify Web API does not support retrieving the DJ playlist (<code>spotify:playlist:37i9dQZF1EYkqdzj48dyYq</code>), it simply returns a manually built representation of the playlist. Note that playlist tracks cannot be retrieved either for the DJ playlist, as the Spotify Web API does not support it.</li>
|
|
1034
|
+
</ul>
|
|
1035
|
+
|
|
1036
|
+
<h6 id="1043-20240421">[ 1.0.43 ] - 2024/04/21</h6>
|
|
1037
|
+
|
|
1038
|
+
<ul>
|
|
1039
|
+
<li>Added device name support to the following player methods that take a <code>deviceId</code> argument for player functions. You can now specify either a device id or device name in the <code>deviceId</code> argument to target a specific Spotify Connect Player device. <code>SpotifyClient</code> methods updated were: <code>AddPlayerQueueItem</code>, <code>PlayerMediaPause</code>, <code>PlayerMediaPlayContext</code>, <code>PlayerMediaPlayTrackFavorites</code>, <code>PlayerMediaPlayTracks</code>, <code>PlayerMediaResume</code>, <code>PlayerMediaSeek</code>, <code>PlayerMediaSkipNext</code>, <code>PlayerMediaSkipPrevious</code>, <code>PlayerSetRepeatMode</code>, <code>PlayerSetShuffleMode</code>, <code>PlayerSetVolume</code>, <code>PlayerTransferPlayback</code>.</li>
|
|
1040
|
+
<li>Added <code>SpotifyClient.PlayerConvertDeviceNameToId</code> method that converts a Spotify Connect player device name to it's equivalent id value if the value is a device name. If the value is a device id, then the value is returned as-is.</li>
|
|
1041
|
+
</ul>
|
|
1042
|
+
|
|
1043
|
+
<h6 id="1042-20240405">[ 1.0.42 ] - 2024/04/05</h6>
|
|
1044
|
+
|
|
1045
|
+
<ul>
|
|
1046
|
+
<li>Added <code>Device.IsMuted</code> property to indicate if volume is zero (muted) or not (unmuted).</li>
|
|
1047
|
+
<li>Added <code>PlayerPlayState.IsMuted</code> property to indicate if player device volume is zero (muted) or not (unmuted).</li>
|
|
1048
|
+
<li>Updated <code>SpotifyClient.PlayerMediaPlayTrackFavorites</code> method to set the shuffle mode prior to starting play of the track list. Prior to this change, the first track would always play first regardless of the shuffle setting; now it is part of the shuffle.</li>
|
|
1049
|
+
</ul>
|
|
1050
|
+
|
|
1051
|
+
<h6 id="1041-20240402">[ 1.0.41 ] - 2024/04/02</h6>
|
|
1052
|
+
|
|
1053
|
+
<ul>
|
|
1054
|
+
<li>Added <code>ArtistInfo</code> model that contains artist bio information.</li>
|
|
1055
|
+
<li>Added <code>ArtistInfoTourEvent</code> model that contains artist on tour event information.</li>
|
|
1056
|
+
<li>Added <code>SpotifyClient.GetArtistInfo</code> method to retrieve artist bio information for a specified Artist id.</li>
|
|
1057
|
+
<li>Added <code>SpotifyClient.PlayerMediaPlayTrackFavorites</code> method to play all tracks contained in the current users track favorites.</li>
|
|
1058
|
+
<li>Added <code>SpotifyClient.RemovePlaylist</code> method to remove a playlist by calling the <code>UnfollowPlaylist</code> method.</li>
|
|
1059
|
+
</ul>
|
|
1060
|
+
|
|
1061
|
+
<h6 id="1040-20240326">[ 1.0.40 ] - 2024/03/26</h6>
|
|
1062
|
+
|
|
1063
|
+
<ul>
|
|
1064
|
+
<li>Updated <code>SpotifyClient.PlayerVerifyDeviceDefault</code> method to check for a null <code>Device.Id</code> value when determining if an active device was set.</li>
|
|
1065
|
+
<li>Added <code>delay</code> argument to various <code>SpotifyClient</code> player command-related methods, which allows the Spotify Web API a little bit of time to process the change before returning from the method. Methods updated: <code>PlayerMediaPause</code>, <code>PlayerMediaPlayContext</code>, <code>PlayerMediaPlayTracks</code>, <code>PlayerMediaResume</code>, <code>PlayerMediaSeek</code>, <code>PlayerMediaSkipNext</code>, <code>PlayerMediaSkipPrevious</code>, <code>PlayerSetRepeatMode</code>, <code>PlayerSetShuffleMode</code>, <code>PlayerSetVolume</code>, <code>PlayerTransferPlayback</code>, <code>PlayerVerifyDeviceDefault</code>. Default delay is 250 milliseconds, but you can adjust accordingly (including removing the delay if you wish).</li>
|
|
1066
|
+
</ul>
|
|
1067
|
+
|
|
1068
|
+
<h6 id="1039-20240326">[ 1.0.39 ] - 2024/03/26</h6>
|
|
1069
|
+
|
|
1070
|
+
<ul>
|
|
1071
|
+
<li>Updated <code>PlayerPlayState.__init__</code> model to properly parse the Actions property.</li>
|
|
1072
|
+
</ul>
|
|
1073
|
+
|
|
1074
|
+
<h6 id="1038-20240326">[ 1.0.38 ] - 2024/03/26</h6>
|
|
1075
|
+
|
|
1076
|
+
<ul>
|
|
1077
|
+
<li>Updated <code>Device.__init__</code> model to validate the following properties were initialized from Spotify Web API results, and to set defaults if not: IsActive = False, IsPrivateSession = False, IsRestricted = False, SupportsVolume = False, VolumePercent = 0.</li>
|
|
1078
|
+
<li>Updated <code>PlayerPlayState.__init__</code> model to validate the following properties were initialized from Spotify Web API results, and to set defaults if not: Actions = PlayerActions(), Device = Device(), CurrentlyPlayingType = 'unknown', IsPlaying = False, ProgressMS = 0, RepeatState = 'off', ShuffleState = 'off', SmartShuffle = 'off', Timestamp = 0.</li>
|
|
1079
|
+
<li>Updated <code>PlayerActions.__init__</code> model to validate the following properties were initialized from Spotify Web API results, and to set defaults if not: InterruptingPlayback = False, Pausing = False, Resuming = False, Seeking = False, SkippingNext = False, SkippingPrev = False, TogglingRepeatContext = False, TogglingRepeatTrack = False, TogglingShuffle = False, TransferringPlayback = False.</li>
|
|
1080
|
+
</ul>
|
|
1081
|
+
|
|
1082
|
+
<h6 id="1037-20240319">[ 1.0.37 ] - 2024/03/19</h6>
|
|
1083
|
+
|
|
1084
|
+
<ul>
|
|
1085
|
+
<li>Updated <code>SpotifyClient.FollowArtists</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing track artist id value is used instead.</li>
|
|
1086
|
+
<li>Updated <code>SpotifyClient.UnfollowArtists</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing track artist id value is used instead.</li>
|
|
1087
|
+
<li>Updated <code>SpotifyClient.SaveAlbumFavorites</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing track album id value is used instead.</li>
|
|
1088
|
+
<li>Updated <code>SpotifyClient.RemoveAlbumFavorites</code> method to make the <code>ids</code> argument optional; if not supplied, the currently playing track album id value is used instead.</li>
|
|
1089
|
+
<li>Updated <code>SpotifyClient.CreatePlaylist</code> method to add the <code>imagePath</code> argument, which assigns an image to the created playlist.</li>
|
|
1090
|
+
<li>Updated <code>SpotifyClient.ChangePlaylistDetails</code> method to add the <code>imagePath</code> argument, which assigns an image to the updated playlist details.</li>
|
|
1091
|
+
</ul>
|
|
1092
|
+
|
|
1093
|
+
<h6 id="1036-20240319">[ 1.0.36 ] - 2024/03/19</h6>
|
|
1094
|
+
|
|
1095
|
+
<ul>
|
|
1096
|
+
<li>Fixed <code>SpotifyClient.SaveTrackFavorites</code> method for a bug introduced with v1.0.35 update causeing 'object of type 'bool' has no len()' exceptions.</li>
|
|
1097
|
+
<li>Fixed <code>SpotifyClient.RemoveTrackFavorites</code> method for a bug introduced with v1.0.35 update causeing 'object of type 'bool' has no len()' exceptions.</li>
|
|
1098
|
+
<li>Fixed <code>SpotifyClient.AddPlaylistItems</code> method for a bug introduced with v1.0.35 update causeing 'object of type 'bool' has no len()' exceptions.</li>
|
|
1099
|
+
<li>Fixed <code>SpotifyClient.RemovePlaylistItems</code> method for a bug introduced with v1.0.35 update causeing 'object of type 'bool' has no len()' exceptions.</li>
|
|
1100
|
+
</ul>
|
|
1101
|
+
|
|
306
1102
|
<h6 id="1035-20240318">[ 1.0.35 ] - 2024/03/18</h6>
|
|
307
1103
|
|
|
308
1104
|
<ul>
|