|
11 | 11 | > This library is **NOT** affiliated in any way with **SteelSeries** |
12 | 12 | > I've made it because it was interesting and funny to do, also I wanted to share this project for people to use it for their own projects |
13 | 13 |
|
14 | | -This library allows you to take control over the SteelSeries GG app. |
| 14 | +This library allows you to take control over the SteelSeries GG app (only Sonar for now). |
15 | 15 |
|
16 | | -The API is available via a [nuget package](https://www.nuget.org/packages/Steelseries-NET-API). |
| 16 | +The library is available via a [nuget package](https://www.nuget.org/packages/Steelseries-NET-API). |
17 | 17 | It is also available in the [Releases](https://github.com/mpaperno/SteelSeries-NET-API/releases) tab as a .zip archive for each supported .NET version. |
18 | 18 |
|
19 | 19 | ## Features |
20 | 20 | - Full Sonar control |
| 21 | + - Mode |
| 22 | + - Volume |
| 23 | + - Mute |
| 24 | + - ChatMix |
| 25 | + - Configs (Can't edit a config) |
| 26 | + - Playback Devices |
| 27 | + - Streamer mode Personal & Stream Mixes |
| 28 | + - Streamer mode Audience Monitoring |
21 | 29 |
|
22 | 30 | ## Getting Started |
23 | 31 | To get started, you only need to create a Sonar Object. |
24 | 32 | `````csharp |
25 | 33 | // Create Sonar object |
26 | 34 | SonarBridge sonarManager = new SonarBridge(); |
27 | 35 |
|
| 36 | +// Wait for GG to start before continuing |
| 37 | +sonarManager.WaitUntilSteelSeriesStarted(); |
| 38 | + |
28 | 39 | // Wait for sonar to start before continuing |
29 | 40 | sonarManager.WaitUntilSonarStarted(); |
30 | 41 |
|
31 | 42 | // Start listening to Sonar Events (optional and require admin rights) |
32 | 43 | sonarManager.StartListener(); |
33 | 44 | sonarManager.SonarEventManager.OnSonarModeChange += OnModeChangeHandler; // Register event |
34 | 45 |
|
35 | | -Mode currentMode = sonarManager.GetMode(); // Returns the current mode |
36 | | -sonarManager.SetVolume(0.5, Device.Game); // Set the Game Device volume |
| 46 | +Mode currentMode = sonarManager.Mode.Get(); // Returns the current mode |
| 47 | +sonarManager.VolumeSettings.SetVolume(0.5, Device.Game); // Set the Game Device volume |
37 | 48 | ... |
38 | 49 | ````` |
39 | | -For more example, you can check the [Tests](https://github.com/DataNext27/SteelSeries-NET-API/tree/main/SteelSeriesAPI.Tests) and the [Sample](https://github.com/DataNext27/SteelSeries-NET-API/tree/main/SteelSeriesAPI.Sample) folders. |
| 50 | +For more example, you can check the [Sample](SteelSeriesAPI.Sample/Program.cs) and the [Tests](SteelSeriesAPI.Tests/Program.cs) folders. |
40 | 51 | If you need any sort of Documentation, go check the [Repo's Wiki](https://github.com/DataNext27/SteelSeries-NET-API/wiki) for more information. |
41 | 52 |
|
42 | | -### Some Vocabulary |
43 | | -- Mode : Classic/Stream |
44 | | -- Device : Master/Game/Chat/Media/Aux/Mic |
45 | | -- Channel : *(Streamer mode)* Monitoring/Stream |
46 | | -- Audio Configs : It's in the name |
47 | | -- Redirection States : *(Streamer mode)* Button above sliders to un/mute a channel of a device |
48 | | -- Redirection Device : Device where the sound got by GG is redirected (your headset for example) |
49 | | - |
50 | 53 | ## Todo |
51 | | -(Actually not possible, maybe one day i guess :/ ) |
| 54 | +(Actually not planned as not possible, maybe one day I guess :/ ) |
52 | 55 | - Moments |
53 | 56 | - Engine |
54 | 57 | - Settings |
|
0 commit comments