https://github.com/dimtpap/obs-pipewire-audio-capture
🔊 Audio device and application capture for OBS Studio using PipeWire
https://github.com/dimtpap/obs-pipewire-audio-capture
audio linux obs-studio pipewire
Last synced: 4 days ago
JSON representation
🔊 Audio device and application capture for OBS Studio using PipeWire
- Host: GitHub
- URL: https://github.com/dimtpap/obs-pipewire-audio-capture
- Owner: dimtpap
- License: gpl-2.0
- Created: 2022-01-23T08:31:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-14T08:48:35.000Z (2 months ago)
- Last Synced: 2025-02-14T09:24:11.820Z (2 months ago)
- Topics: audio, linux, obs-studio, pipewire
- Language: C
- Homepage: https://obsproject.com/forum/resources/pipewire-audio-capture.1458/
- Size: 264 KB
- Stars: 416
- Watchers: 6
- Forks: 13
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Pop_OS-Guide - OBS PipeWire Audio Capture
- awesome - dimtpap/obs-pipewire-audio-capture - 🔊 Audio device and application capture for OBS Studio using PipeWire (C)
README
# Audio device and application capture for OBS Studio using PipeWire
This plugin adds 3 sources for capturing audio outputs, inputs and applications using [PipeWire](https://pipewire.org)
## Usage
### Requirements
- OBS Studio 28.0 or later
- [WirePlumber](https://pipewire.pages.freedesktop.org/wireplumber/)
PipeWire 0.3.62 or later is highly recommended ([#17](https://github.com/dimtpap/obs-pipewire-audio-capture/issues/17), [PipeWire#2874](https://gitlab.freedesktop.org/pipewire/pipewire/-/issues/2874))
For the plugin to be able to capture applications, PipeWire should be set up to handle audio on your system.
For most applications, the [`pipewire-pulse`](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/FAQ#should-i-uninstall-everything-pulseaudio)
compatibility layer should be enough, but there are also `pipewire-jack` and `pipewire-alsa`.
If applications aren't showing up in the plugin, your system may be missing one of those components.
See the [PipeWire wiki](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/home) for more info.
### Installation
Get the `linux-pipewire-audio-(version).tar.gz` archive from the [latest release](https://github.com/dimtpap/obs-pipewire-audio-capture/releases/latest)
If OBS Studio is installed as a
- Regular package: Extract the archive in `~/.config/obs-studio/plugins/`
Your files should look like this
```
/home/user/.config/obs-studio/plugins
├── linux-pipewire-audio
│ ├── bin
│ │ └── 64bit
│ │ └── linux-pipewire-audio.so
│ └── data
│ └── locale
│ ...
```
- Flatpak:
> [!IMPORTANT]
> ***THIS INSTALLATION METHOD IS UNSUPPORTED BY THE OBS STUDIO TEAM AND CAN BREAK AT ANY TIME***
> This plugin relies on a Flatpak permission that OBS Studio could remove at any time, so it can't be on Flathub.
> If after updating OBS Studio the plugin stops working, check the latest release for a new version, or build the plugin yourself
> against the latest OBS Studio.
>
> Note that native OBS Studio packages do not have this problem.
Extract the archive in `~/.var/app/com.obsproject.Studio/config/obs-studio/plugins/`
Note: If the plugin isn't working run `flatpak override --filesystem=xdg-run/pipewire-0 com.obsproject.Studio`
### Building (for development)
Ensure you have CMake, PipeWire and OBS Studio/libobs development packages, then in the repo's root:
```sh
cmake -B build -DCMAKE_INSTALL_PREFIX="/usr" -DCMAKE_BUILD_TYPE=RelWithDebInfo
cmake --build build
# To install it system-wide:
cmake --install build
```
## Inclusion in upstream OBS Studio
This plugin is currently in the process of being worked on to merge into upstream OBS Studio. See https://github.com/obsproject/obs-studio/pull/6207