update documentation to bidirectional operation
This commit is contained in:
parent
08cfa11451
commit
09c91bade9
33
README.md
33
README.md
@ -1,4 +1,4 @@
|
||||
# pulseaudio-tcp - Redirect PulseAudio to Remote Computer
|
||||
# pulseaudio-tcp - Redirect PulseAudio to and from Remote Computer
|
||||
|
||||
## Requirements
|
||||
|
||||
@ -12,7 +12,10 @@
|
||||
### Installation on Client Playback Host
|
||||
|
||||
* pulseaudio-tcp should be installed on a computer running PulseAudio or Pipewire with PulseAudio compatibility.
|
||||
* The computer pulseaudio-tcp is installed on ("local host") should use use a remote computer that has speakers attached ("remote host") for playback.
|
||||
* The computer pulseaudio-tcp is installed on ("local host") should use use a remote computer ("remote host") for playback.
|
||||
- This is refered to as "outbound" audio.
|
||||
* The local host should receive audio from the remote host for recording.
|
||||
- This is refered to as "inbound" audio.
|
||||
* The IP address and username of the remote host should be known.
|
||||
|
||||
### SSH to User Session on Remote Host
|
||||
@ -33,7 +36,7 @@ sudo make install
|
||||
|
||||
## Usage
|
||||
|
||||
### Configuration
|
||||
### Setup Procedure
|
||||
|
||||
As regular user on local host:
|
||||
|
||||
@ -41,19 +44,37 @@ As regular user on local host:
|
||||
pulseadio-tcp setup
|
||||
```
|
||||
|
||||
### Start service
|
||||
The following questions will be asked:
|
||||
|
||||
* IP address of remote host.
|
||||
* Name of user on remote host running PulseAudio/Pipewire.
|
||||
* Enable inbound audio.
|
||||
* Enable outbound audio.
|
||||
|
||||
### Configuration File
|
||||
|
||||
The setup procedure writes a configuration file `$HOME/.config/pulseaudio-tcp/config.inc.sh`:
|
||||
|
||||
```
|
||||
remote_ip="192.168.1.166"
|
||||
remote_user="remoteuser"
|
||||
inbound=true
|
||||
outbound=true
|
||||
```
|
||||
|
||||
### Starting the Service
|
||||
|
||||
```shell
|
||||
pulseadio-tcp start
|
||||
```
|
||||
|
||||
### Stop service
|
||||
### Stopping the Service
|
||||
|
||||
```shell
|
||||
pulseadio-tcp stop
|
||||
```
|
||||
|
||||
### Check if service is running
|
||||
### Checking if the Service is running
|
||||
|
||||
```shell
|
||||
pulseadio-tcp status
|
||||
|
Loading…
Reference in New Issue
Block a user