home-assistant.io/source/_components/vlc-telnet.markdown
Rodrigo Pérez a232c7f430 vlc-telnet component documentation added (#9558)
* vlc-telnet component documentation added

* Updated the documentation to the last changes on the PR

* Update source/_components/vlc-telnet.markdown

Co-Authored-By: Klaas Schoute <klaas_schoute@hotmail.com>

* Update source/_components/vlc-telnet.markdown

Co-Authored-By: Klaas Schoute <klaas_schoute@hotmail.com>

* Update source/_components/vlc-telnet.markdown

Co-Authored-By: Klaas Schoute <klaas_schoute@hotmail.com>

* Update source/_components/vlc-telnet.markdown

Co-Authored-By: Klaas Schoute <klaas_schoute@hotmail.com>

* Accepted suggestions by @klaasnicolaas

* Configuration example and firewall recomendation
2019-06-26 21:18:31 -07:00

2.2 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class
layout title description date sidebar comments sharing footer logo ha_category ha_release ha_iot_class
page VLC Telnet Instructions on how to integrate VLC media player into Home Assistant using the telnet interface. 2019-06-02 23:58 true false true true videolan.png
Media Player
0.95 Local Polling

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.

{% linkable_title 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
{% linkable_title Additional configuration for Rasperry Pi %}

You can run a VLC Media Player inside your Hassio installation using the hassio-local-vlc 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 Hassio installation.