rdelaage
/
librespot-python
mirror of https://github.com/kokarare1212/librespot-python.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update document

This commit is contained in:
kokarare1212 2021-05-16 08:11:54 +09:00
parent 340e3dbbcb
commit e578e6570d
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/index.md
View File

@ -7,22 +7,22 @@
* [Supported Futures](supported.md) * [Supported Futures](supported.md)
* [API Reference](api.md) * [API Reference](api.md)
## What's librespot-python? ## What's librespot-python?
librespot-python is a python port of Spotify's open source client library [librespot](https://github.com/librespot-org/librespot). | librespot-python is a python port of Spotify's open source client library [librespot](https://github.com/librespot-org/librespot).
It was created to play Spotify on various platforms and devices. | It was created to play Spotify on various platforms and devices.
## What do you need? ## What do you need?
In order to develop with this library, you need to use Python. | In order to develop with this library, you need to use Python.
Python can be downloaded from [the official website here](https://python.org/). | Python can be downloaded from [the official website here](https://python.org/).
## Disclaimer ## Disclaimer
Please keep in mind that this library is not like Spotify approved. | Please keep in mind that this library is not like Spotify approved.
Therefore, the worst that can happen is that you will be banned from Spotify. | Therefore, the worst that can happen is that you will be banned from Spotify.
Also, please keep in mind that this library is in alpha and may behave in unintended ways. | Also, please keep in mind that this library is in alpha and may behave in unintended ways.
## Installation ## Installation
You can download this library in the following way. | You can download this library in the following way.
Stable Version ***still not working.** | Stable Version ***still not working.**
```commandline ```commandline
pip install librespot pip install librespot
``` ```
Snapshot Version ***Recommended** | Snapshot Version ***Recommended**
```commandline ```commandline
pip install git+https://github.com/kokarare1212/librespot-python pip install git+https://github.com/kokarare1212/librespot-python
``` ```
@ -39,7 +39,7 @@ session = Session.Builder() \
aceess_token = session.tokens().get("playlist-read") aceess_token = session.tokens().get("playlist-read")
``` ```
### Get Music Stream ### Get Music Stream
*Currently, music streaming is supported, but it may cause unintended behavior. | *Currently, music streaming is supported, but it may cause unintended behavior.
```python ```python
from librespot.core import Session from librespot.core import Session
from librespot.metadata import TrackId from librespot.metadata import TrackId
@ -56,7 +56,7 @@ stream = session.content_feeder().load(track_id, VorbisOnlyAudioQuality(AudioQua
# ex: 1 (If there is no more voice data, -1 is received as the result.) # ex: 1 (If there is no more voice data, -1 is received as the result.)
``` ```
## Debug ## Debug
To display the debug information, you need to inject the following code at the top of the code. | To display the debug information, you need to inject the following code at the top of the code.
```python ```python
import logging import logging