2024.12.5
Home ▸ Integrations ▸

VLC media player via Telnet

The VLC media player via Telnet integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to control a VLC media player using the built in telnet interface.

This action 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.

Configuration

To add the VLC media player via Telnet integration to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select VLC media player via Telnet.

  • Follow the instructions on screen to complete the setup.

Actions

When using the media_player.play_media action, only the “music” media type is supported for now.

Home Assistant add-on

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