/StreamElementsNET

Repository for library that reads from StreamElements websocket event server.

Primary LanguageC#MIT LicenseMIT

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("<JWT-TOKEN>");

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

Libraries

  • Newtonsoft.Json - JSON parsing
  • Websocket4net - Websocket client

Contributors

License

MIT License. © 2021 Cole