mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Add vlc_telnet config flow (#19733)
This commit is contained in:
parent
483613a0e2
commit
818f786454
@ -8,6 +8,8 @@ ha_iot_class: Local Polling
|
|||||||
ha_codeowners:
|
ha_codeowners:
|
||||||
- '@rodripf'
|
- '@rodripf'
|
||||||
- '@dmcc'
|
- '@dmcc'
|
||||||
|
- '@MartinHjelmare'
|
||||||
|
ha_config_flow: true
|
||||||
ha_domain: vlc_telnet
|
ha_domain: vlc_telnet
|
||||||
ha_platforms:
|
ha_platforms:
|
||||||
- media_player
|
- media_player
|
||||||
@ -15,59 +17,18 @@ ha_platforms:
|
|||||||
|
|
||||||
The `vlc_telnet` platform allows you to control a [VLC media player](https://www.videolan.org/vlc/index.html) using the built in telnet interface.
|
The `vlc_telnet` platform allows you to control a [VLC media player](https://www.videolan.org/vlc/index.html) using the built in telnet interface.
|
||||||
|
|
||||||
To add a VLC media player to your installation, add the following to your `configuration.yaml` file:
|
This service will control any instance of VLC player on the network with the telnet interface activated.
|
||||||
|
|
||||||
```yaml
|
|
||||||
# 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
|
|
||||||
password:
|
|
||||||
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](https://wiki.videolan.org/Documentation:Modules/telnet/). Also remember to add a firewall rule allowing inbound connections for the port used in the device running VLC.
|
To activate the telnet interface on your VLC Player please read the [official VLC documentation](https://wiki.videolan.org/Documentation:Modules/telnet/). 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.
|
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.
|
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.
|
Consider to set the locale to `en_US` before starting VLC.
|
||||||
|
|
||||||
## Full configuration
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
A full configuration for VLC could look like the one below:
|
## Services
|
||||||
|
|
||||||
```yaml
|
When using the `media_player.play_media` service, only the "music" media type is supported for now.
|
||||||
# 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
|
## Home Assistant Add-on
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user