home-assistant.io/source/_integrations/vlc_telnet.markdown
Franck Nijhof fb08878719
Re-branding; part 1 (#12076)
* Re-branding; part 1

* Update source/_docs/configuration/troubleshooting.markdown

Co-Authored-By: Paulus Schoutsen <balloob@gmail.com>

* Update source/_docs/configuration/yaml.markdown

Co-Authored-By: Paulus Schoutsen <balloob@gmail.com>

* Process review suggestions

* Remove Porosity page

* Update source/_docs/z-wave/installation.markdown

Co-Authored-By: Paulus Schoutsen <balloob@gmail.com>

* Process review suggestions

Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>
2020-02-13 19:39:47 +01:00

2.1 KiB

title, description, logo, ha_category, ha_release, ha_iot_class, ha_codeowners
title description logo ha_category ha_release ha_iot_class ha_codeowners
VLC media player Telnet Instructions on how to integrate VLC media player into Home Assistant using the telnet interface. videolan.png
Media Player
0.95 Local Polling
@rodripf

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
media_player:
  - platform: vlc_telnet
    host: IP_ADDRESS
    password: PASSWORD

{% configuration %} name: default: VLC-TELNET description: The name to use in the frontend. required: false type: string pasword: description: The password to control the VLC through the telnet interface. required: true type: string host: description: The hostname or IP address where the VLC Player is running. required: true type: string port: default: 4212 description: The port number where the VLC Player is running. required: false type: integer {% endconfiguration %}

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.

Full configuration

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

# Example configuration.yaml entry
media_player:
  - platform: vlc_telnet
    name: Remote Player
    host: 192.168.1.48
    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.