Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jerry08/soundcloudexplode

Parses public metadata on SoundCloud tracks/playlists and lets you download them.
https://github.com/jerry08/soundcloudexplode

downloader downloadermp3 scdl soundcloud soundcloud-api soundcloud-dl soundcloud-downloader

Last synced: 27 days ago
JSON representation

Parses public metadata on SoundCloud tracks/playlists and lets you download them.

Awesome Lists containing this project

README 

        


    SoundCloudExplode






   

   




**SoundCloudExplode** is a library that provides an interface to query metadata of SoundCloud tracks and playlists, as well as to resolve and download streams.



### 🌟STAR THIS REPOSITORY TO SUPPORT THE DEVELOPER AND ENCOURAGE THE DEVELOPMENT OF THE APPLICATION!



## Install



- 📦 [NuGet](https://nuget.org/packages/SoundCloudExplode): `dotnet add package SoundCloudExplode` (**main package**)



## Usage



**SoundCloudExplode** exposes its functionality through a single entry point — the `SoundCloudClient` class.

Create an instance of this class and use the provided operations to send requests.



### Tracks



#### Retrieving track metadata



To retrieve the metadata associated with a Soundcloud track, call `Tracks.GetAsync(...)`:



```csharp

using SoundCloudExplode;



var soundcloud = new SoundCloudClient();



var track = await soundcloud.Tracks.GetAsync("https://soundcloud.com/purityy79/dororo-op-piano-sheet-in-description");



var title = track.Title;

var duration = track.Duration;

```



### Playlists



#### Retrieving playlist metadata



You can get the metadata associated with a Soundcloud playlist by calling `Playlists.GetAsync(...)` method:



```csharp

using SoundCloudExplode;



var soundcloud = new SoundCloudClient();



// Get a playlist basic information

var playlist = await soundcloud.Playlists.GetAsync(

    "https://soundcloud.com/tommy-enjoy/sets/aimer"

);



// Or get playlist and load all related tracks at the same time

var playlist = await soundcloud.Playlists.GetAsync(

    "https://soundcloud.com/tommy-enjoy/sets/aimer",

    true

);



var title = playlist.Title;

var artworkUrl = playlist.ArtworkUrl;

var tracks = playlist.Tracks;

...

```



#### Getting tracks included in a playlist



To get the tracks included in a playlist, call `Playlists.GetTracksAsync(...)`:



```csharp

using SoundCloudExplode;

using SoundCloudExplode.Common;



var soundcloud = new SoundCloudClient();

var playlistUrl = "https://soundcloud.com/tommy-enjoy/sets/aimer";



// Get all playlist tracks

var tracks = await soundcloud.Playlists.GetTracksAsync(playlistUrl);



// Get only the first 20 playlist tracks

var tracksSubset = await soundcloud.Playlists.GetTracksAsync(playlistUrl).CollectAsync(20);



// Get only the first 20 playlist tracks (by setting a limit)

var tracksSubset = await soundcloud.Playlists.GetTracksAsync(playlistUrl, limit: 20);



// Setting offset

var tracksSubset = await soundcloud.Playlists.GetTracksAsync(

    playlistUrl,

    offset: 10,

    limit: 5

);

```



You can also enumerate the tracks iteratively without waiting for the whole list to load:



```csharp

using SoundCloudExplode;



var soundcloud = new SoundCloudClient();

var playlistUrl = "https://soundcloud.com/tommy-enjoy/sets/aimer";



await foreach (var track in soundcloud.Playlists.GetTracksAsync(playlistUrl))

{

    var title = track.Title;

    var duration = track.Duration;

}

```



If you need precise control over how many requests you send to SoundCloud, use `Playlists.GetTrackBatchesAsync(...)` which returns tracks wrapped in batches:



```csharp

using SoundCloudExplode;



var soundcloud = new SoundCloudClient();

var playlistUrl = "https://soundcloud.com/tommy-enjoy/sets/aimer";



// Each batch corresponds to one request

await foreach (var batch in soundcloud.Playlists.GetTrackBatchesAsync(playlistUrl))

{

    foreach (var track in batch.Items)

    {

        var title = track.Title;

        var duration = track.Duration;

    }

}

```



### Albums

**Note:** Use the same method as retrieving playlists to get albums because they are the same. 



### Searching

You can execute a search query and get its results by calling `Search.GetResultsAsync(...)`. Each result may represent either a track, a playlist, an album, or a user, so you need to apply pattern matching to handle the corresponding cases:



```csharp

using SoundCloudExplode;

using SoundCloudExplode.Common;



var soundcloud = new SoundCloudClient();



await foreach (var result in soundcloud.Search.GetResultsAsync("banda neira"))

{

    // Use pattern matching to handle different results (tracks, playlists, users)

    switch (result)

    {

        case TrackSearchResult track:

            {

                var id = track.Id;

                var title = track.Title;

                var duration = track.Duration;

                break;

            }

        // NOTE: Soundcloud handles playlist and albums the same way.

        case PlaylistSearchResult playlist:

            {

                var id = playlist.Id;

                var title = playlist.Title;

                break;

            }

        case UserSearchResult user:

            {

                var id = user.Id;

                var title = user.Title;

                var userName = user.Username;

                var fullName = user.FullName;

                break;

            }

    }

}

```



To limit the results to a specific type, use `Search.GetTracksAsync(...)`, `Search.GetPlaylistsAsync(...)`, or `Search.GetUsersAsync(...)`



```csharp

using SoundCloudExplode;

using SoundCloudExplode.Common;



var soundcloud = new SoundCloudClient();



var tracks = await soundcloud.Search.GetTracksAsync("banda neira");

var playlists = await soundcloud.Search.GetPlaylistsAsync("banda neira");

var users = await soundcloud.Search.GetUsersAsync("banda neira");

```



#### Downloading tracks



```csharp

using System;

using System.IO;

using SoundCloudExplode;



var soundcloud = new SoundCloudClient();



var track = await soundcloud.Tracks.GetAsync("https://soundcloud.com/purityy79/dororo-op-piano-sheet-in-description");



var trackName = string.Join("_", track.Title.Split(Path.GetInvalidFileNameChars()));



await soundcloud.DownloadAsync(track, $@"{Environment.CurrentDirectory}\Download\{trackName}.mp3");

```



You can request the download url for a particular track by calling `Tracks.GetDownloadUrlAsync(...)`:



```csharp

using SoundCloudExplode;



var soundcloud = new SoundCloudClient();



var track = await soundcloud.Tracks.GetAsync("https://soundcloud.com/purityy79/dororo-op-piano-sheet-in-description");



var downloadUrl = await soundcloud.Tracks.GetDownloadUrlAsync(track);

```