https://github.com/HypeRate/HypeRate-CSharp

The official C# bindings for the HypeRate WebSocket API
https://github.com/HypeRate/HypeRate-CSharp

Last synced: 4 months ago
JSON representation

The official C# bindings for the HypeRate WebSocket API

• Host: GitHub
• URL: https://github.com/HypeRate/HypeRate-CSharp
• Owner: HypeRate
• License: mit
• Created: 2024-05-09T15:15:00.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-05-15T23:20:18.000Z (9 months ago)
• Last Synced: 2024-08-01T19:33:58.375Z (7 months ago)
• Language: C#
• Homepage:
• Size: 11.7 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Official HypeRate C# bindings

## Usage

1. Set your API token via the `HypeRate.GetInstance().SetApiToken(string newToken)` method

2. Call `HypeRate.GetInstance().Start()` on application startup

3. Call `HypeRate.GetInstance().Connect()` when you want to establish a connection

4. Subscribe to the events you want to receive:

   - Connected

   - Disconnected

   - ChannelJoined

   - ChannelLeft

   - HeartbeatReceived

   - ClipCreated

5. Call `HypeRate.GetInstance().JoinHeartbeatChannel()` with the user device ID for receiving updates of the users heartbeat

6. Call `HypeRate.GetInstance().LeaveHeartbeatChannel()` with the user device ID when you not want to receive further updates of the

   users heartbeat

7. Call `HypeRate.GetInstance().Disonnect()` when you want to close the connection to the server

## Working with device IDs

The `Device` class contains utility functions for working with device IDs (like validating them or extracting them from

user input).