OrbitComms-Server

OrbitComms Server is the server side of the OrbitComms Project, developped in Node JS.

Interact with the server

Ask for a WebSocket token

In order to get a new WebSocket token, you need to send a POST request to the server with the following body:

{
    "username": "your_username",
    "password": "your_password"
}

If valid, the server will respond with the Token.

Send Datas

Message Structure

All messages follow this structure:

{
  "type": "message_type",
  "data": { }
}

Message Types

1. audio_data

This type is used to send real-time audio data.

Expected data structure:

{
  "chan": "channel_name",
  "bytes": "audio_data"
}

2. channel_data

This type is used to manage user actions within a channel.

Expected data structure:

{
  "chan": "channel_name",
  "command": "join" | "leave" | "mute" | "priority"
}

3. permissions

This type is used to modify user permissions. (This requires admin permissions)

Expected data structure:

{
  "target": "target_player_name",
  "modifier": {
    "level": "permission_level",
    "chan": "channel_name" (optional)
  }
}

4. channels

This type is used to manage channel operations. (This requires admin permissions)

Expected data structure:

{
  "type": "add" | "delete" | "force_delete" | "change_default",
  "name": "channel_name" (for `add`),
  "chan": "channel_name" (for `delete` and `force_delete`),
  "level": "permission_level" (for `change_default` or optional for `add`)
}

Data from server to client

1. audio_data

This type is used to send real-time audio data.

Expected data structure:

{
  "chan": "channel_name",
  "bytes": "audio_data"
}

2. request_success

This type is used to confirm that a request has been successfully processed.

Expected data structure:

{
  "message": "success_message"
}

3. request_denied

This type is used to confirm that a request has been denied.

Expected data structure:

{
  "reason": "denied_message"
}

4. permission_updated

This type is used to notify the client that his permissions have been updated. One of these messages carries one modified permission. For several permissions, several messages will be sent.

Expected data structure:

{
  "level": "permission_level",
  "chan": "channel_name" (optional)
}