mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-15 21:36:52 +00:00
Created a documentation page for the pulseaudio_loopback switch.
This commit is contained in:
parent
36f1ad2f07
commit
e6c9b47b2c
50
source/_components/switch.pulseaudio_loopback.markdown
Normal file
50
source/_components/switch.pulseaudio_loopback.markdown
Normal file
@ -0,0 +1,50 @@
|
||||
---
|
||||
layout: page
|
||||
title: "PulseAudio Loopback Switch"
|
||||
description: "Instructions how to use Pulseaudio loopback modules to build a flexible whole-home audio system."
|
||||
date: 2016-03-22 21:00:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: pulseaudio.png
|
||||
ha_category: Switch
|
||||
---
|
||||
|
||||
|
||||
The goal behind this switch is to allow a very flexible whole home audio system based upon PulseAudio.
|
||||
|
||||
For example, for a system with a 7.1 surround sound card, and 3 instances of mpd running, it is possible to quickly route the output of any mpd instance to any of the 8 possible (4 stereo) channels on the sound card, by loading/unloading a loopback module. This loading/unloading functionality is provided by this component. When the switch is 'on', the loopback module is loaded. When the switch is 'off', the module is not loaded.
|
||||
|
||||
The benefit of this approach is that this audio routing can occur without modifying the design-time configuration of mpd or PulseAudio.
|
||||
|
||||
This component uses a TCP connection to control a local or remote PulseAudio server- so there are no local dependencies.
|
||||
|
||||
To enable this switch, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
platform: pulseaudio_loopback
|
||||
name: mpd1 -> bedroom
|
||||
host: 127.0.0.1
|
||||
port: 4712
|
||||
source_name: mpd1.monitor
|
||||
sink_name: bedroom
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **sink_name** (*Required*): The name of the Pulseaudio sink that will recieve the audio.
|
||||
- **source_name** (*Required*): The name of the Pulseaudio source that will supply the audio.
|
||||
- **name** (*Optional*): Name of the switch.
|
||||
- **host** (*Optional*): The IP address or host name of the PulseAudio server. If not specified, 127.0.0.1 is used.
|
||||
- **port** (*Optional*): The port that Pulseaudio is listening on. Defaults to 4712.
|
||||
- **buffer_size** (*Optional*): How much data to load from Pulseaudio at once. Default is 1KB.
|
||||
- **tcp_timeout** (*Optional*): How long to wait for a response from Pulseaudio before giving up. Default is 3 seconds.
|
||||
|
||||
<p class='note warning'>
|
||||
This component relies on raw TCP commands to PulseAudio. In order for PulseAudio to accept commands with
|
||||
this component, module-cli-protocol must be loaded on the PulseAudio server.
|
||||
</p>
|
||||
|
1
source/components/switch.pulseaudio_loopback.html
Normal file
1
source/components/switch.pulseaudio_loopback.html
Normal file
@ -0,0 +1 @@
|
||||
<script>document.location = '/components/switch.pulseaudio_loopback/';</script>
|
BIN
source/images/supported_brands/pulseaudio.png
Normal file
BIN
source/images/supported_brands/pulseaudio.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 11 KiB |
Loading…
x
Reference in New Issue
Block a user