Documentation - RD/ShowCockpit

Control & Integration Made Easy

Driver Documentation for v3.11.0

This page contains documentation of the available drivers.

Video / VideoLAN / VLC - HTTP (API Version 3)

Interface with VLC player through the HTTP interface

< Back to drivers list

    Frequently Asked Questions (FAQs)


What configuration is needed in VLC?

You need to enable the LUA HTTP interface and assign a password:
1. Open VLC
2. Go to Tools->Preferences
3. Show All settings
4. Select "Main interfaces" on the left, and tick the "Web" checkbox
5. Expand "Main interfaces" and click on "Lua"
6. Set a password for Lua HTTP

    Element Options


IP Address

The IP address of the system running VLC

Port

Port

Password

Password

    Functions


Transport Control   Button LUA Script

Triggers a transport control action
  • Transport Control: Select which action to control - one of {Play, Stop, Pause / Resume, Next, Previous}

Fullscreen   Button LUA Script

Triggers a FULLSCREEN action

Loop   Button LUA Script

Triggers a LOOP action

Repeat   Button LUA Script

Triggers a REPEAT action

Play   LUA Script

Executes a PLAY action

Stop   LUA Script

Executes a STOP action

Pause   LUA Script

Executes a PAUSE action

Is Fullscreen   LUA Script

Returns true if VLC is in full screen, false otherwise

Is In Loop   LUA Script

Returns true if VLC is in loop mode, false otherwise

Is In Repeat   LUA Script

Returns true if VLC is in repeat mode, false otherwise

Get File Name   LUA Script

Returns the current file name