Skip to content
This repository has been archived by the owner on Apr 19, 2024. It is now read-only.
/ SoundPull Public archive

Used to pull users, tracks, comments, and more from SoundCloud.

License

Notifications You must be signed in to change notification settings

sakertooth/SoundPull

Repository files navigation

SoundPull

build issues nuget downloads
Saker.SoundPull Codacy Badge

Getting Started

  • With SoundPull, you are able to pull user information, track information, and playlist information, along with others from SoundCloud with the help of Json.NET.

  • In addition, you can also play tracks and playlists from SoundPull using its player class. This is made possible by the use of NAudio.

  • In SoundCloud, most information that can be pulled is in JSON format, meaning that SoundPull uses Json.Net in order to deserialize the information pulled from the API resolve endpoint into objects that SoundPull can read.

Installation

  • Installing SoundPull and Json.Net is very simple.
Install-Package Saker.SoundPull
Install-Package Newtonsoft.Json
  • To use the Player class, you must have NAudio as well.
Install-Package NAudio

Basic Usage

  • Make a new instance of a SoundPullSession like so:
SoundPullSession session = new SoundPullSession("[your_client_id]");
  • From there, you can pull almost anything from SoundCloud (more coming soon):
SoundCloudUser user = session.GetUser("user");
string userDisplayName = user.username; //gets the users display name

Snippets

tracksnippet


usersnippet


playlistsnippet


querysnippet

Features

  • Uses 'sessions' that can pull users, tracks, and playlists, seamlessly
  • A functional Player class that can be used to play tracks and playlists with simple methods
  • No Client Secret required, only a Client ID is needed
  • Uses Json.NET, one of the fastest JSON serializers known.
  • Utilizing NAudio, providing a seamless player class to be used at your convenience.
  • Simple volume function
  • Can get the current position of your song in the format m:ss, it also allows support for your own format.
  • Loop functions, allowing you to loop songs and playlists. (available in the pre release >= 1.32)
  • Can search for tracks, playlists, and users.
  • Can do 'all-in-one' searches

Roadmap

What now?

Socials

fork
star

Built With

License

SoundPull is licensed under the MIT license.
mit2