Skip to content

Commit

Permalink
Update README and help message
Browse files Browse the repository at this point in the history
  • Loading branch information
staticfloat committed Jul 31, 2016
1 parent 6284e99 commit 9e302b0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ Then, checkout the sources and run `make` inside the source directory.
Usage
=====

Usage is pretty simple. run `./popuset --help` to see an overview of options, along with example command line usages. Start one server and one client, (clients have the `-r` option specified) and enjoy your audio!
`popuset` implements a fully connectable audio mesh network. Each instance of `popuset` can be instructed to open a single device (for input, output, or both) and listens for incoming connections (on port `5040` by default, settable with the `--port/-p` option). `popuset` instances are targeted at eachother using the `--target/-t` option. To send audio from computer A's microphone to computer B's speakers, you would therefore instruct computer B to open its output device (using the `--device/-d` option). You would then tell computer A to open the microphone audio device (via the `--device/-d` option) and target it at computer B with the `--target/-t` option. Note that multiple `popuset` instances can target the same output instance, and they will all be mixed together in realtime.

You can "log" input/output audio to `.wav` files using the `--log/-l` option. This is useful for debugging, or just recording audio that other users are sending your way.


Raspi notes
Expand All @@ -46,4 +48,4 @@ Finally, download/compile this puppy:
$ git clone https://github.com/staticfloat/popuset.git
$ cd popuset
$ make
```
```
2 changes: 1 addition & 1 deletion popuset.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ void printUsage(char * prog_name) {
printf("\t--log/-l: Prefix of .wav files to log input/output to.\n");
printf("\t--help/-h: Print this help message, along with a device listing.\n\n");

printf("Device strings conform to: <input/output>:<name/numeric id>:<channels>\n");
printf("Device strings conform to: <\"input\"/\"output\">:<device name/numeric id>:<channels>\n");
printf("Defaults: listen on port 5040, open default input/output devices with up to two channels:\n");
printf(" %s -p 5040 -d \"input:%s:%d\" -d \"output:%s:%d\"\n\n", prog_name, input_name, input_channels, output_name, output_channels );

Expand Down

0 comments on commit 9e302b0

Please sign in to comment.