Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bobbyesp/spotdl-android
A SpotDL Android wrapper library built with Kotlin. (Spotify songs downloader for Android!)
https://github.com/bobbyesp/spotdl-android
android android-library kotlin spotify wrapper-library
Last synced: 3 months ago
JSON representation
A SpotDL Android wrapper library built with Kotlin. (Spotify songs downloader for Android!)
- Host: GitHub
- URL: https://github.com/bobbyesp/spotdl-android
- Owner: BobbyESP
- License: mit
- Created: 2022-12-20T22:26:58.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-02T21:04:19.000Z (4 months ago)
- Last Synced: 2024-10-13T04:38:27.827Z (4 months ago)
- Topics: android, android-library, kotlin, spotify, wrapper-library
- Language: Kotlin
- Homepage:
- Size: 597 MB
- Stars: 56
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
SpotDL Android
A SpotDL (python library) Android wrapper built with Kotlin
## ⬇️ DOWNLOAD SAMPLE APP
Download the sample app from the [releases](https://github.com/BobbyESP/spotdl-android/releases/latest) page.
Note that this app is just an example of the usage of this library. Many people asked me for new features, but I'm making a brand new app that will be fully customizable and with the ability to use custom commands along other things. This app is Spowlo. Currently it is only a Spotify mods downloader, but I'm doing a remake in a secondary branch in the same repo called "remake", where I'll be coding the new app that will have as principal functionality download songs (and also the mod downloader inside the app!). I'll keep you updated!
## 📣 DOCS IN PROGRESS!!
## 🎉 ANNOUNCEMENT: FIRST RELEASE
The library has came out, go to the releases page and see!
[](https://jitpack.io/#BobbyESP/spotdl-android)
🔨 HOW IT WORKS
## Installation
**In Gradle:**
- **Step 1:** Add the Jitpack repository to your build.gradle file at the project level.
```gradle
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
```
- **Step 2:** Add the two library dependencies to your build.gradle file at app/module level.
```gradle
dependencies {
implementation "com.github.BobbyESP.spotdl-android:spotdl-android-library:$spotdllib_version"
implementation "com.github.BobbyESP.spotdl-android:spotdl-android-ffmpeg:$spotdllib_version"
}
```
>**Note**
You can add an `extra` property in Gradle for more organization/readability. In this example, as you can see, the property for putting the version of the library in the dependency declaration is called `spotdllib_version` and it should look like this:
```gradle
allprojects{
extras{
spotdllib_version = '0.1.0'
}
}
```
Jitpack sometimes works quite bad, so if the library downloading fails, please, change the version value to `-SNAPSHOT`
**Things that are mandatory:**
- You need to put the property `android:extractNativeLibs="true"` in your app's AndroidManifest.xml because the spotdl binary is already included in the library and Android can't open it without this permission.
## Usage
>**Note**
Python 3.8 is already bundled in the library
- **Step 1:**
The first thing you have to do is to initialize the library. It's highly recommended to do it in the `onCreate` function in your MainActivity or Application class.
```kotlin
try {
SpotDL.getInstance().init(this@App) //Replace @App by the class you're using to initiate the lib.
} catch (e: Excpetion) {
Log.e("SpotDLExample", "An error ocurreed while trying to initiate the library: $e")
}
```
## FFMpeg
The library won't work without FFmpeg, so for using it, you have to add the second library that was told at the very top of the README
- You have to add to your dependecies declaration the next library:
```gradle
dependencies {
implementation "com.github.BobbyESP.spotdl-android:spotdl-android-ffmpeg:$spotdllib_version"
}
```
Now, you have to add this code to the last try-catch example:
```kotlin
FFMpeg.getInstance.init(this@App) //Same as before
```
Getting a final try-catch like this:
```kotlin
try {
SpotDL.getInstance().init(this@App) //Replace @App by the class you're using to initiate the lib.
FFMpeg.getInstance().init(this@App)
} catch (e: Excpetion) {
Log.e("SpotDLExample", "An error ocurreed while trying to initiate the library: $e")
}
```
## 👷 CREDITS
- [SpotDL](https://github.com/spotDL) for it's amazing python library for downloading any song/album from Spotify!
- [xnetcat](https://github.com/xnetcat) for helping me understand some parts/commands of Linux (XD), fix some bugs of this wrapper and for giving us all the files and binaries needed for working!
- [JunkFood02](https://github.com/Junkfood02) for helping me fix some bugs and explain me some code and functionality of the youtubedl-android library (in which this library is a little based on) and explaining me the storage framework of Android.
- [youtubedl-android](https://github.com/yausername/youtubedl-android) for some parts of the code of the library aswell as the inspiration for making this library (I really wanted to learn how to do one!)
## ⚖️ LICENSE
This project is under the MIT License, the same as SpotDL uses.