home-assistant.io/source/_components/vlc.markdown

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release	ha_iot_class	redirect_from
page	VLC	Instructions on how to integrate VLC media player into Home Assistant.	2016-11-02 12:02	true	false	true	true	videolan.png	Media Player	0.35	Local Polling	/components/media_player.vlc/

The vlc platform allows you to control VLC media player.

To add a VLC media player to your installation, add the following to your configuration.yaml file:

# 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.

{% linkable_title Full configuration %}

A full configuration for VLC could look like the one below:

# Example configuration.yaml entry
media_player:
  - platform: vlc
    name: speaker_1
    arguments: '--alsa-audio-device=hw:1,0'

{% linkable_title 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:

export VLC_PLUGIN_PATH=$VLC_PLUGIN_PATH:/Applications/VLC.app/Contents/MacOS/plugins

{% linkable_title Additional configuration for Rasperry Pi %}

You need to add the homeassistant user to the audio group:

sudo usermod -a -G audio homeassistant

{% linkable_title VLC currently not supported with Hass.io %}

According to the forum topic "How to add VLC into my Hassio", it is not possible to install packages like VLC on Hass.io.