The Lua VideoLAN Manager wrapper.

Availability

The VLM Object

Object that provides access to VLM methods.
NOTE: If the VLM object is deleted and one last reference remains to it in the script, all VLM items will be deleted.

vlm()

Instantiate a VLM object.

Return value

VLM object instance

vlm:execute_command()

Execute a VLM command by passing it to the VLM shell.

Usage

local v = vlc.vlm()
local msg = v:execute_command("show media") -- displays a summary of media states
if msg.children and #msg.children > 0 then
	for i,c in pairs(msg.children) do
		vlc.msg.info("Media State #" .. i .. ": " .. c)
	end
end

Parameters

• cmd String containing the command to be executed (must follow VLM command line syntax)

Return value

Returns a message table with the following fields:

• "name" String containing the name of the message/command
• "value" String value of the message (not included in message table
• "children" List of children, where each child is its own message table

NOTE: "value" and "children" fields are included only if they are available.