Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/swiftyspiffy/streamelementsnet

Repository for library that reads from StreamElements websocket event server.
https://github.com/swiftyspiffy/streamelementsnet

Last synced: 11 days ago
JSON representation

Repository for library that reads from StreamElements websocket event server.

Host: GitHub
URL: https://github.com/swiftyspiffy/streamelementsnet
Owner: swiftyspiffy
License: mit
Created: 2020-07-12T04:50:04.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-08-29T18:28:10.000Z (2 months ago)
Last Synced: 2024-10-14T19:28:07.161Z (24 days ago)
Language: C#
Size: 33.2 KB
Stars: 12
Watchers: 2
Forks: 6
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# StreamElementsNET

## Overview
C# library for reading event data from StreamElements. Events include tips, subscriptions, hosts, followers, and cheers. All that is required is the JWT that is obtained when logged into StreamElements. **DESIGNED FOR TWITCH INTEGRATIONS**

### Supported events
##### Tips
- `OnTip`
- `OnTipCount`
- `OnTipLatest`
- `OnTipSession`
- `OnTipGoal`
- `OnTipWeek`
- `OnTipTotal`
- `OnTipMonth`
- `OnTipSessionTopDonator`
- `OnTipSessionTopDonation`

##### Subscriptions
- `OnSubscriber`
- `OnSubscriberLatest`
- `OnSubscriberSession`
- `OnSubscriberGoal`
- `OnSubscriberMonth`
- `OnSubscriberWWeek`
- `OnSubscriberTotal`
- `OnSubscriberPoints`
- `OnSubscriberResubSession`
- `OnSubscriberResubLatest`
- `OnSubscriberNewSession`
- `OnSubscriberGiftedSession`
- `OnSubscriberNewLatest`
- `OnSubscriberAlltimeGifter`
- `OnSubscriberGiftedLatest`

##### Hosts
- `OnHost`
- `OnHostLatest`

##### Followers
- `OnFollower`
- `OnFollowerLatest`
- `OnFollowerGoal`
- `OnFollowerMonth`
- `OnFollowerWeek`
- `OnFollowerTotal`
- `OnFollowerSession`

##### Cheers
- `OnCheer`
- `OnCheerLatest`
- `OnCheerGoal`
- `OnCheerCount`
- `OnCheerTotal`
- `OnCheerSession`
- `OnCheerSessionTopDonator`
- `OnCheerSessionTopDonation`
- `OnCheerMonth`
- `OnCheerWeek`

### Usage
```
var streamElements = new StreamElementsNET.Client();

streamElements.OnConnected += StreamElements_OnConnected;
streamElements.OnAuthenticated += StreamElements_OnAuthenticated;
streamElements.OnFollower += StreamElements_OnFollower;
streamElements.OnSubscriber += StreamElements_OnSubscriber;
streamElements.OnHost += StreamElements_OnHost;
streamElements.OnTip += StreamElements_OnTip;
streamElements.OnCheer += StreamElements_OnCheer;
streamElements.OnAuthenticationFailure += StreamElements_OnAuthenticationFailure;
streamElements.OnReceivedRawMessage += StreamElements_OnReceivedRawMessage;
streamElements.OnSent += StreamElements_OnSent;

streamElements.Connect("");
```

### Testing
A tests project has been included in this repository to demonstrate basic usage of the library.

### NuGet
Available via NuGet: Install-Package [StreamElementNET](https://www.nuget.org/packages/StreamElementsNET/)

## Libraries
- Newtonsoft.Json - JSON parsing
- Websocket4net - Websocket client