mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-21 18:36:48 +00:00
a4a68172c0
* u-z integrations: apply sentence-style caps to categories * Apply suggestions from code review Co-authored-by: Joakim Sørensen <joasoe@gmail.com> * Add references to glossary terms * Update source/_integrations/universal.markdown Co-authored-by: Joakim Sørensen <joasoe@gmail.com> * Update source/_integrations/universal.markdown Co-authored-by: Joakim Sørensen <joasoe@gmail.com> * linter: change vizio to VIZIO - as per product website https://www.vizio.com/en/smartcast * remove term refs from YAML * VIZIO: change spelling according to website - https://www.vizio.com/en/t * Update source/_integrations/vizio.markdown * Update source/_integrations/universal.markdown * Apply suggestions from code review Co-authored-by: Joakim Sørensen <joasoe@gmail.com> * Update source/_integrations/unifiprotect.markdown Co-authored-by: Joakim Sørensen <joasoe@gmail.com> * Apply suggestions from code review Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> * Apply suggestions from code review Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> * Fix some more to sentence-style caps * Update source/_integrations/unifiprotect.markdown Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> * Update source/_integrations/unifiprotect.markdown Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> * Update source/_integrations/unifiprotect.markdown Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> --------- Co-authored-by: Joakim Sørensen <joasoe@gmail.com> Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
74 lines
1.9 KiB
Markdown
74 lines
1.9 KiB
Markdown
---
|
||
title: VLC media player
|
||
description: Instructions on how to integrate VLC media player into Home Assistant.
|
||
ha_category:
|
||
- Media player
|
||
ha_release: 0.35
|
||
ha_iot_class: Local Polling
|
||
ha_domain: vlc
|
||
ha_platforms:
|
||
- media_player
|
||
ha_integration_type: integration
|
||
---
|
||
|
||
The `vlc` platform allows you to control [VLC media player](https://www.videolan.org/vlc/index.html).
|
||
|
||
<div class='note'>
|
||
|
||
The **VLC media player** {% term integration %}, is currently only available for installations that are based on the Home Assistant Core in a Python virtual environment.
|
||
|
||
</div>
|
||
|
||
## Configuration
|
||
|
||
To add a VLC media player to your installation, add the following to your `configuration.yaml` file:
|
||
|
||
```yaml
|
||
# Example configuration.yaml entry
|
||
media_player:
|
||
- platform: vlc
|
||
```
|
||
|
||
{% configuration %}
|
||
name:
|
||
description: The name to use in the frontend.
|
||
required: false
|
||
type: string
|
||
arguments:
|
||
description: Additional arguments to be passed to VLC.
|
||
required: false
|
||
type: string
|
||
{% endconfiguration %}
|
||
|
||
Only the "music" media type is supported for now.
|
||
|
||
This service will control a background VLC instance, therefore you cannot use this to control a VLC instance launched on your desktop, unlike the Kodi media player for example.
|
||
|
||
## Full configuration
|
||
|
||
A full configuration for VLC could look like the one below:
|
||
|
||
```yaml
|
||
# Example configuration.yaml entry
|
||
media_player:
|
||
- platform: vlc
|
||
name: speaker_1
|
||
arguments: "--alsa-audio-device=hw:1,0"
|
||
```
|
||
|
||
## Additional configuration on macOS
|
||
|
||
On macOS `python-vlc` won’t find the VLC plugin directory unless you add this to the user’s `.bash_profile` that is running Home Assistant:
|
||
|
||
```bash
|
||
export VLC_PLUGIN_PATH=$VLC_PLUGIN_PATH:/Applications/VLC.app/Contents/MacOS/plugins
|
||
```
|
||
|
||
## Additional configuration on Linux
|
||
|
||
You need to add the `homeassistant` user to the `audio` group:
|
||
|
||
```bash
|
||
sudo usermod -a -G audio homeassistant
|
||
```
|