From 731c4825e6b77c350dcf34382c4b3c8f12d48999 Mon Sep 17 00:00:00 2001 From: Tilman Kranz Date: Tue, 10 Oct 2023 03:08:05 +0200 Subject: [PATCH] documentation imporvements (definitions, requirements) --- README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0ce9e7d..442ba46 100644 --- a/README.md +++ b/README.md @@ -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 @ +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 ```