programming:python:py-sonic
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
programming:python:py-sonic [2013/04/28 19:24] – [deletePodcastChannel(self, pid)] jay | programming:python:py-sonic [2024/01/01 17:13] (current) – [scrobble(self, sid, submission=True)] jay | ||
---|---|---|---|
Line 14: | Line 14: | ||
**NOTE:** The RPMs are **not** guaranteed to be the latest versions. | **NOTE:** The RPMs are **not** guaranteed to be the latest versions. | ||
- | {{: | + | {{: |
- | {{: | + | {{: |
===== Donations ===== | ===== Donations ===== | ||
Line 101: | Line 101: | ||
**UPDATE to the UPDATE: | **UPDATE to the UPDATE: | ||
- | ==== Important Notes About API Version 1.8.0 ==== | + | ==== Important Notes About API Version 1.8.0 (and later) |
It's important to note that Subsonic API version 1.8.0 added some methods that are not compatible with previous methods. | It's important to note that Subsonic API version 1.8.0 added some methods that are not compatible with previous methods. | ||
Line 212: | Line 212: | ||
See the documention on [[http:// | See the documention on [[http:// | ||
+ | |||
+ | Returns a dict like the following: | ||
+ | <code python> | ||
+ | { | ||
+ | u' | ||
+ | u' | ||
+ | u' | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== deleteBookmark(self, | ||
+ | __Since API version: 1.9.0__ | ||
+ | |||
+ | Deletes the bookmark for a given file | ||
+ | |||
+ | ^ Name ^ Type ^ Description ^ | ||
+ | | mid | str | The ID of the media file to delete the bookmark from. Other users' bookmarks are not affected | | ||
Returns a dict like the following: | Returns a dict like the following: | ||
Line 238: | Line 255: | ||
} | } | ||
</ | </ | ||
- | |||
==== deletePodcastChannel(self, | ==== deletePodcastChannel(self, | ||
__Since API version: 1.9.0__ | __Since API version: 1.9.0__ | ||
Line 316: | Line 332: | ||
Returns the file-like object for reading or raises an exception on error. | Returns the file-like object for reading or raises an exception on error. | ||
+ | |||
+ | ==== downloadPodcastEpisode(self , pid) ==== | ||
+ | __Since API version: 1.9.0__ | ||
+ | |||
+ | Tells the server to start downloading a given Podcast episode. Note: The user must be authorized for Podcast administration | ||
+ | |||
+ | ^ Name ^ Type ^ Description ^ | ||
+ | | pid | str | The ID of the Podcast episode to download. | | ||
+ | |||
+ | Returns a dict like the following: | ||
+ | <code python> | ||
+ | { | ||
+ | u' | ||
+ | u' | ||
+ | u' | ||
+ | } | ||
+ | </ | ||
==== getAlbum(self , id) ==== | ==== getAlbum(self , id) ==== | ||
Line 467: | Line 500: | ||
Returns the file-like object for reading or raises an exception on error | Returns the file-like object for reading or raises an exception on error | ||
+ | ==== getBookmarks(self) ==== | ||
+ | __Since API version: 1.9.0__ | ||
+ | |||
+ | Returns all bookmarks for this user. A bookmark is a position within a media file | ||
+ | |||
+ | <code python> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
==== getChatMessages(self, | ==== getChatMessages(self, | ||
__Since API version: 1.2.0__ | __Since API version: 1.2.0__ | ||
Line 556: | Line 631: | ||
I hope that table clarifies things a bit. | I hope that table clarifies things a bit. | ||
+ | ==== getInternetRadioStations(self) ==== | ||
+ | __Since API version: 1.9.0__ | ||
+ | |||
+ | Returns all internet radio stations | ||
+ | |||
+ | Returns a dict like the following: | ||
+ | |||
+ | <code python> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
==== getLicense(self) ==== | ==== getLicense(self) ==== | ||
__Since API version: 1.0.0__ | __Since API version: 1.0.0__ | ||
Line 1067: | Line 1164: | ||
| | ||
</ | </ | ||
+ | ==== hls(self , mid , bitrate=None) ==== | ||
+ | __Since API version: 1.9.0__ | ||
+ | |||
+ | Creates an HTTP live streaming playlist for streaming video or audio HLS is a streaming protocol implemented by Apple and works by breaking the overall stream into a sequence of small HTTP-based file downloads. It's supported by iOS and newer versions of Android. This method also supports adaptive bitrate streaming, see the bitRate parameter. | ||
+ | |||
+ | ^ Name ^ Type ^ Description ^ | ||
+ | | mid | str | The ID of the media to stream | | ||
+ | | bitrate | str | If specified, the server will attempt to limit the bitrate to this value, in kilobits per second. If this parameter is specified more than once, the server will create a variant playlist, suitable for adaptive bitrate streaming. The playlist will support streaming at all the specified bitrates. | ||
+ | |||
+ | Returns the raw m3u8 file as a string | ||
+ | |||
==== jukeboxControl(self, | ==== jukeboxControl(self, | ||
__Since API version: 1.2.0__ | __Since API version: 1.2.0__ | ||
Line 1108: | Line 1216: | ||
| sid | str | The ID of the file to scrobble | | | sid | str | The ID of the file to scrobble | | ||
| submission | bool | Whether this is a " | | submission | bool | Whether this is a " | ||
+ | | listenTime | int | The unix timestamp for the listen to scrobble. | | ||
Returns a dict like the following: | Returns a dict like the following: |
programming/python/py-sonic.1367177090.txt.gz · Last modified: 2013/04/28 19:24 by jay