|
1 |
| -[](https://www.nuget.org/packages/mixer-client-csharp) [](https://travis-ci.org/SaviorXTanren/mixer-client-csharp) |
| 1 | +[](https://travis-ci.org/SaviorXTanren/StreamingClientLibrary) |
| 2 | +Mixer: [](https://www.nuget.org/packages/StreamingClientLibrary.Mixer) |
| 3 | +Twitch: [](https://www.nuget.org/packages/StreamingClientLibrary.Twitch) |
| 4 | +YouTube: [](https://www.nuget.org/packages/StreamingClientLibrary.YouTube) |
2 | 5 |
|
3 |
| -# mixer-client-csharp |
4 |
| -A C# client library for the Mixer streaming service |
| 6 | +# StreamingClientLibrary |
| 7 | +C# client library for Mixer, Twitch, & YouTube streaming services |
5 | 8 |
|
6 | 9 | ## What is this?
|
7 |
| -Unsatisfied with the current set of APIs that exist to interact with Mixer, I took some time to build and design an API set in C# to interact with the service. This API set can be used by anyone to build out any apps they wish to use and it’s very easy to setup. |
| 10 | +When this project was initially created, it was made to fill a gap that existed with lack of a .NET-based library for interaction with Mixer. As time has gone on, the project has added support for additional streaming sites and strives to build a "one-stop shop" to interact with variety of different sites in a consistent manner. |
8 | 11 |
|
9 | 12 | ## Requirements
|
10 | 13 | This library uses the native WebSocket support found in Windows 8 & higher. This means that any application that uses this library must be running Windows 8 or higher.
|
11 | 14 |
|
12 | 15 | ## Current functionality
|
13 |
| -We have must of the most common usage scenarios completed, including: |
14 |
| -- The most common REST APIs for Channels, Chat, Interactive, and Users services |
15 |
| -- WebSocket-based clients to use Chat, Interactive, and Constellation features |
16 |
| -- Various OAuth logic flows to allow your application to authenticate with the Mixer endpoints and handle authorization scopes |
17 |
| -- Unit tests and sample applications to document and show usage of all functionality |
18 |
| - |
19 |
| -## Feature roadmap |
20 |
| -These are the current planned features to be developed in priority order: |
21 |
| -- Add ViewModels to all APIs to make ramp-up development work easier and put less focus on knowing the dev docs top-to-bottom |
22 |
| -- Continue filling out REST API services with less-common methods |
23 |
| -- Add full documentation to github for API usage |
| 16 | +All of the most common APIs are available across all sites. We've also added support for the various other forms of connections for each site: |
| 17 | +- Chat/Constellation/MixPlay WebSockets for Mixer |
| 18 | +- Chat IRC for Twitch, PubSub WebSockets for Twitch |
| 19 | + |
| 20 | +## Future plans |
| 21 | +Currently each streaming site is a dedicated library and project to help keep dependencies down. This allows you |
24 | 22 |
|
25 | 23 | ## How do I get started using it?
|
26 |
| -Download the NuGet package by searching for "mixer-client-csharp" or downloading it manually from https://www.nuget.org/packages/mixer-client-csharp. There are two sample apps created the help showcase some the setup needed and how to use the APIs. Additionally, there are a large serious of unit tests that go through all of the individual functionality that you can look at. I plan on creating more formal documentation soon. |
| 24 | +Download the appropriate NuGet package based on the streaming site you want to work with: |
| 25 | + |
| 26 | +Mixer: https://www.nuget.org/packages/StreamingClientLibrary.Mixer |
| 27 | +Twitch: https://www.nuget.org/packages/StreamingClientLibrary.Twitch |
| 28 | +YouTube: https://www.nuget.org/packages/StreamingClientLibrary.YouTube |
| 29 | + |
| 30 | +There are sample apps available in this repository for each of the different streaming sites that you can reference for some of the more common scenarios. Additionally, there are a large series of unit tests that go through all of the individual functionality that you can look at. |
27 | 31 |
|
28 | 32 | ## I found a bug, who do I contact?
|
29 |
| -Just head over to the https://github.com/SaviorXTanren/mixer-client-csharp/issues page and create a new issue. |
| 33 | +Just head over to the https://github.com/SaviorXTanren/StreamingClientLibrary/issues page and create a new issue. |
30 | 34 |
|
31 | 35 | ## I have a new feature idea!
|
32 |
| -Submit feature requests at the https://github.com/SaviorXTanren/mixer-client-csharp/issues page or feel free to develop the feature yourself and submit a pull request at https://github.com/SaviorXTanren/mixer-client-csharp/pulls! I'm happy to assist anyone if they're interested in developing something as well. |
| 36 | +Submit feature requests at the https://github.com/SaviorXTanren/StreamingClientLibrary/issues page or feel free to develop the feature yourself and submit a pull request at https://github.com/SaviorXTanren/StreamingClientLibrary/pulls. |
33 | 37 |
|
34 | 38 | ## License
|
35 | 39 | MIT License
|
36 | 40 |
|
37 |
| -Copyright (c) 2017-2018 Matthew Olivo |
| 41 | +Copyright (c) 2017-2020 Matthew Olivo |
38 | 42 |
|
39 | 43 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
40 | 44 |
|
41 | 45 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
42 | 46 |
|
43 |
| -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 47 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
0 commit comments