tk-sls.de
/
pulseaudio-tcp
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

documentation imporvements (definitions, requirements)

This commit is contained in:
Tilman Kranz 2023-10-10 03:08:05 +02:00
parent 09c91bade9
commit 731c4825e6
1 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -7,23 +7,27 @@
* jq
* Audio subsystem:
- PulseAudio or
- Pipewire with PulseAudio compatibility (`pipewire-pulse`)
- Pipewire with PulseAudio compatibility (`pipewire-pulse`).
- On the local host `pactl` must be of version 16 or later (required for option `--format json`).
### Installation on Client Playback Host
### Requirements to Local and Remote 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 ("remote host") for playback.
- This is refered to as "outbound" audio.
- This computer is in the following referred to as the "local host".
* The local host should use use a remote computer for playback.
- The remote computer is referred to as the "remote host".
- This mode of operation is referred 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.
- This mode of operation is referred to as "inbound" audio.
* The IP address of the remote host and the name of a user running a PulseAudio/Pipewire session there should be known.
* The remote host should allow login by the remote user with SSH.
### SSH to User Session on Remote Host
The user on the local host should have password-less SSH to the user on the remote host (required for encryption with SSH port forwarding).
The user on the local host should have password-less SSH to the user on the remote host (required for encryption with SSH port forwarding):
```shell
ssh-copy-id <remote-user>@<remote-ip>
ssh-copy-id $remote_user@$remote_ip
```
## Installation
@ -38,7 +42,7 @@ sudo make install
### Setup Procedure
As regular user on local host:
A user on local host running the PulseAudio/Pipewire session, execute:
```shell
pulseadio-tcp setup
@ -64,18 +68,24 @@ outbound=true
### Starting the Service
A user on local host running the PulseAudio/Pipewire session, execute:
```shell
pulseadio-tcp start
```
### Stopping the Service
A user on local host running the PulseAudio/Pipewire session, execute:
```shell
pulseadio-tcp stop
```
### Checking if the Service is running
A user on local host running the PulseAudio/Pipewire session, execute:
```shell
pulseadio-tcp status
```