title: Liquidsoap documentation

h3. Documentation index

**How to use**: Start with the "quickstart":quick_start.html and 
make sure you learn "how to find help":help.html. Then it's as you like:
go for another "general tutorial":#general, or a 
"specific example":#specific,
pick a "basic notion":#core, or some examples from the 
"cookbook":cookbook.html. If you've understood all you need,
just browse the "reference":reference.html and compose your dream stream.

If you downloaded a source tarball of liquidsoap, you may first read the
"build instructions":build.html.

h4@general. General tutorials

* "Quickstart":quick_start.html: where anyone should start.
* "Complete case analysis":complete_case.html: an example that is not a toy.
* "Advanced":advanced.html: overview of more advanced features for serious usage.
* "How to find help":help.html about operators, settings, server commands, etc.
* "Cookbook":cookbook.html: contains lots of idiomatic examples.
* "Frequently Asked Questions, Troubleshooting":faq.html

h4@reference. Reference

* "API reference":reference.html: All the builtin functions of liquidsoap.
* "Settings":settings.html: The list of available settings for liquidsoap.
* "Script language":language.html: A more detailed presentation.
* "Encoding formats":encoding_formats.html: The available formats for encoding outputs.
* "JSON import/export":json.html: Importing and exporting language values in JSON.
* "LADSPA plugins":ladspa.html: Using LADSPA plugins.

h4@core. Core

* Basic concepts: "sources":sources.html, "clocks":clocks.html and "requests":requests.html.
* "Stream contents":stream_content.html: what kind of streams are supported, and how.
* "Script loading":script_loading.html: load several scripts, learn about the script library.
* "Execution phases":phases.html

h4@specific. Specific tutorials 

* "Blank detection":blank.html
* "Customize metadata":metadata.html
* "Seek and cue support":seek.html: seek and set cue-in and cue-out points in sources.
* "External decoders":external_decoders.html: use an external program for decoding audio files.
* "External streams":external_streams.html: use an external program for streaming audio data.
* "External encoders":external_encoders.html: use an external audio encoding program.
* "HTTP input":http_input.html: relay external streams.
* "Harbor input":harbor.html: receive streams from icecast and shoutcast source clients.
* "Interaction with the Harbor":harbor_http.html: interact with a running liquidsoap using the Harbor server.
* "Interaction with the server":server.html interact with a running liquidsoap instance using the telnet server.
* "ICY metadata update":icy_metadata.html: manipulate and configure metadata update in Icecast.
* "Normalization and replay gain":replay_gain.html: normalize audio data.
* "Requests-based sources":request_sources.html: create advanced sources using requests.
* "Shoutcast output":shoutcast.html: output to shoutcast.
* "Dynamic source creation":dynamic_sources.html: dynamically create sources using server requests.
* "Smart crossfading":smartcrossfade.html: define custom crossfade transitions.
* "Secure command server":secure_server_access.html: secure authenticated access to the command server.
* "Using in production":in_production.html: integrate liquidsoap scripts in a production environment.
* "Liquid Flows":flows.html: add your radio to the "webpage":http://savonet.sourceforge.net/flows.html of proud users.

h4@users. User scripts

* "Bubble":bubble.html: a simple example of a database interface as a custom protocol.
* "Geekradio":geekradio.html
* "RadioPi":radiopi.html
* "Dolebraï":dolebrai.html
* "Kube":kube.html
* "Frequence3":frequence3.html
* "Listen to Radio Nova":radio-nova.html
* "Video with a single static image":video-static.html

h4. Code snippets

* "Code example index":scripts/index.html
