-
-
Notifications
You must be signed in to change notification settings - Fork 198
Added Local Audio Source Provider #2356
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
Torrax
wants to merge
2
commits into
music-assistant:dev
Choose a base branch
from
Torrax:production
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+652
−0
Draft
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Local Audio Source — the AUX-in cable for Music Assistant | ||
|
|
||
| > Local Audio Source is Music Assistant’s **Virtual AUX Input**, letting you capture any audio from your PC (ALSA via arecord) and stream it to any Music Assistant player. | ||
|
|
||
| --- | ||
|
|
||
| ## ✨ What it does | ||
|
|
||
| - **Bring outside audio into Music Assistant.** Use your computer as the bridge. | ||
| - **Any ALSA input.** Line-in jacks, USB audio interfaces, or built-in mic/line sources. | ||
| - **Simple to set up.** Choose the input, start the stream, and it shows up as a source in your players. | ||
| - **Custom source personalization.** Give it your own display name and thumbnail image for a polished, personalized feel in the Music Assistant UI. | ||
|
|
||
| --- | ||
|
|
||
| ## 🧩 Use cases | ||
|
|
||
| - **Quick-Connect Bluetooth Receiver** | ||
| Plug a Quick Connect BT receiver into your PC’s line-in. Anyone can quickly pair their phone without having to confirm the connection, and their music instantly plays across your whole-house system. | ||
|
|
||
| - **Announcements & Paging Microphone** | ||
| Plug in a USB microphone and use it for announcements. Great for paging in a business, office, or house intercom setup. | ||
|
|
||
| - **Vynyl Turntable/Player** | ||
| Connect your turntable (via phono preamp) directly to your PC’s line-in, and enjoy your vinyl collection throughout your Music Assistant ecosystem. | ||
|
|
||
| --- | ||
|
|
||
| ## ✅ Requirements | ||
|
|
||
| - **Music Assistant** server. | ||
| - **Linux host** with ALSA. | ||
| - A capture device (line-in, USB interface, mic, etc). | ||
|
|
||
| --- | ||
|
|
||
| ## ⚙️ Configuration | ||
|
|
||
| - **Display Name** – what shows up in source lists. | ||
| - **Thumbnail Image (URL)** – optional icon. | ||
| - **Audio Input Device** – detected ALSA devices or manual entry (`alsa:hw:X,Y`). | ||
| - **Sample Rate** – 44.1kHz or 48kHz. | ||
| - **Channels** – mono or stereo. | ||
| - **Period/Buffer (µs)** – tuning for latency vs stability. | ||
|
|
||
| > ℹ️ Run `arecord -l` to list devices. | ||
|
|
||
| --- | ||
|
|
||
| ## ▶️ Using it | ||
|
|
||
| 1. Select **Local Audio Source** as the input on your player. | ||
| 2. Start playback—it streams live from your chosen device. | ||
| 3. Stop when done; the plugin cleans up automatically. | ||
|
|
||
| --- | ||
|
|
||
| ## 📦 Docker notes | ||
|
|
||
| If you’re running Music Assistant in Docker, you need to give the container access to your audio devices. | ||
|
|
||
| ### ALSA devices | ||
| ```yaml | ||
| services: | ||
| music-assistant: | ||
| image: ghcr.io/music-assistant/server:latest | ||
| devices: | ||
| - /dev/snd:/dev/snd # forward ALSA devices | ||
| group_add: | ||
| - "audio" | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.