VLC media player Telnet

The vlc_telnet platform allows you to control a VLC media player using the built in telnet interface.

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

# Example configuration.yaml entry
  - platform: vlc_telnet
    host: IP_ADDRESS
    password: PASSWORD

Configuration Variables

name string (Optional, default: VLC-TELNET)

The name to use in the frontend.

password string Required

The password to control the VLC through the telnet interface.

host string Required

The hostname or IP address where the VLC Player is running.

port integer (Optional, default: 4212)

The port number where the VLC Player is running.

Only the “music” media type is supported for now.

This service will control any instance of VLC player on the network with the telnet interface activated. To activate the telnet interface on your VLC Player please read the official VLC documentation. Also remember to add a firewall rule allowing inbound connections for the port used in the device running VLC.

In case the VLC is running on a host with a locale other than English, you may get some errors during the volume change. This is related to the different use of the decimal separator in other countries. Consider to set the locale to en_US before starting VLC.

Full configuration

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

# Example configuration.yaml entry
  - platform: vlc_telnet
    name: Remote Player
    port: 4212
    password: your-secure-password

Home Assistant Add-on

You can run a VLC Media Player on your Home Assistant installation using the a community provided add-on. Using it you can play files on the local network, Internet or files and playlist locally saved to the /share folder of your Home Assistant installation.