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 tutorial, pick a specific topic in the "Documentation" section,
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. 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.

h4. 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.

h4. Documentation

* Basic concepts: "sources":sources.html and "requests":requests.html.
* "Bubble":bubble.html: a simple example of a database interface as a custom protocol.
* "Blank detection":blank.html
* "Cookbook":cookbook.html: contains lots of idiomatic examples.
* "Customize metadata":metadata.html
* "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 vs. Harbor input":http_vs_harbor.html: relay and host external streams.
* "Normalization and replay gain":replay_gain.html
* "Requests":requests.html are how we handle (remote) (audio) files
* "Requests-based sources":request_sources.html
* "Shoutcast output":shoutcast.html
* "Smart crossfading":smartcrossfade.html
* "Sources":sources.html are our streams
* "Multichannel":multichannel.html
* "Optimizing liquidsoap":optimization.html
* "Script loading":script_loading.html: load several scripts, learn about the script library.
* "Video":video.html: stream videos.

h4. User scripts

* "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
