home-assistant.github.io/source/_components/media_player.vlc.markdown
Tom Barbette 2d6a719e17 media_player/vlc: More details about inner working (#1671)
- Say that only music is supported
- Explain that it launches a VLC in background and this does not allow to control a GUI instance.
2016-12-29 16:22:47 +01:00

33 lines
902 B
Markdown

---
layout: page
title: "VLC"
description: "Instructions on how to integrate VLC media player into Home Assistant."
date: 2016-11-02 12:02
sidebar: true
comments: false
sharing: true
footer: true
logo: videolan.png
ha_category: Media Player
featured: false
ha_release: 0.35
ha_iot_class: "Local Polling"
---
The `vlc` platform allows you to control [VLC media player](http://www.videolan.org/vlc/index.html).
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 variables:
- **name** (*Optional*): The name to use in the frontend.
Only "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.