Skip to content

Commit 6d19b7a

Browse files
jij-workJonas Holmberg
authored andcommitted
audio: Correct the code comments
Co-authored-by: Jonas Holmberg <[email protected]>
1 parent 3973f5d commit 6d19b7a

File tree

2 files changed

+11
-13
lines changed

2 files changed

+11
-13
lines changed

audio-capture/app/audiocapture.c

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,19 @@
2020
* This application is a basic pipewire application using a pipewire mainloop to
2121
* process audio data.
2222
*
23-
* The application starts an audio stream and calculates the peak values for
24-
* all of all samples for all channels over a 5 second interval and prints them
25-
* to the system log. The log messages can be followed with the command:
23+
* The application starts an audio stream and calculates the peak sample values
24+
* for all channels of all nodes over a 5 second interval and prints them to the
25+
* system log. The log messages can be followed with the command:
2626
*
2727
* journalctl -t audiocapture -f
2828
*
29-
* The application expects one argument on the command line which is the name of
30-
* the pipewire node to capture audio from.
29+
* The application listens for registry events to find the nodes to capture
30+
* audio from.
3131
*
3232
* Suppose that you have gone through the steps of installation. Then you can
3333
* also run it on your device like this:
3434
*
35-
* /usr/local/packages/audiocapture/audiocapture \
36-
* AudioDevice0Input0.Unprocessed
35+
* /usr/local/packages/audiocapture/audiocapture
3736
*
3837
* and then the output will go to stderr instead of the system log.
3938
*/

audio-playback/app/audioplayback.c

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,18 @@
2020
* This application is a basic pipewire application using a pipewire mainloop to
2121
* process audio data.
2222
*
23-
* The application starts an audio stream that plays a sine tone. The log
24-
* messages can be followed with the command:
23+
* The application starts an audio stream for each output node that plays a sine
24+
* tone. The log messages can be followed with the command:
2525
*
2626
* journalctl -t audioplayback -f
2727
*
28-
* The application expects one argument on the command line which is the name of
29-
* the pipewire node to play audio to.
28+
* The application listens for registry events to find the nodes to play audio
29+
* to.
3030
*
3131
* Suppose that you have gone through the steps of installation. Then you can
3232
* also run it on your device like this:
3333
*
34-
* /usr/local/packages/audioplayback/audioplayback \
35-
* AudioDevice0Output0
34+
* /usr/local/packages/audioplayback/audioplayback
3635
*
3736
* and then the output will go to stderr instead of the system log.
3837
*/

0 commit comments

Comments
 (0)