### Minimal LibVLC Example

Source: https://github.com/videolan/vlc/blob/master/doc/standalone/libvlc.md

This C code snippet demonstrates a minimal example of using LibVLC for basic functionality. Ensure LibVLC is properly installed and configured before running.

```c
#include <stdio.h>
#include <vlc/vlc.h>

int main(int argc, char* argv[])
{
    libvlc_instance_t *instance;
    libvlc_media_player_t *mp;
    libvlc_media_t *media;

    // Load the VLC core
    instance = libvlc_create_instance(NULL);

    // Create a new media player
    mp = libvlc_media_player_new_from_file(instance, "/path/to/your/media.mp4", NULL);

    // Play the media
    libvlc_media_player_play(mp);

    // Wait for the media to finish playing (or for user interruption)
    // In a real application, you would use event handling or a more sophisticated loop.
    // For this minimal example, we'll just sleep for a bit.
    #ifdef _WIN32
        Sleep(30000); // Sleep for 30 seconds on Windows
    #else
        sleep(30); // Sleep for 30 seconds on POSIX systems
    #endif

    // Stop the player
    libvlc_media_player_stop(mp);

    // Release the media player
    libvlc_media_player_release(mp);

    // Release the instance
    libvlc_release_instance(instance);

    return 0;
}
```

--------------------------------

### Fetch and Install Prebuilt Binaries

Source: https://github.com/videolan/vlc/blob/master/contrib/src/help.txt

Execute 'make prebuilt' to download and install prebuilt binary packages for VLC.

```makefile
make prebuilt
```

--------------------------------

### Install VLC

Source: https://github.com/videolan/vlc/blob/master/contrib/src/help.txt

Use 'make install' to install VLC after compilation. This target performs the same action as 'make'.

```makefile
make install
```

--------------------------------

### Define Package Build and Install Rule

Source: https://github.com/videolan/vlc/blob/master/contrib/src/README.md

Defines the Makefile target for building and installing the package. This rule depends on the source directory being ready and executes configuration, build, and install steps.

```makefile
.foo: libfoo
	$(MAKEBUILDDIR)
	$(MAKECONFIGURE)
	+$(MAKEBUILD)
	+$(MAKEBUILD) install
	touch $@
```

--------------------------------

### Install Ubuntu/WSL Dependencies for VLC

Source: https://github.com/videolan/vlc/blob/master/doc/BUILD-win32.md

Installs essential development packages on Ubuntu or WSL required for compiling VLC. Ensure you have git, wget, and build tools installed.

```bash
sudo apt-get update -qq
sudo apt-get install -qqy \
    git wget bzip2 file libwine-dev unzip libtool libtool-bin libltdl-dev pkg-config ant \
    build-essential automake texinfo yasm p7zip-full autopoint \
    gettext cmake zip wine nsis g++-mingw-w64-i686 curl gperf flex bison \
    libcurl4-gnutls-dev python3 python3-setuptools python3-mako python3-requests python3-venv \
    gcc make procps ca-certificates \
    openjdk-11-jdk-headless nasm jq gnupg \
    meson autoconf
```

--------------------------------

### Install mingw-w64 toolchain on MSYS2

Source: https://github.com/videolan/vlc/blob/master/doc/BUILD-win32.md

Installs the mingw-w64 x86_64 toolchain using pacman on MSYS2. It prompts for package selection, with 'all' being the default.

```sh
pacman -S mingw-w64-x86_64-toolchain
> :: Repository mingw64
   1) mingw-w64-x86_64-binutils  2) mingw-w64-x86_64-crt-git  3) mingw-w64-x86_64-gcc  4) mingw-w64-x86_64-gcc-ada  5) mingw-w64-x86_64-gcc-fortran  6) mingw-w64-x86_64-gcc-libgfortran  7) mingw-w64-x86_64-gcc-libs  8) mingw-w64-x86_64-gcc-objc
   9) mingw-w64-x86_64-gdb  10) mingw-w64-x86_64-gdb-multiarch  11) mingw-w64-x86_64-headers-git  12) mingw-w64-x86_64-libgccjit  13) mingw-w64-x86_64-libmangle-git  14) mingw-w64-x86_64-libwinpthread-git  15) mingw-w64-x86_64-make  16) mingw-w64-x86_64-pkgconf
   17) mingw-w64-x86_64-tools-git  18) mingw-w64-x86_64-winpthreads-git  19) mingw-w64-x86_64-winstorecompat-git
> Enter a selection (default=all):

Type enter to select "all"
```

--------------------------------

### Install mingw-w64 GCC on Linux

Source: https://github.com/videolan/vlc/blob/master/doc/BUILD-win32.md

Installs the mingw-w64 GCC toolchain on Debian-based Linux systems for cross-compiling VLC.

```sh
sudo apt-get install -qqy \
        gcc-mingw-w64-x86-64 g++-mingw-w64-x86-64 mingw-w64-tools
```

--------------------------------

### Example of Adding a Label with Position and Span

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Demonstrates how to add a label widget to a dialog, specifying its position (row, column) and size (column span, row span) within the grid layout. Note that row and column numbering starts from 1.

```lua
w = d:add_label( "My Label", 2, 3, 4, 5 )
```

--------------------------------

### Get VLC License

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the VLC license information.

```lua
misc.license()
```

--------------------------------

### Get VLC Version

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the VLC version string.

```lua
misc.version()
```

--------------------------------

### Compile VLC

Source: https://github.com/videolan/vlc/blob/master/contrib/src/help.txt

Run 'make' to start the compilation process for VLC. This is the primary command for building the project.

```makefile
make
```

--------------------------------

### Install MSYS2 Dependencies for VLC

Source: https://github.com/videolan/vlc/blob/master/doc/BUILD-win32.md

Installs necessary packages on MSYS2 for compiling VLC. This command updates the package database and installs required development tools.

```bash
pacman -Syu
pacman -S --needed git wget bzip2 file unzip libtool pkg-config \
    automake autoconf texinfo yasm p7zip \
    gettext cmake zip curl gperf flex bison \
    python3 python3-setuptools python3-mako \
    gcc make ca-certificates nasm gnupg patch help2man \
    python3 meson
```

--------------------------------

### Setup Meson with Native Contribs

Source: https://github.com/videolan/vlc/blob/master/doc/standalone/buildsystem.md

Configure the Meson build with native dependencies provided by the contrib system. This command specifies the path to the generated meson machine file.

```bash
meson setup build-meson \
    --native-file contrib/x86_64-pc-linux-gnu/share/meson/native/contrib.ini
```

--------------------------------

### Setup Meson with Cross-Compiling and Contribs

Source: https://github.com/videolan/vlc/blob/master/doc/standalone/buildsystem.md

Set up Meson for cross-compilation, including both a crossfile and the contrib machine file. This allows building for different target platforms with external dependencies.

```bash
meson setup build-meson --cross-file win32.crossfile \
    --cross-file contrib/x86_64-w64-mingw32/share/meson/cross/contrib.ini
```

--------------------------------

### Adding a VLC Module with Meson

Source: https://github.com/videolan/vlc/blob/master/doc/standalone/buildsystem.md

Provides an example of how to add a new VLC module using Meson's dictionary syntax, specifying its name and source files.

```meson
vlc_modules += {
    'name' : 'file_logger',
    'sources' : files('file.c')
}
```

--------------------------------

### Play Media

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Starts or resumes playback of the current media item in the playlist.

```lua
playlist.play()
```

--------------------------------

### VLM Configuration File Example

Source: https://github.com/videolan/vlc/blob/master/doc/vlm.txt

A VLM configuration file is a plain text file where each line represents a VLM command.

```vlm-config
new mybroadcast broadcast
setup mybroadcast input file:///path/to/video.avi
setup mybroadcast output #transcode{acodec=mp3,ab=128,vcodec=h264,vb=800}:rtp{sdp=rtsp://@:8554/stream}
control mybroadcast play
```

--------------------------------

### Get Playlist Object

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the playlist object for managing the media queue.

```lua
object.playlist()
```

--------------------------------

### Example MRL with Demuxer

Source: https://github.com/videolan/vlc/blob/master/doc/standalone/mrl.dox

This MRL forces the use of the 'demuxdump' demultiplexer for a specific resource.

```plaintext
http/demuxdump://example.com/path/to/media
```

--------------------------------

### Add URI to Playlist and Play

Source: https://github.com/videolan/vlc/blob/master/share/lua/http/requests/README.txt

Adds a given URI to the playlist and immediately starts playback. Optional parameters 'noaudio' or 'novideo' can be appended.

```HTTP
?command=in_play&input=<uri>&option=<option>
```

--------------------------------

### MpegEncContext Example

Source: https://github.com/videolan/vlc/blob/master/doc/fortunes.txt

A brief IRC exchange mentioning an MpegEncContext, possibly related to video encoding or decoding within VLC.

```text
evilril gives j-b an MpegEncContext
```

--------------------------------

### Show Help Text

Source: https://github.com/videolan/vlc/blob/master/contrib/src/help.txt

Execute 'make help' to display the help text, which includes a list of available make targets.

```makefile
make help
```

--------------------------------

### Prepare Prebuilt Packages

Source: https://github.com/videolan/vlc/blob/master/contrib/src/help.txt

Use 'make package' to prepare prebuilt packages for VLC distribution.

```makefile
make package
```

--------------------------------

### Get Number of Chapters

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the total number of chapters available for the current title.

```lua
player.get_chapters_count()
```

--------------------------------

### Get folders by type

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a list of folders filtered by media type. Supports query parameters for filtering and pagination.

```lua
vlc.ml.folders_by_type(query_params, mediaType: integer)
```

--------------------------------

### Get Current Input Item Name

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the name of the currently playing media item.

```lua
player.item():name()
```

--------------------------------

### Create Toolchain Script for Linux

Source: https://github.com/videolan/vlc/blob/master/doc/BUILD-win32.md

Creates a shell script to add the LLVM-MinGW toolchain to the system's PATH. This script should be sourced before starting the build process.

```bash
echo 'export PATH=/opt/llvm-mingw-20220906-msvcrt-ubuntu-18.04-x86_64/bin:$PATH' > toolchain.sh
```

--------------------------------

### Get folder list

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a list of folders. Supports query parameters for filtering and pagination.

```lua
vlc.ml.folder(query_params)
```

--------------------------------

### List VLC Configure Options

Source: https://github.com/videolan/vlc/blob/master/doc/BUILD-win32.md

Run this command to see all available configuration options for VLC builds. Use these options with the `CONFIGFLAGS` environment variable.

```sh
../vlc/configure -h
```

--------------------------------

### Setup media input and output

Source: https://github.com/videolan/vlc/blob/master/doc/vlm.txt

Configure the input sources and output destination for a media element. Multiple inputs can be added, and the output format is similar to VLC's :sout option.

```vlm-cli
setup mymedia input file://input1.mp4
setup mymedia input file://input2.mp4
setup mymedia output #transcode{acodec=mp3,ab=128,vcodec=h264,vb=800}:rtp{sdp=rtsp://@:8554/stream}
```

--------------------------------

### Get audio media list

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a list of audio media items. Supports query parameters for filtering and pagination.

```lua
vlc.ml.audio(query_params)
```

--------------------------------

### Excuse Class Example

Source: https://github.com/videolan/vlc/blob/master/doc/fortunes.txt

An example of an 'Excuse' class and its usage, demonstrating a playful approach to error handling or argument passing in code.

```java
Excuse e = new Excuse();
e.useOn(j-b);
```

--------------------------------

### Get Current Volume

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the current volume level.

```lua
volume.get()
```

--------------------------------

### List Packages

Source: https://github.com/videolan/vlc/blob/master/contrib/src/help.txt

Use 'make list' to display a list of available packages within the VLC build system.

```makefile
make list
```

--------------------------------

### Build Native Tools

Source: https://github.com/videolan/vlc/blob/master/contrib/src/help.txt

Run 'make tools' to build the native tools binaries associated with VLC.

```makefile
make tools
```

--------------------------------

### Get VLC Copyright

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the VLC copyright statement.

```lua
misc.copyright()
```

--------------------------------

### VLC Web Interface Initialization and Event Handling

Source: https://github.com/videolan/vlc/blob/master/share/lua/http/index.html

Initializes the web interface, sets up event listeners for various buttons to control playback, manage playlists, and open dialogs. Includes mobile redirection.

```javascript
<?vlc gettext("VLC media player - Web Interface") ?>    //<!\[CDATA\[ if(isMobile()){ window.location='mobile.html'; } //\]\]>   //<!\[CDATA\[ var pollStatus = true; $(function(){ $(".button").hover(function(){$(this).addClass("ui-state-hover")},function(){$(this).removeClass("ui-state-hover")}); $("#buttonPlayList").click(function(){ $("#libraryContainer").animate({ height: 'toggle' }); $("#buttonszone1").animate({ width: 'toggle' }); return false; }); $("#buttonViewer").click(function(){ $("#viewContainer").animate({ height: 'toggle' }) return false; }); $("#buttonEqualizer").click(function(){ updateEQ(); $("#window_equalizer").dialog('open'); return false; }) $("#buttonOffsets").click(function(){ $("#window_offset").dialog('open'); return false; }); $("#buttonBatch").click(function(){ $("#window_batch").dialog('open'); return false; }); $("#buttonOpen").click(function(){ browse_target = 'default'; browse(); $("#window_browse").dialog('open'); return false; }); $("#buttonPrev").mousedown(function(){ intv = 1; ccmd = 'prev'; setIntv(); return false; }); $("#buttonPrev").mouseup(function(){ if(intv<=5){ sendCommand({'command':'pl_previous'}); } intv = 0; return false; }); $("#buttonNext").mousedown(function(){ intv = 1; ccmd = 'next'; setIntv(); return false; }); $("#buttonNext").mouseup(function(){ if(intv<=5){ sendCommand({'command':'pl_next'}); } intv = 0; return false; }); $("#buttonPlEmpty").click(function(){ sendCommand({'command':'pl_empty'}) updatePlayList(true); return false; }); $("#buttonLoop").click(function(){ sendCommand({'command':'pl_loop'}); return false; }); $("#buttonRepeat").click(function(){ sendCommand({'command':'pl_repeat'}); return false; }); $("#buttonShuffle").click(function(){ sendCommand({'command':'pl_random'}); return false; }) $("#buttonRefresh").click(function(){ updatePlayList(true); return false; }); $("#buttonPlPlay").click(function(){ sendCommand({ 'command': 'pl_play', 'id':$('.jstree-clicked','#libraryTree').first().parents().first().attr('id').substr(5) }) return false; }); $("#buttonPlAdd").click(function(){ $('.jstree-clicked','#libraryTree').each(function(){ if($(this).parents().first().attr('uri')){ sendCommand({ 'command':'in_enqueue', 'input' : $(this).parents().first().attr('uri') }); }; }); $("#libraryTree").jstree('deselect_all'); setTimeout(function(){updatePlayList(true);},1000); return false; }); $("#buttonStreams, #buttonStreams2").click(function(){ updateStreams(); $("#window_streams").dialog('open'); }); $("#buttonSout").click(function(){ if(current_que=='main'){ $("#windowStreamConfirm").dialog('open'); }else{ $("#player").empty(); current_que = 'main'; sendVLMCmd('del Current'); updateStatus(); } return false; }); $("#qrCodeConfirm").dialog({ autoOpen: false, width:600, modal: true, buttons:{ "<?vlc gettext("Yes") ?>":function(){ $(this).dialog('close'); var urlimg = $("#mobileintflink").prop('href'); var codeimg = $("<img width=\"350\" height=\"350\" alt=\"qrcode"/>"); codeimg.attr('src', 'https://chart.apis.google.com/chart?cht=qr&chs=350x350&chld=L&choe=UTF-8&chl=' + encodeURIComponent(urlimg)); codeimg.dialog({width: 350, height: 350, title: "<?vlc gettext("QR Code") ?>"}); }, "<?vlc gettext("No") ?>":function(){ $(this).dialog('close'); window.location = $("#mobileintflink").attr('href'); } } }); $("#windowStreamConfirm").dialog({ autoOpen: false, width:600, modal: true, buttons:{ "<?vlc gettext("Yes") ?>":function(){ var file = $("[current=\"current\"]",'#libraryTree').length>0 ? $("[current=\"current\"]",'#libraryTree').first().attr('uri') : ($('.jstree-clicked','#libraryTree').length>0 ? $('.jstree-clicked','#libraryTree').first().parents().first().attr('uri') : ($('#plid_'+current_playlist_id).attr('uri') ? $('#plid_'+current_playlist_id).attr('uri') : false)); if(file){ if($('#viewContainer').css('display')=='none'){ $("#buttonViewer").click(); } var defaultStream = 'new Current broadcast enabled input "'+file+'" output #transcode{vcodec=FLV1,vb=4096,fps=25,scale=1,acodec=mp3,ab=512,samplerate=44100,channels=2}:std{access='+$('#stream_protocol').val()+',mux=avformat{{mux=flv}},dst=0.0.0.0:'+$('#stream_port').val()+'/'+$('#stream_file').val()+'}'; sendVLMCmd('del Current;'+defaultStream+';control Current play'); $("#player").attr('href',$('#stream_protocol').val()+'://'+$('#stream_host').val()+':'+$('#stream_port').val()+'/'+$('#stream_file').val()); current_que = 'stream'; updateStreams(); } $(this).dialog('close'); }, "<?vlc gettext("No") ?>":function(){ $(this).dialog('close'); } } }); $("#viewContainer").animate({height: 'toggle'}); }); /	 delay script loading so we won't block if we have no net access 	/ $.getScript('https://releases.flowplayer.org/js/flowplayer-3.2.6.min.js', function(data, textStatus){ $("#player").empty(); flowplayer("player", "https://releases.flowplayer.org/swf/flowplayer-3.2.7.swf"); /	 .getScript only handles success() 	/ }); //\]\]>
```

--------------------------------

### Get video media list

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a list of video media items. Supports query parameters for filtering and pagination.

```lua
vlc.ml.video(query_params)
```

--------------------------------

### Get Playback Rate

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the current playback speed.

```lua
player.get_rate()
```

--------------------------------

### Get Full Playlist

Source: https://github.com/videolan/vlc/blob/master/share/lua/http/requests/README.txt

Retrieves the entire playlist structure.

```HTTP
playlist.xml
```

```HTTP
playlist.json
```

--------------------------------

### List Contribs Bootstrap Options

Source: https://github.com/videolan/vlc/blob/master/doc/BUILD-win32.md

Execute this command to view available options for configuring contribs during the build. These options can be passed via `CONTRIBFLAGS`.

```sh
../vlc/contribs/bootstrap -h
```

--------------------------------

### Get Audio Tracks

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a list of available audio tracks for the current media. Each track item includes its ID, name, and selection status.

```lua
player.get_audio_tracks()
```

--------------------------------

### Fetch All Source Tarballs

Source: https://github.com/videolan/vlc/blob/master/contrib/src/help.txt

Run 'make fetch-all' to download all source tarballs needed for the VLC build.

```makefile
make fetch-all
```

--------------------------------

### Get Subtitle Delay

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the current subtitle delay in seconds.

```lua
player.get_subtitle_delay()
```

--------------------------------

### Get Audio Delay

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the current audio delay in seconds.

```lua
player.get_audio_delay()
```

--------------------------------

### Package VLC for Windows

Source: https://github.com/videolan/vlc/blob/master/doc/BUILD-win32.md

Create a package for VLC on Windows by navigating to the 'win64' directory and running 'make package-win-common'. This prepares the VLC executable and DLLs for distribution.

```sh
cd win64; make package-win-common
```

--------------------------------

### Get XML Element Value

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the value of the current XML element.

```lua
reader:value()
```

--------------------------------

### Lazy Initialization for VLC Lua Modules

Source: https://github.com/videolan/vlc/blob/master/share/lua/sd/README.txt

Demonstrates how to implement lazy loading for modules within VLC Lua SD scripts to manage dependencies and threading.

```APIDOC
## Lazy Initialization for VLC Lua Modules

### Description
Due to threading and interpreter differences, VLC Lua SD scripts should lazily load external modules within `main()` and `search()` functions instead of at the top level.

### Implementation Example

```lua
lazily_loaded = false
dkjson        = nil

function lazy_load()
  if lazily_loaded then return nil end
  dkjson = require("dkjson")
  lazily_loaded = true
end

function descriptor()
  return { title = "My SD's title", capabilities={"search"}}
end

function main()
  lazy_load()
  -- Use dkjson or other lazily loaded modules here
end

function search(query)
  lazy_load()
  -- Use dkjson or other lazily loaded modules here
end
```

### Notes
- Global `require` statements for modules like `dkjson` should be avoided at the top level.
- The `lazy_load` function ensures that modules are only required once.
```

--------------------------------

### Get List of VLC Data Directories

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieve a prioritized list of possible data directories, appended by a given name. This function is part of the config module.

```lua
config.datadir_list( name )
```

--------------------------------

### Get XML Element Name

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the name of the current XML element.

```lua
reader:name()
```

--------------------------------

### Build VLC from Source

Source: https://github.com/videolan/vlc/blob/master/doc/BUILD-win32.md

Builds VLC from the source code, including its dependencies (contribs) and core components. This command creates a build directory and then executes the build script.

```sh
mkdir build
cd build
../vlc/extras/package/win32/build.sh -a x86_64
```

--------------------------------

### Get Current Microseconds Date

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the current date represented in microseconds.

```lua
misc.mdate()
```

--------------------------------

### Connect to TCP Host and Port

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Establishes a TCP connection to the specified host and port.

```lua
net.connect_tcp( host, port )
```

--------------------------------

### Get Loop Mode

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the current loop mode setting for the playlist.

```lua
playlist.get_loop()
```

--------------------------------

### QuickTime Codec Reverse Engineering Discussion

Source: https://github.com/videolan/vlc/blob/master/doc/fortunes.txt

An IRC conversation about reverse engineering various QuickTime codecs, including effects, qtvr, qtma, and specific examples like BeHereiVideo.qtx.

```text
BeHereiVideo.qtx --> RE that one
```

--------------------------------

### Get Input Item Info

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves detailed information about the current media input. The return value is a table of tables categorized by info type.

```lua
player.item():info()
```

--------------------------------

### Initialize Windows Console

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Initializes the Windows console. This module is only available on Windows builds.

```lua
win.console_init()
```

--------------------------------

### Get Repeat Mode

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the current repeat mode setting for the playlist.

```lua
playlist.get_repeat()
```

--------------------------------

### Lazy Initialization for VLC Lua Modules

Source: https://github.com/videolan/vlc/blob/master/share/lua/sd/README.txt

Demonstrates how to lazily load external Lua modules within VLC SD scripts to avoid issues with different interpreter contexts. Ensure modules are required only when needed in main() or search().

```lua
lazily_loaded = false
dkjson        = nil

function lazy_load()
  if lazily_loaded then return nil end
  dkjson = require("dkjson")
  lazily_loaded = true
end

function descriptor()
  return { title = "..." }
end

function main()
  lazy_load()
  -- Do stuff here
end

function search(query)
  lazy_load()
  -- Do stuff here
end
```

--------------------------------

### Get Player Object

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the player object for controlling media playback.

```lua
object.player()
```

--------------------------------

### Get Current Chapter Index

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the index of the currently playing chapter.

```lua
player.get_chapter_index()
```

--------------------------------

### VLC Lua Modules Overview

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Overview of VLC-specific Lua modules and their general usage.

```APIDOC
## VLC Specific Lua Modules

All VLC specifics modules are in the "vlc" object. For example, if you want to use the "info" function of the "msg" VLC specific Lua module:

vlc.msg.info( "This is an info message and will be displayed in the console" )

Note: availability of the different VLC specific Lua modules depends on the type of VLC Lua script your are in.
```

--------------------------------

### Get Current Title Index

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the index of the currently playing title.

```lua
player.get_title_index()
```

--------------------------------

### Listen to TCP Connections with VLC

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Establishes a TCP listener on a specified host and port. It returns an object with methods to accept connections and retrieve file descriptors for polling.

```lua
local l = vlc.net.listen_tcp( "localhost", 1234 )
while true do
  local fd = l:accept()
  if fd >= 0 then
    net.send( fd, "blabla" )
    net.close( fd )
  end
end
```

--------------------------------

### Create Directory

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Creates a new directory at the specified path with the given mode. Returns a success code and an error code on failure.

```lua
io.mkdir("path", "mode")
```

--------------------------------

### Get Error Message

Source: https://github.com/videolan/vlc/blob/master/share/lua/http/requests/README.txt

Retrieves the error message associated with a VLM command.

```APIDOC
## GET /vlm_cmd.xml?command=<cmd>

### Description
Retrieves the error message from a previously executed VLM command.

### Method
GET

### Endpoint
/vlm_cmd.xml

### Parameters
#### Query Parameters
- **command** (string) - Required - The VLM command for which to retrieve the error message.

### Request Example
None

### Response
#### Success Response (200)
- **error_message** (string) - The error message associated with the command.

#### Response Example
```json
{
  "error_message": "An error occurred during command execution."
}
```
```

--------------------------------

### Fetch Source Tarballs

Source: https://github.com/videolan/vlc/blob/master/contrib/src/help.txt

Execute 'make fetch' to download the required source tarballs for VLC.

```makefile
make fetch
```

--------------------------------

### Get Current Playback Time

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the current playback position in microseconds.

```lua
player.get_time()
```

--------------------------------

### Clean Everything

Source: https://github.com/videolan/vlc/blob/master/contrib/src/help.txt

Run 'make clean' to remove all generated files and clean the build directory.

```makefile
make clean
```

--------------------------------

### Run VLC in Dummy Interface Mode

Source: https://github.com/videolan/vlc/blob/master/doc/fortunes.txt

Use this command to run VLC without a graphical interface, often for testing or server environments. It's useful when a full GUI is not needed or desired.

```bash
vlc -I dummy
```

--------------------------------

### Get Next XML Attribute

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the next attribute of the current XML element.

```lua
reader:next_attr()
```

--------------------------------

### Initialize VLC Equalizer and Preamp UI

Source: https://github.com/videolan/vlc/blob/master/share/lua/http/dialogs/equalizer_window.html

Initializes the VLC equalizer and preamp UI elements using jQuery. The equalizer bands are set up with a reset function, and the preamp slider is configured with min/max values, animation, and event handlers for slide and stop actions.

```javascript
//<![CDATA[
 var bands = new Array('60Hz','170Hz','310Hz','600Hz','1kHz','3kHz','6kHz','12kHz','14kHz','16kHz');
 $(function(){
  $('#window_equalizer').dialog({
   autoOpen: false,
   height: 650,
   width: 500,
   resizable: false,
   buttons:{
    "<?vlc gettext("Reset") ?>":function(){
     $('.eqBand').each(function(){
      $(this).slider('value',0);
      sendEQCmd({ command:'equalizer', val: 0, band: $(this).attr('id').substr(2) })
     });
    },
    "<?vlc gettext("Close") ?>":function(){
     $(this).dialog("close");
    }
   }
  });
  $('#preamp').slider({
   min: -20,
   max: 20,
   step: 0.1,
   range: "min",
   animate: true,
   stop: function(event,ui){
    $('#preamp_txt').empty().append(ui.value+'dB');
    sendEQCmd({ command:'preamp', val: ui.value })
   },
   slide: function(event,ui){
    $('#preamp_txt').empty().append(ui.value+'dB');
   }
  });
 });
//]]>
```

--------------------------------

### Get playlist by ID

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a specific playlist using its unique integer ID.

```lua
vlc.ml.playlist(playlistId: integer)
```

--------------------------------

### Get genre by ID

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a specific genre using its unique integer ID.

```lua
vlc.ml.genre(genreId: integer)
```

--------------------------------

### VLM Command Line Syntax

Source: https://github.com/videolan/vlc/blob/master/doc/vlm.txt

This section details the command-line syntax for managing VLM elements, including creating, configuring, showing, deleting, and controlling media.

```APIDOC
## VLM Command Line Syntax

### General Commands

#### `help`
- **Description**: Displays an exhaustive list of available command lines.

#### `new <name> broadcast|schedule [properties]`
- **Description**: Creates a new element (media or schedule). Element names must be unique. Properties can be set later using `setup`.
- **Example**: `new my_stream broadcast input file://video.mp4 output udp://127.0.0.1:1234`

#### `setup <name> [properties]`
- **Description**: Sets properties for a specified element.

#### `show [(name)|media|schedule]`
- **Description**: Displays current element states and configurations. `show` is equivalent to `show media show schedule`.
- **Example**: `show my_stream`
- **Example**: `show media`

#### `del (name)|all|media|schedule`
- **Description**: Destroys an element or a group of elements. Stops non-stop elements before destroying.
- **Example**: `del my_stream`
- **Example**: `del all`

#### `control <name> [instance_name] <command>`
- **Description**: Changes the state of a media instance. If `instance_name` is omitted, it affects the default instance.

#### `save <config_file>`
- **Description**: Saves all media configurations to a specified file. Overwrites the file if it exists. States (playing, paused, stop) are not saved.

#### `load <config_file>`
- **Description**: Loads configurations from a specified file.

### Media Properties

#### `input <input_name>`
- **Description**: Adds an input source to the media's input list.

#### `inputdel <input_name>|all`
- **Description**: Deletes an input source or all input sources from the media.

#### `inputdeln <input_number>`
- **Description**: Deletes an input source by its number from the media's input list.

#### `output <output_name>`
- **Description**: Defines the output for the media. Syntax is similar to VLC's `:sout=` option.

#### `option <option_name>[=value]`
- **Description**: Adds an option to the media. Syntax is similar to VLC's `:(option)=` syntax. Options apply to all inputs.

#### `enabled` | `disabled`
- **Description**: Enables or disables the media. Disabled media cannot be streamed or paused.

#### `loop` | `unloop`
- **Description**: For broadcast media only. Enables or disables looping of the input list.

### Control Commands (for `control` command)

#### `play`
- **Description**: Starts a broadcast media, playing inputs sequentially.

#### `pause`
- **Description**: Pauses the broadcast media.

#### `stop`
- **Description**: Stops the broadcast media.

#### `seek <percentage>`
- **Description**: Seeks to a specific percentage within the current playing input.
```

--------------------------------

### Get artist by ID

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a specific artist using its unique integer ID.

```lua
vlc.ml.artist(artistId: integer)
```

--------------------------------

### Build VLC with LLVM (13) Prebuilt Contribs

Source: https://github.com/videolan/vlc/blob/master/doc/BUILD-win32.md

Builds VLC using prebuilt contrib libraries compatible with LLVM 13. This method also accelerates the build by reusing compiled dependencies.

```sh
mkdir build
cd build
export VLC_CONTRIB_SHA="$(cd ../vlc; extras/ci/get-contrib-sha.sh win32)"
export VLC_PREBUILT_CONTRIBS_URL="https://artifacts.videolan.org/vlc/win64-llvm/vlc-contrib-x86_64-w64-mingw32-$VLC_CONTRIB_SHA.tar.bz2"
time ../vlc/extras/package/win32/build.sh -a x86_64 -p
```

--------------------------------

### Go to Next Title

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Navigates to the next title in the media.

```lua
player.title_next()
```

--------------------------------

### Get album by ID

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a specific album using its unique integer ID.

```lua
vlc.ml.album(albumId: integer)
```

--------------------------------

### Get folder by ID

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a specific folder using its unique integer ID.

```lua
vlc.ml.get_folder(folderId: integer)
```

--------------------------------

### Get Action ID

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the unique ID associated with a given action name.

```lua
misc.action_id( name )
```

--------------------------------

### Create HTTP Daemon

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Creates a new HTTP daemon instance. This is typically used for setting up web interfaces or services within VLC.

```lua
local h = vlc.httpd()
```

--------------------------------

### Get Random Mode

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the current random playback mode setting for the playlist.

```lua
playlist.get_random()
```

--------------------------------

### Find Dependency and Configure Module

Source: https://github.com/videolan/vlc/blob/master/doc/standalone/buildsystem.md

This snippet demonstrates how to find an external dependency (dav1d) using `dependency()`, link it to a module, and conditionally enable the module based on whether the dependency is found and the feature option is enabled.

```meson
# dav1d AV1 decoder
dav1d_dep = dependency('dav1d', version: '>= 0.5.0', required: get_option('dav1d'))
vlc_modules += {
    'name' : 'dav1d',
    'sources' : files('dav1d.c'),
    'dependencies' : [dav1d_dep],
    'enabled' : dav1d_dep.found(),
}

```

--------------------------------

### Meson Code Style: Project Arguments

Source: https://github.com/videolan/vlc/blob/master/doc/standalone/buildsystem.md

Demonstrates the correct usage of keyword arguments for `add_project_arguments` in Meson, emphasizing the placement of the colon.

```meson
# Right
add_project_arguments('-D_EXAMPLE', language: ['c', 'cpp', 'objc'])

# Wrong
add_project_arguments('-D_EXAMPLE', language : ['c', 'cpp', 'objc'])
```

--------------------------------

### Get Number of Titles

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the total number of titles available in the current media.

```lua
player.get_titles_count()
```

--------------------------------

### Add HTTP File

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Serves a static file at a given URL with a specified MIME type. Authentication can be set up, and a callback handles connection requests.

```lua
h:file( url, mime, user, password, callback, data )
```

--------------------------------

### Go to Previous Title

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Navigates to the previous title in the media.

```lua
player.title_prev()
```

--------------------------------

### Variable Manipulation API

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Functions for getting, setting, creating, and triggering callbacks for object variables.

```APIDOC
## Variable Manipulation API

### Description
Provides functions to interact with object variables, including getting, setting, creating, and managing callbacks.

### Functions

#### `var.get(object, name)`
Get the value of the object's variable named "name".

#### `var.get_list(object, name)`
Get the value list and text list of the object's variable named "name".

#### `var.set(object, name, value)`
Set the object's variable named "name" to the specified "value".

#### `var.create(object, name, value)`
Create and set the object's variable named "name" to the specified "value". Variables can be of type float, string, bool, or void. For void variables, the value must be 'nil'.

#### `var.trigger_callback(object, name)`
Trigger the callbacks associated with the object's "name" variable.

#### `var.libvlc_command(name, argument)`
Issue a libvlc command named "name" with the given "argument".

#### `var.inc_integer(name)`
Increment the integer variable named "name".

#### `var.dec_integer(name)`
Decrement the integer variable named "name".

#### `var.count_choices(name)`
Return the number of choices for the variable named "name".

#### `var.toggle_bool(name)`
Toggle the boolean variable named "name".
```

--------------------------------

### Get playlist list

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a list of playlists. Supports query parameters for filtering and pagination.

```lua
vlc.ml.playlists(query_params)
```

--------------------------------

### Build VLC with GCC (11) Prebuilt Contribs

Source: https://github.com/videolan/vlc/blob/master/doc/BUILD-win32.md

Builds VLC while utilizing prebuilt contrib libraries compatible with GCC 11. This significantly speeds up the build process by avoiding the compilation of numerous dependencies.

```sh
mkdir build
cd build
export VLC_CONTRIB_SHA="$(cd ../vlc; extras/ci/get-contrib-sha.sh win32)"
export VLC_PREBUILT_CONTRIBS_URL="https://artifacts.videolan.org/vlc/win64/vlc-contrib-x86_64-w64-mingw32-${VLC_CONTRIB_SHA}.tar.bz2"
../vlc/extras/package/win32/build.sh -a x86_64 -p
```

--------------------------------

### Get genres list

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a list of genres. Supports query parameters for filtering and pagination.

```lua
vlc.ml.genres(query_params)
```

--------------------------------

### Get artist list

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a list of artists. Supports query parameters for filtering and pagination.

```lua
vlc.ml.artists(query_params)
```

--------------------------------

### Run a Specific VLC Test

Source: https://github.com/videolan/vlc/blob/master/doc/standalone/buildsystem.md

Execute a particular test defined in the Meson build system by specifying its name. Ensure module dependencies are correctly declared.

```bash
meson test -C build-meson test_src_input_thumbnail
```

--------------------------------

### Get album list

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a list of albums. Supports query parameters for filtering and pagination.

```lua
vlc.ml.albums(query_params)
```

--------------------------------

### Add item to playlist with options

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Adds an item to the playlist with optional metadata and playback settings. Invalid items are discarded.

```lua
playlist.add( {
  title = "My Song",
  artist = "The Artists",
  genre = "Rock",
  album = "The Album",
  copyright = "2023",
  tracknum = 1,
  options = { "run-time=60" },
  meta = { ["GVP docid"] = "-5784010886294950089", ["GVP version"] = "1.1", Hello = "World!" },
  description = "A great song",
  rating = 5,
  date = "2023-10-27",
  setting = "Live",
  url = "http://example.com/song.mp3",
  language = "en",
  nowplaying = true,
  publisher = "My Label",
  encodedby = "Encoder",
  arturl = "http://example.com/art.jpg",
  trackid = 12345,
  duration = 300
} )
```

--------------------------------

### Create a renderer discovery object

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Initializes a renderer discovery object for a specific module type, such as 'mdns_renderer'.

```lua
local rd = rd.create( "mdns_renderer" )
```

--------------------------------

### Get media by ID

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves a specific media item using its unique integer ID.

```lua
vlc.ml.media(mediaId: integer)
```

--------------------------------

### Get the size of a stream

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Returns the size of the stream in bytes. Returns nil if the size is unknown.

```lua
s:getsize() -- returns the size of the stream, or nil if unknown
```

--------------------------------

### Get Video Output Object

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the video output object for managing video streams.

```lua
object.vout()
```

--------------------------------

### Show media status and configuration

Source: https://github.com/videolan/vlc/blob/master/doc/vlm.txt

Display the current state and configuration details for specific media elements or a summary of all medias and schedules.

```vlm-cli
show mymedia
show media
show schedule
show
```

--------------------------------

### Download and Extract LLVM Toolchain on Linux

Source: https://github.com/videolan/vlc/blob/master/doc/BUILD-win32.md

Downloads a prebuilt LLVM-MinGW toolchain for Linux and extracts it to the /opt directory. This toolchain is used for debugging VLC builds with PDB files.

```bash
wget https://github.com/mstorsjo/llvm-mingw/releases/download/20220906/llvm-mingw-20220906-msvcrt-ubuntu-18.04-x86_64.tar.xz
tar xvf llvm-mingw-20220906-msvcrt-ubuntu-18.04-x86_64.tar.xz -C /opt
```

--------------------------------

### Get Audio Output Object

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the audio output object for managing audio streams.

```lua
object.aout()
```

--------------------------------

### Get libVLC Object

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the libVLC object, providing access to core VLC functionalities.

```lua
object.libvlc()
```

--------------------------------

### Configure Automake for Rust Plugin

Source: https://github.com/videolan/vlc/blob/master/doc/standalone/rust.md

Define build rules for a Rust-based plugin using automake, linking the Cargo-built library.

```make
libmynewmodule_rs.la:
	@$(LIBTOOL_CARGO) $(srcdir)/moduledir/mynewmodule-rs/ $@

libmynewmodule_rs_plugin_la_SOURCES = \
	mynewmodule-rs/Cargo.toml \
	ώντας/src/lib.rs 
libmynewmodule_rs_plugin_la_LIBADD = libmynewmodule_rs.la

if HAVE_RUST
moduledir_PLUGINS += libmynewmodule_rs_plugin.la
# Example: video_filter_PLUGINS += libmynewfilter_rs_plugin.la
endif

```

--------------------------------

### Create a new broadcast media element

Source: https://github.com/videolan/vlc/blob/master/doc/vlm.txt

Use the 'new' command to create a media element, specifying 'broadcast' as its type. Properties can be set later using the 'setup' command.

```vlm-cli
new mybroadcast broadcast
setup mybroadcast input file:///path/to/video.avi
setup mybroadcast output #transcode{acodec=mp3,ab=128,vcodec=h264,vb=800}:rtp{sdp=rtsp://@:8554/stream}
```

--------------------------------

### Get VLM Elements

Source: https://github.com/videolan/vlc/blob/master/share/lua/http/requests/README.txt

Retrieves a full list of all VLM elements currently managed by VLC.

```APIDOC
## GET /vlm_cmd.xml

### Description
Retrieves the full list of VLM elements.

### Method
GET

### Endpoint
/vlm_cmd.xml

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **vlm_elements** (array) - A list of VLM elements.

#### Response Example
```json
{
  "vlm_elements": [
    "element1",
    "element2"
  ]
}
```
```

--------------------------------

### Go to Specific Title

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Navigates to a specific title by its index.

```lua
player.title_goto(i)
```

--------------------------------

### Open File

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Opens a file at the specified path with an optional mode. Returns a file object with read, write, seek, and flush methods.

```lua
io.open("path"[, "mode"])
```

--------------------------------

### Add URI to Playlist

Source: https://github.com/videolan/vlc/blob/master/share/lua/http/requests/README.txt

Adds a specified URI to the end of the playlist without starting playback.

```HTTP
?command=in_enqueue&input=<uri>
```

--------------------------------

### Get genre thumbnail by ID

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the thumbnail for a specific genre using its unique integer ID.

```lua
vlc.ml.genre_thumbnail(genreId: integer)
```

--------------------------------

### Get album thumbnail by ID

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the thumbnail for a specific album using its unique integer ID.

```lua
vlc.ml.album_thumbnail(albumId: integer)
```

--------------------------------

### Implement fetch_art() for Artwork Retrieval

Source: https://github.com/videolan/vlc/blob/master/share/lua/meta/art/README.txt

VLC Lua meta modules should define the fetch_art() function to return a path to artwork for a given item. This is the primary function for retrieving metadata artwork.

```lua
function fetch_art()
  -- Implementation to return artwork path
end
```

--------------------------------

### Get artist thumbnail by ID

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Retrieves the thumbnail for a specific artist using their unique integer ID.

```lua
vlc.ml.artist_thumbnail(artistId: integer)
```

--------------------------------

### Get playlist status

Source: https://github.com/videolan/vlc/blob/master/share/lua/README.txt

Returns the current playback status of the playlist, which can be 'stopped', 'playing', 'paused', or 'unknown'.

```lua
local status = playlist.status()
```