Documentation:Modules/telnet

From VideoLAN Wiki
< Documentation:Modules
Revision as of 08:22, 17 February 2019 by DoesItReallyMatter (talk | contribs) (Write page from scratch. I copied only the command-line options from the program output, adapted for use here)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Module: telnet
Type Control interface
First VLC version -
Last VLC version -
Operating system(s) all
Description Control VLC via a telnet connection
Shortcut(s) -

The telnet module communicates with VLC over a network connection using the telnet protocol. The original module was provided until 1.1.0, when it was re-written in Lua. The old module was renamed to oldtelnet and removed in 2.0.0.

Telnet should not be used for sensitive applications.

To find module information on the command-line for VLC 2.0.0 and above, use vlc -p lua --advanced --help-verbose and look for the Lua Telnet section.

Options as of 3.0.6 are listed below:

  • telnet-host <string> : This is the host on which the interface will listen. It defaults to all network interfaces (0.0.0.0). If you want this interface to be available only on the local machine, enter "127.0.0.1"
  • telnet-port <integer> : This is the TCP port on which this interface will listen default value: 4212
  • telnet-password <string> : A single password restricts access to this interface
  • lua-sd <string> : ?
This page is part of official VLC media player Documentation (User GuideStreaming HowToHacker GuideModules)
Please read the Documentation Editing Guidelines before you edit the documentation
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.