audio
Audio providers for spotdl.
AudioProvider(output_format='mp3', cookie_file=None, search_query=None, filter_results=True, yt_dlp_args=None)
¤
Base class for all other providers. Provides some common functionality. Handles the yt-dlp audio handler.
Arguments¤
- output_directory: The directory to save the downloaded songs to.
- output_format: The format to save the downloaded songs in.
- cookie_file: The path to a file containing cookies to be used by YTDL.
- search_query: The query to use when searching for songs.
- filter_results: Whether to filter results.
Source code in spotdl/providers/audio/base.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
|
get_best_result(results)
¤
Get the best match from the results using views and average match
Arguments¤
- results: A dictionary of results and their scores
Returns¤
- The best match URL and its score
Source code in spotdl/providers/audio/base.py
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 |
|
get_download_metadata(url, download=False)
¤
Get metadata for a download using yt-dlp.
Arguments¤
- url: The url to get metadata for.
Returns¤
- A dictionary containing the metadata.
Source code in spotdl/providers/audio/base.py
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 |
|
get_results(search_term, **kwargs)
¤
Get results from audio provider.
Arguments¤
- search_term: The search term to use.
- kwargs: Additional arguments.
Returns¤
- A list of results.
Source code in spotdl/providers/audio/base.py
121 122 123 124 125 126 127 128 129 130 131 132 133 |
|
get_views(url)
¤
Get the number of views for a video.
Arguments¤
- url: The url of the video.
Returns¤
- The number of views.
Source code in spotdl/providers/audio/base.py
135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
|
search(song, only_verified=False)
¤
Search for a song and return best match.
Arguments¤
- song: The song to search for.
Returns¤
- The url of the best match or None if no match was found.
Source code in spotdl/providers/audio/base.py
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 |
|
AudioProviderError
¤
Bases: Exception
Base class for all exceptions related to audio searching/downloading.
BandCamp(output_format='mp3', cookie_file=None, search_query=None, filter_results=True, yt_dlp_args=None)
¤
Bases: AudioProvider
SoundCloud audio provider class
Arguments¤
- output_directory: The directory to save the downloaded songs to.
- output_format: The format to save the downloaded songs in.
- cookie_file: The path to a file containing cookies to be used by YTDL.
- search_query: The query to use when searching for songs.
- filter_results: Whether to filter results.
Source code in spotdl/providers/audio/base.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
|
get_results(search_term, *_args, **_kwargs)
¤
Get results from slider.kz
Arguments¤
- search_term: The search term to search for.
- args: Unused.
- kwargs: Unused.
Returns¤
- A list of slider.kz results if found, None otherwise.
Source code in spotdl/providers/audio/bandcamp.py
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
|
Piped(output_format='mp3', cookie_file=None, search_query=None, filter_results=True, yt_dlp_args=None)
¤
Bases: AudioProvider
YouTube Music audio provider class
Arguments¤
- output_directory: The directory to save the downloaded songs to.
- output_format: The format to save the downloaded songs in.
- cookie_file: The path to a file containing cookies to be used by YTDL.
- search_query: The query to use when searching for songs.
- filter_results: Whether to filter results.
Source code in spotdl/providers/audio/piped.py
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
|
get_download_metadata(url, download=False)
¤
Get metadata for a download using yt-dlp.
Arguments¤
- url: The url to get metadata for.
Returns¤
- A dictionary containing the metadata.
Source code in spotdl/providers/audio/piped.py
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
|
get_results(search_term, **kwargs)
¤
Get results from YouTube Music API and simplify them
Arguments¤
- search_term: The search term to search for.
- kwargs: other keyword arguments passed to the
YTMusic.search
method.
Returns¤
- A list of simplified results (dicts)
Source code in spotdl/providers/audio/piped.py
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
|
SliderKZ(output_format='mp3', cookie_file=None, search_query=None, filter_results=True, yt_dlp_args=None)
¤
Bases: AudioProvider
Slider.kz audio provider class
Arguments¤
- output_directory: The directory to save the downloaded songs to.
- output_format: The format to save the downloaded songs in.
- cookie_file: The path to a file containing cookies to be used by YTDL.
- search_query: The query to use when searching for songs.
- filter_results: Whether to filter results.
Source code in spotdl/providers/audio/base.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
|
get_results(search_term, *_args, **_kwargs)
¤
Get results from slider.kz
Arguments¤
- search_term: The search term to search for.
- args: Unused.
- kwargs: Unused.
Returns¤
- A list of slider.kz results if found, None otherwise.
Source code in spotdl/providers/audio/sliderkz.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
|
SoundCloud(*args, **kwargs)
¤
Bases: AudioProvider
SoundCloud audio provider class
Arguments¤
- args: Arguments passed to the
AudioProvider
class. - kwargs: Keyword arguments passed to the
AudioProvider
class.
Source code in spotdl/providers/audio/soundcloud.py
29 30 31 32 33 34 35 36 37 38 39 |
|
get_results(search_term, *_args, **_kwargs)
¤
Get results from slider.kz
Arguments¤
- search_term: The search term to search for.
- args: Unused.
- kwargs: Unused.
Returns¤
- A list of slider.kz results if found, None otherwise.
Source code in spotdl/providers/audio/soundcloud.py
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
|
YTDLLogger
¤
Custom YT-dlp logger.
debug(msg)
¤
YTDL uses this to print debug messages.
Source code in spotdl/providers/audio/base.py
38 39 40 41 42 43 |
|
error(msg)
¤
YTDL uses this to print errors.
Source code in spotdl/providers/audio/base.py
52 53 54 55 56 57 |
|
warning(msg)
¤
YTDL uses this to print warnings.
Source code in spotdl/providers/audio/base.py
45 46 47 48 49 50 |
|
YouTube(output_format='mp3', cookie_file=None, search_query=None, filter_results=True, yt_dlp_args=None)
¤
Bases: AudioProvider
YouTube audio provider class
Arguments¤
- output_directory: The directory to save the downloaded songs to.
- output_format: The format to save the downloaded songs in.
- cookie_file: The path to a file containing cookies to be used by YTDL.
- search_query: The query to use when searching for songs.
- filter_results: Whether to filter results.
Source code in spotdl/providers/audio/base.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
|
get_results(search_term, *_args, **_kwargs)
¤
Get results from YouTube
Arguments¤
- search_term: The search term to search for.
- args: Unused.
- kwargs: Unused.
Returns¤
- A list of YouTube results if found, None otherwise.
Source code in spotdl/providers/audio/youtube.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
|
YouTubeMusic(*args, **kwargs)
¤
Bases: AudioProvider
YouTube Music audio provider class
Arguments¤
- args: Arguments passed to the
AudioProvider
class. - kwargs: Keyword arguments passed to the
AudioProvider
class.
Source code in spotdl/providers/audio/ytmusic.py
27 28 29 30 31 32 33 34 35 36 37 38 |
|
get_results(search_term, **kwargs)
¤
Get results from YouTube Music API and simplify them
Arguments¤
- search_term: The search term to search for.
- kwargs: other keyword arguments passed to the
YTMusic.search
method.
Returns¤
- A list of simplified results (dicts)
Source code in spotdl/providers/audio/ytmusic.py
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
|