Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sakertooth/soundpull
Used to pull users, tracks, comments, and more from SoundCloud.
https://github.com/sakertooth/soundpull
audio-player naudio soundcloud soundcloud-api
Last synced: about 2 months ago
JSON representation
Used to pull users, tracks, comments, and more from SoundCloud.
- Host: GitHub
- URL: https://github.com/sakertooth/soundpull
- Owner: sakertooth
- License: mit
- Archived: true
- Created: 2019-02-25T01:26:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-06T01:38:14.000Z (almost 4 years ago)
- Last Synced: 2024-09-26T12:01:20.607Z (about 2 months ago)
- Topics: audio-player, naudio, soundcloud, soundcloud-api
- Language: C#
- Homepage:
- Size: 1.16 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SoundPull
[](https://ci.appveyor.com/project/sakertooth/soundpull)
[](https://github.com/sakertooth/SoundPull/issues)
[](https://www.nuget.org/packages/Saker.SoundPull/)
\
[](https://www.nuget.org/packages/Saker.SoundPull/)
[](https://www.codacy.com/app/sakertooth/SoundPull?utm_source=github.com&utm_medium=referral&utm_content=sakertooth/SoundPull&utm_campaign=Badge_Grade)
## 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:
```c#
SoundPullSession session = new SoundPullSession("[your_client_id]");
```
* From there, you can pull almost anything from SoundCloud (more coming soon):
```c#
SoundCloudUser user = session.GetUser("user");
string userDisplayName = user.username; //gets the users display name
```
## Snippets
\
\
\
\
\
\
\
\
\
## 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
* Generating streams, based on what accounts the user follows (https://soundcloud.com/stream)
## What now?
* [Wiki documentation](https://github.com/sakertooth/SoundPull/wiki/1.-Getting-Started)
## Socials
[](https://github.com/sakertooth/SoundPull/fork)
\
[](https://github.com/sakertooth/SoundPull)
## Built With
* [Json.NET](https://github.com/JamesNK/Newtonsoft.Json)
* [NAudio](https://github.com/naudio/NAudio)
## License
SoundPull is licensed under the MIT license.
\
[](https://github.com/sakertooth/SoundPull/blob/master/LICENSE)