Skip to content

Commit 298c4b8

Browse files
committed
Update README.md
1 parent 2fb0c3d commit 298c4b8

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,44 +11,47 @@
1111
> This library is **NOT** affiliated in any way with **SteelSeries**
1212
> 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
1313
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).
1515

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).
1717
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.
1818

1919
## Features
2020
- 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
2129

2230
## Getting Started
2331
To get started, you only need to create a Sonar Object.
2432
`````csharp
2533
// Create Sonar object
2634
SonarBridge sonarManager = new SonarBridge();
2735

36+
// Wait for GG to start before continuing
37+
sonarManager.WaitUntilSteelSeriesStarted();
38+
2839
// Wait for sonar to start before continuing
2940
sonarManager.WaitUntilSonarStarted();
3041

3142
// Start listening to Sonar Events (optional and require admin rights)
3243
sonarManager.StartListener();
3344
sonarManager.SonarEventManager.OnSonarModeChange += OnModeChangeHandler; // Register event
3445
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
3748
...
3849
`````
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.
4051
If you need any sort of Documentation, go check the [Repo's Wiki](https://github.com/DataNext27/SteelSeries-NET-API/wiki) for more information.
4152

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-
5053
## Todo
51-
(Actually not possible, maybe one day i guess :/ )
54+
(Actually not planned as not possible, maybe one day I guess :/ )
5255
- Moments
5356
- Engine
5457
- Settings

0 commit comments

Comments
 (0)