-
Notifications
You must be signed in to change notification settings - Fork 0
Usage
McSnurtle edited this page Aug 14, 2025
·
4 revisions
Once the program is installed and setup (see Installation), simply run the scripts as follows, running batch scripts (.bat) on Windows and shell scripts (.sh) for Unix:
Client Configuration File:
| Category | Option | Value |
|---|---|---|
| Networking | server_ip |
The IPv4 of your group call server. |
| Networking | server_port |
The port of your group call server. |
| Audio | chunk_size |
Match server value |
| Audio | mystery_number |
Match server value |
| Audio | sample_rate |
Match server value |
CAUTION: Better compatibility is likely to change the above sample_rate requirement in the future.
Server Configuration File:
There must be one central server the group call is hosted on, with each client connecting to it.
| Category | Option | Value |
|---|---|---|
| Networking | server_ip |
"0.0.0.0" |
| Networking | relay_audio |
true |
| Audio | chunk_size |
Match client options |
| Audio | mystery_number |
Match client |
| Audio | sample_rate |
Match client |
- Both machines have their server's
server_ipset to0.0.0.0. - Both machines have each other's local IPv4 addresses as their clients' target
server_ip. - Both machines have each other's servers' ports as their clients' target
server_port. - It is strongly recommended that both machines have their servers'
relay_audiotofalse. - Both machines share a
chunk_size,mystery_number, andsample_rateto avoid glitchiness. CAUTION: Better compatibility is likely to change this requirement in the future.
To send your microphone data to a server:
- Specify the server's address and port (as given by your server provider) in the
server_ipandserver_portfields ofusr/conf/client.json. - Initiate a connection to the server by running the client script in
scripts/.
To receive all incoming audio traffic on your host machine:
- Specify your server's port in the
server_portfield ofusr/conf/server.json. - Run the server script in
scripts/.