Skip to content

Commit 5460314

Browse files
committed
docs: update troubleshooting instructions for PipeWire and examples section
1 parent 694f3b4 commit 5460314

1 file changed

Lines changed: 9 additions & 14 deletions

File tree

README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -136,11 +136,11 @@ export CPLUS_INCLUDE_PATH="$CPLUS_INCLUDE_PATH:/opt/homebrew/Cellar/mingw-w64/11
136136
If you receive errors about no default input or output device:
137137

138138
- **Linux/ALSA:** Ensure your user is in the `audio` group and that ALSA is properly configured
139+
- **Linux/PipeWire:** Check that PipeWire is running: `pw-cli info`
139140
- **Linux/PulseAudio:** Check that PulseAudio is running: `pulseaudio --check`
140-
- **Linux/Pipewire:** Check that Pipewire is running: `systemd --user status pipewire`
141-
- **Windows:** Verify your audio device is enabled in Sound Settings
142141
- **macOS:** Check System Preferences > Sound for available devices
143142
- **Mobile (iOS/Android):** Ensure your app has microphone/audio permissions
143+
- **Windows:** Verify your audio device is enabled in Sound Settings
144144

145145
### Buffer Size Issues
146146

@@ -153,19 +153,14 @@ If you experience audio glitches or dropouts:
153153

154154
### Build Errors
155155

156+
If you are unable to build the library:
157+
158+
- Verify you have installed the required development libraries, as documented above
156159
- **ASIO on Windows:** Verify `LIBCLANG_PATH` is set and LLVM is installed
157-
- **ALSA on Linux:** Install development packages: `libasound2-dev` (Debian/Ubuntu) or `alsa-lib-devel` (Fedora)
158-
- **JACK:** Install JACK development libraries before enabling the `jack` feature
159160

160161
## Examples
161162

162-
CPAL comes with several examples demonstrating various features:
163-
164-
- `beep` - Generate a simple sine wave tone
165-
- `enumerate` - List all available audio devices and their capabilities
166-
- `feedback` - Pass input audio directly to output (microphone loopback)
167-
- `record_wav` - Record audio from the default input device to a WAV file
168-
- `synth_tones` - Generate multiple tones simultaneously
163+
CPAL comes with several examples in `examples/`.
169164

170165
Run an example with:
171166
```bash
@@ -174,10 +169,10 @@ cargo run --example beep
174169

175170
For platform-specific features, enable the relevant features:
176171
```bash
177-
cargo run --example beep --features asio # Windows ASIO
178-
cargo run --example beep --features jack # JACK backend
172+
cargo run --example beep --features asio # Windows ASIO backend
173+
cargo run --example beep --features jack # JACK backend
174+
cargo run --example beep --features pipewire # PipeWire backend
179175
cargo run --example beep --features pulseaudio # PulseAudio backend
180-
cargo run --example beep --features pipewire # Pipewire backend
181176
```
182177

183178
## Contributing

0 commit comments

Comments
 (0)