# /usr/bin/liquidsoap --list-plugins
All the plugs
+ audio file formats (duration)
 Methods to extract duration from a file.
 + WAV
  (no doc)
+ file decoding
 File decoding methods.
 + META
  (no doc)
 + MIDI
  (no doc)
 + WAV
  Decode as WAV any file with a correct header.
+ metadata formats
 Methods to extract metadata from a file.
+ playlist formats
 Method to parse playlist.
 + application/x-cue
  (no doc)
 + audio/mpegurl
  (no doc)
 + audio/x-mpegurl
  (no doc)
 + audio/x-scpls
  (no doc)
+ protocols
 Methods to get a file. They are the first part of URIs: 'protocol:args'.
 + ANNOTATE
  [annotate:key="val",key2="val2",...:uri] adds the metadata to the request and is then resolved into uri
 + FTP
  Fetch files using "/usr/bin/wget".
 + HTTP
  Fetch files using "/usr/bin/wget".
 + HTTPS
  Fetch files using "/usr/bin/wget".
 + MPD
  [mpd:tag="value"] finds all files with a tag equal to a given value using mpd.
 + REPLAY_GAIN
  (no doc)
 + SAY
  Speech synthesis, with optional voice choice using say:voice/blah.
 + TIME
  Speech synthesis of a message where $(time) is replaced by the current time
+ samplerate converters
 Methods for converting samplerate.
 + native
  (no doc)
+ scripting values
 scripting values
 + !=
  Comparison of comparable values.
  + _category
   Bool
  + _type
   ('a,'a)->bool where 'a is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is an orderable type
 + %
  <code>pattern % [...,(k,v),...]</code> changes in the pattern occurences of:
 - <code>$(k)</code> into <code>v</code>;
 - <code>$(if $(k2),"a","b")</code> into "a" if k2 is found in the list, "b" otherwise.
  + _category
   String
  + _type
   (string,[(string*string)])->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    [(string*string)]
 + *
  Multiplication of numbers.
  + _category
   Math
  + _type
   ('a,'a)->'a where 'a is a number type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is a number type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is a number type
 + +
  Addition of numbers.
  + _category
   Math
  + _type
   ('a,'a)->'a where 'a is a number type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is a number type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is a number type
 + -
  Substraction  of numbers.
  + _category
   Math
  + _type
   ('a,'a)->'a where 'a is a number type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is a number type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is a number type
 + /
  Division of numbers.
  + _category
   Math
  + _type
   ('a,'a)->'a where 'a is a number type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is a number type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is a number type
 + <
  Comparison of comparable values.
  + _category
   Bool
  + _type
   ('a,'a)->bool where 'a is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is an orderable type
 + <=
  Comparison of comparable values.
  + _category
   Bool
  + _type
   ('a,'a)->bool where 'a is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is an orderable type
 + ==
  Comparison of comparable values.
  + _category
   Bool
  + _type
   ('a,'a)->bool where 'a is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is an orderable type
 + >
  Comparison of comparable values.
  + _category
   Bool
  + _type
   ('a,'a)->bool where 'a is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is an orderable type
 + >=
  Comparison of comparable values.
  + _category
   Bool
  + _type
   ('a,'a)->bool where 'a is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is an orderable type
 + ^
  Concatenate strings.
  + _category
   String
  + _type
   (string,string)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + _[_]
  l[k] returns the first v such that (k,v) is in the list l.
  + _category
   List
  + _type
   (string,[(string*string)])->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    [(string*string)]
 + abs
  Absolute value.
  + _category
   Math
  + _type
   ('a)->'a where 'a is a number type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is a number type
 + add
  Mix sources, with optional normalization. Only relay metadata from the first source that is effectively summed.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?normalize:bool,?weights:[int],
 [source(audio='#a,video='#b,midi=0)])->
source(audio='#a,video='#b,midi=0)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + normalize
   (no doc)
   + default
    true
   + type
    bool
  + weights
   Relative weight of the sources in the sum. The empty list stands for the homogeneous distribution.
   + default
    []
   + type
    [int]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    [source(audio='#a,video='#b,midi=0)]
 + add_decoder
  Register an external file decoder. The encoder should output in WAV format to his standard output (stdout) and read data from its standard input (stdin).
  + _category
   Liquidsoap
  + _type
   (name:string,description:string,test:((string)->int),
 string)->unit
  + name
   Format/decoder's name.
   + default
    None
   + type
    string
  + description
   Description of the decoder.
   + default
    None
   + type
    string
  + test
   Function used to determine if the file should be decoded by the decoder. Returned values are: 0: no decodable audio, -1: decodable audio but number of audio channels unknown, x: fixed number of decodable audio channels.
   + default
    None
   + type
    (string)->int
  + (unlabeled)
   Process to start.
   + default
    None
   + type
    string
 + add_metadata_resolver
  Register an external file metadata decoder.
  + _category
   Liquidsoap
  + _type
   (string,((string)->[(string*string)]))->unit
  + (unlabeled)
   Format/resolver's name.
   + default
    None
   + type
    string
  + (unlabeled)
   Process to start. The function takes the format and filename as argument and returns a list of (name,value) fields.
   + default
    None
   + type
    (string)->[(string*string)]
 + add_oblivious_decoder
  Register an external file decoder. The encoder should output in WAV format to his standard output (stdout) and read data from the file it receives. The estimated remaining duration for this decoder will be unknown until the @buffer@ last seconds of the file. If possible, it is recommended to decode from stdin and use @add_decoder@.
  + _category
   Liquidsoap
  + _type
   (name:string,description:string,test:((string)->int),
 ?buffer:float,((string)->string))->unit
  + name
   Format/decoder's name.
   + default
    None
   + type
    string
  + description
   Description of the decoder.
   + default
    None
   + type
    string
  + test
   Function used to determine if the file should be decoded by the decoder. Returned values are: 0: no decodable audio, -1: decodable audio but number of audio channels unknown, x: fixed number of decodable audio channels.
   + default
    None
   + type
    (string)->int
  + buffer
   (no doc)
   + default
    5.
   + type
    float
  + (unlabeled)
   Process to start. The function takes the filename as argument and returns the process to start.
   + default
    None
   + type
    (string)->string
 + add_protocol
  Register a new protocol.
  + _category
   Liquidsoap
  + _type
   (?temporary:bool,string,((string,float)->[string]))->unit
  + temporary
   if true, file removed when it is finished.
   + default
    false
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    (string,float)->[string]
 + add_skip_command
  Add a skip function to a source when it does not have one by default
  + _category
   Interaction
  + (unlabeled)
   The source to attach the command to.
   + default
    None
   + type
    source('a)
  + _type
   (source('a))->unit
 + add_timeout
  Call a function in N seconds. If the result of the function is positive or null, the task will be scheduled after this amount of time (in seconds.)
  + _category
   Control
  + _type
   (?fast:bool,float,(()->float))->unit
  + fast
   Set to <code>false</code> if the execution of the code can take long in order to lower its priority below that of request resolutions and fast timeouts. This is only effective if you set a dedicated queue for fast tasks, see the "scheduler" settings for more details.
   + default
    true
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ()->float
 + amplify
  Multiply the amplitude of the signal.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?override:string,'a,
 source(audio='#b,video='#c,midi='#d))->
source(audio='#b,video='#c,midi='#d)
where 'a is either float or ()->float
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + override
   Specify the name of a metadata field that, when present and well-formed, overrides the amplification factor for the current track. Well-formed values are floats in decimal notation (e.g. '0.7') which are taken as normal/linear multiplicative factors; values can be passed in decibels with the suffix 'dB' (e.g. '-8.2 dB', but the spaces do not matter).
   + default
    "liq_amplify"
   + type
    string
  + (unlabeled)
   Multiplicative factor.
   + default
    None
   + type
    anything that is either float or ()->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#b,video='#c,midi='#d)
 + and
  Return the conjunction of its arguments
  + _category
   Bool
  + _type
   (bool,bool)->bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    bool
 + append
  Append an extra track to every track. Set the metadata 'liq_append' to 'false' to inhibit appending on one track.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?insert_missing:bool,?merge:bool,source('a),
 (([(string*string)])->source('a)))->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + insert_missing
   Treat track beginnings without metadata as having empty one.
   + default
    true
   + type
    bool
  + merge
   Merge the track with its appended track.
   + default
    false
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
  + (unlabeled)
   Given the metadata, build the source producing the track to append. This source is allowed to fail (produce nothing) if no relevant track is to be appended.
   + default
    None
   + type
    ([(string*string)])->source('a)
 + argv
  Get command-line parameters.
  + _category
   System
  + _type
   (?default:string,int)->string
  + default
   (no doc)
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    int
 + at
  Restrict a source to play only when a predicate is true.
  + _category
   Source / Track Processing
  + (unlabeled)
   The predicate, typically a time interval such as <code>{10h-10h30}</code>.
   + default
    None
   + type
    ()->bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
  + _type
   ((()->bool),source('a))->source('a)
 + audio.map
  Map a function to all audio samples. This is SLOW!
  + _category
   Source / Sound Processing
  + _type
   (?id:string,((float)->float),
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + _flag
   hidden
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    (float)->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + audio_to_stereo
  Convert any kind of audio source into a stereo source.
  + _category
   Source / Conversions
  + _type
   (?id:string,source(audio=*+1,video=0,midi=0))->
source(audio=2,video=0,midi=0)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio=*+1,video=0,midi=0)
 + base64.decode
  Decode a Base64 encoded string.
  + _category
   String
  + _type
   (string)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + base64.encode
  Encode a string in Base64.
  + _category
   String
  + _type
   (string)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + basename
  Get the base name of a path.
  + _category
   System
  + _type
   (string)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + blank
  Produce silence and blank images.
  + _category
   Source / Input
  + _type
   (?id:string,?duration:float)->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + duration
   Duration of blank tracks in seconds, default means forever.
   + default
    0.
   + type
    float
 + bool_of_float
  Convert a float to a bool.
  + _category
   Math
  + _type
   (float)->bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    float
 + bool_of_int
  Convert an int to a bool.
  + _category
   Math
  + _type
   (int)->bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    int
 + bool_of_string
  Convert a string to a bool.
  + _category
   String
  + _type
   (?default:bool,string)->bool
  + default
   (no doc)
   + default
    false
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + buffer
  Create a buffer between two different clocks.
  + _category
   Source / Liquidsoap
  + _type
   (?id:string,?buffer:float,?fallible:bool,?max:float,
 ?on_start:(()->unit),?on_stop:(()->unit),?start:bool,
 source('a))->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + buffer
   Amount of data to pre-buffer, in seconds.
   + default
    1.
   + type
    float
  + fallible
   Allow the child source to fail, in which case the output will be (temporarily) stopped.
   + default
    false
   + type
    bool
  + max
   Maximum amount of buffered data, in seconds.
   + default
    10.
   + type
    float
  + on_start
   Callback executed when outputting starts.
   + default
    {()}
   + type
    ()->unit
  + on_stop
   Callback executed when outputting stops.
   + default
    {()}
   + type
    ()->unit
  + start
   Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
   + default
    true
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + clip
  Clip sound.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?max:float,?min:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + max
   Maximal acceptable value.
   + default
    0.999
   + type
    float
  + min
   Minimal acceptable value.
   + default
    -0.999
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + clock
  Assign a new clock to the given source (and to other time-dependent sources) and return the source. It is a conveniency wrapper around clock.assign_new(), allowing more concise scripts in some cases.
  + _category
   Liquidsoap
  + sync
   Do not synchronize the clock on regular wallclock time, but try to run as fast as possible (CPU burning mode).
   + default
    true
   + type
    bool
  + id
   (no doc)
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
  + _type
   (?sync:bool,?id:string,source('a))->source('a)
 + clock.assign_new
  Create a new clock and assign it to a list of sources.
  + _category
   Liquidsoap
  + _type
   (?id:string,?sync:bool,[source('a)])->unit
  + id
   Identifier for the new clock. The default empty string means that the identifier of the first source will be used.
   + default
    ""
   + type
    string
  + sync
   Do not synchronize the clock on regular wallclock time, but try to run as fast as possible (CPU burning mode).
   + default
    true
   + type
    bool
  + (unlabeled)
   List of sources to which the new clock will be assigned
   + default
    None
   + type
    [source('a)]
 + comb
  Comb filter.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?delay:float,?feedback:'a,
 source(audio='#b,video='#c,midi='#d))->
source(audio='#b,video='#c,midi='#d)
where 'a is either float or ()->float
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + delay
   Delay in seconds.
   + default
    0.001
   + type
    float
  + feedback
   Feedback coefficient in dB.
   + default
    -6.
   + type
    anything that is either float or ()->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#b,video='#c,midi='#d)
 + compand
  Compand the signal
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?mu:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + mu
   (no doc)
   + default
    1.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + compress
  Compress the signal.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?attack:'a,?gain:'b,?knee:'c,?ratio:float,
 ?release:'d,?rms_window:float,?threshold:'e,
 source(audio='#f,video='#g,midi='#h))->
source(audio='#f,video='#g,midi='#h)
where 'a, 'b, 'c, 'd, 'e is either float or ()->float
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + attack
   Attack time (ms).
   + default
    100.
   + type
    anything that is either float or ()->float
  + gain
   Additional gain (dB).
   + default
    0.
   + type
    anything that is either float or ()->float
  + knee
   Knee radius (dB).
   + default
    1.
   + type
    anything that is either float or ()->float
  + ratio
   Gain reduction ratio (n:1).
   + default
    2.
   + type
    float
  + release
   Release time (ms).
   + default
    400.
   + type
    anything that is either float or ()->float
  + rms_window
   Window for computing RMS (in sec).
   + default
    0.1
   + type
    float
  + threshold
   Threshold level (dB).
   + default
    -10.
   + type
    anything that is either float or ()->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#f,video='#g,midi='#h)
 + compress.exponential
  Exponential compressor.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?mu:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + mu
   Exponential compression factor, typically greater than 1.
   + default
    2.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + configure.default_font
  Liquidsoap's default font file.
  + _category
   Liquidsoap
  + _type
   string
 + configure.libdir
  Liquidsoap's library directory.
  + _category
   Liquidsoap
  + _type
   string
 + configure.logdir
  Liquidsoap's logging directory.
  + _category
   Liquidsoap
  + _type
   string
 + configure.rundir
  Liquidsoap's PID file directory.
  + _category
   Liquidsoap
  + _type
   string
 + cross
  Generic cross operator, allowing the composition of the N last seconds of a track with the beginning of the next track.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?active:bool,?conservative:bool,
 ?duration:float,?inhibit:float,?minimum:float,
 ?override:string,((source('a),source('a))->source('a)),
 source('a))->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + active
   The active behavior is to keep ticking the child's clock when the operator is not streaming. Otherwise the child's clock is strictly based on what is streamed off the child source, which results in time-dependent active sources to be frozen when that source is stopped.
   + default
    false
   + type
    bool
  + conservative
   Do not trust remaining time estimations, always buffering data in advance. This avoids being tricked by skips, either manual or caused by skip_blank().
   + default
    false
   + type
    bool
  + duration
   Duration in seconds of the crossed end of track. This value can be changed on a per-file basis using a special metadata field.
   + default
    5.
   + type
    float
  + inhibit
   Minimum delay between two transitions. It is useful in order to avoid that a transition is triggered on top of another when an end-of-track occurs in the first one. Negative values mean <code>duration+1</code>. Warning: zero inhibition can cause infinite loops.
   + default
    -1.
   + type
    float
  + minimum
   Minimum duration (in sec.) for a cross: If the track ends without any warning (e.g. in case of skip) there may not be enough data for a decent composition. Set to 0. to avoid having transitions after skips, or more to avoid transitions on short tracks. With the negative default, transitions always occur.
   + default
    -1.
   + type
    float
  + override
   Metadata field which, if present and containing a float, overrides the 'duration' parameter for current track.
   + default
    "liq_start_next"
   + type
    string
  + (unlabeled)
   Composition of an end of track and the next track.
   + default
    None
   + type
    (source('a),source('a))->source('a)
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + crossfade
  Simple crossfade.
  + _category
   Source / Track Processing
  + id
   (no doc)
   + default
    ""
   + type
    string
  + conservative
   Always prepare for a premature end-of-track.
   + default
    true
   + type
    bool
  + start_next
   Duration in seconds of the crossed end of track.
   + default
    5.
   + type
    float
  + fade_in
   Duration of the fade in for next track.
   + default
    3.
   + type
    float
  + fade_out
   Duration of the fade out for previous track.
   + default
    3.
   + type
    float
  + (unlabeled)
   The source to use.
   + default
    None
   + type
    source(audio='#a,video='#b,midi=0)
  + _type
   (?id:string,?conservative:bool,?start_next:float,
 ?fade_in:float,?fade_out:float,
 source(audio='#a,video='#b,midi=0))->
source(audio='#a,video='#b,midi=0)
 + cue_cut
  Start track after a cue in point and stop it at cue out point. The cue points are given as metadata, in seconds from the begining of tracks.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?cue_in_metadata:string,
 ?cue_out_metadata:string,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + cue_in_metadata
   Metadata for cue in points.
   + default
    "liq_cue_in"
   + type
    string
  + cue_out_metadata
   Metadata for cue out points.
   + default
    "liq_cue_out"
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + dB_of_lin
  Convert linear scale into decibels.
  + _category
   Math
  + _type
   (float)->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    float
 + delay
  Prevents the child from being ready again too fast after a end of track
  + _category
   Source / Track Processing
  + _type
   (?id:string,?initial:bool,float,source('a))->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + initial
   Start in unavailable state, as if a track had just finished.
   + default
    false
   + type
    bool
  + (unlabeled)
   The source won't be ready less than this amount of seconds after any end of track
   + default
    None
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + dirname
  Get the directory name of a path.
  + _category
   System
  + _type
   (string)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + drop_audio
  Drop all audio channels of a stream.
  + _category
   Source / Conversions
  + _type
   (?id:string,source(audio='#a,video='#b,midi='#c))->
source(audio=0,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + drop_metadata
  Removes all metadata coming from a source
  + _category
   Source / Track Processing
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
  + _type
   (source('a))->source('a)
 + drop_midi
  Drop all midi channels of a stream.
  + _category
   Source / Conversions
  + _type
   (?id:string,source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi=0)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + drop_video
  Drop all video channels of a stream.
  + _category
   Source / Conversions
  + _type
   (?id:string,source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video=0,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + eat_blank
  Eat blanks, i.e., drop the contents of the stream until it is not blank anymore.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?at_beginning:bool,?length:float,
 ?threshold:float,?track_sensitive:bool,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + at_beginning
   Only eat at the beginning of a track.
   + default
    false
   + type
    bool
  + length
   Maximum silence length allowed, in seconds.
   + default
    20.
   + type
    float
  + threshold
   Power in decibels under which the stream is considered silent.
   + default
    -40.
   + type
    float
  + track_sensitive
   Reset blank counter at each track.
   + default
    true
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + echo
  Add echo.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?delay:'a,?feedback:'b,?ping_pong:bool,
 source(audio='#c,video='#d,midi='#e))->
source(audio='#c,video='#d,midi='#e)
where 'a, 'b is either float or ()->float
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + delay
   Delay in seconds.
   + default
    0.5
   + type
    anything that is either float or ()->float
  + feedback
   Feedback coefficient in dB (negative).
   + default
    -6.
   + type
    anything that is either float or ()->float
  + ping_pong
   Use ping-pong delay.
   + default
    false
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#c,video='#d,midi='#e)
 + empty
  A source that does not produce anything. No silence, no track at all.
  + _category
   Source / Input
  + _type
   (?id:string)->source(audio='a,video='b,midi='c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
 + enable_external_faad_decoder
  Enable or disable external FAAD (AAC/AAC+/M4A) decoders. Requires faad binary in the path for audio decoding and metaflac binary for metadata. Does not work on Win32.
Please note that built-in support for faad is available in liquidsoap if compiled and should be preferred over the external decoder.
  + _category
   Liquidsoap
  + _type
   ()->unit
 + enable_external_flac_decoder
  Enable external FLAC decoders. Requires flac binary in the path for audio decoding and metaflac binary for metadata. Does not work on Win32. Default: disabled.
Please note that built-in support for FLAC is available in liquidsoap if compiled and should be preferred over the external decoder.
  + _category
   Liquidsoap
  + _type
   ()->unit
 + enable_external_mpc_decoder
  Enable external Musepack decoder. Requires the mpcdec binary in the path. Does not work on Win32.
  + _category
   Liquidsoap
  + _type
   ()->unit
 + enable_replaygain_metadata
  Enable replay gain metadata resolver. This resolver will process any file decoded by liquidsoap and add a replay_gain metadata when this value could be computed. For a finer-grained replay gain processing, use the replay_gain protocol.
  + _category
   Liquidsoap
  + extract_replaygain
   The extraction program
   + default
    "/usr/lib/liquidsoap/1.0.1/extract-replaygain"
   + type
    string
  + _type
   (?extract_replaygain:string)->unit
 + environment
  Return the process environment.
  + _category
   System
  + _type
   ()->[(string*string)]
 + eval
  Evaluate a string as an expression in the toplevel environment.
  + _category
   Liquidsoap
  + _type
   (string)->string
  + _flag
   hidden
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + exec_at
  Execute a given action when a predicate is true.
This will be run in background.
  + _category
   System
  + freq
   Frequency for checking the predicate, in seconds.
   + default
    1.
   + type
    float
  + pred
   Predicate indicating when to execute the function, typically a time interval such as <code>{10h-10h30}</code>.
   + default
    None
   + type
    ()->bool
  + (unlabeled)
   Function to execute when the predicate is true.
   + default
    None
   + type
    ()->unit
  + _type
   (?freq:float,pred:(()->bool),(()->unit))->unit
 + fade.final
  Fade a stream to silence.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?duration:float,?type:string,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + duration
   Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
   + default
    3.
   + type
    float
  + type
   Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
   + default
    "lin"
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + fade.in
  Fade the beginning of tracks. A special override metadata field can be used to set the duration for a specific track (float in seconds).
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?duration:float,?override:string,
 ?type:string,source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + duration
   Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
   + default
    3.
   + type
    float
  + override
   Metadata field which, if present and containing a float, overrides the 'duration' parameter for current track.
   + default
    "liq_fade_in"
   + type
    string
  + type
   Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
   + default
    "lin"
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + fade.initial
  Fade the beginning of a stream.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?duration:float,?type:string,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + duration
   Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
   + default
    3.
   + type
    float
  + type
   Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
   + default
    "lin"
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + fade.out
  Fade the end of tracks. A special override metadata field can be used to set the duration for a specific track (float in seconds).
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?duration:float,?override:string,
 ?type:string,source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + duration
   Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
   + default
    3.
   + type
    float
  + override
   Metadata field which, if present and containing a float, overrides the 'duration' parameter for current track.
   + default
    "liq_fade_out"
   + type
    string
  + type
   Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
   + default
    "lin"
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + fail
  Creates a source that fails to produce anything.
  + _category
   Source / Input
  + id
   (no doc)
   + default
    ""
   + type
    string
  + _type
   (?id:string)->source('a)
 + fallback
  At the beginning of each track, select the first ready child.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?replay_metadata:bool,?track_sensitive:bool,
 ?transitions:[(source('a),source('a))->source('a)],
 [source('a)])->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + replay_metadata
   Replay the last metadata of a child when switching to it in the middle of a track.
   + default
    true
   + type
    bool
  + track_sensitive
   Re-select only on end of tracks.
   + default
    true
   + type
    bool
  + transitions
   Transition functions, padded with <code>fun (x,y) -> y</code> functions.
   + default
    []
   + type
    [(source('a),source('a))->source('a)]
  + (unlabeled)
   Select the first ready source in this list.
   + default
    None
   + type
    [source('a)]
 + fallback.skip
  Special track insensitive fallback that always skips current song before switching.
  + _category
   Source / Track Processing
  + input
   The input source
   + default
    None
   + type
    source('a)
  + (unlabeled)
   The fallback source
   + default
    None
   + type
    source('a)
  + _type
   (input:source('a),source('a))->source('a)
 + file.duration
  Compute the duration in seconds of audio data contained in a file. The computation may be expensive. Returns -1. if computation failed, typically if the file was not recognized as valid audio.
  + _category
   Liquidsoap
  + _type
   (string)->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + file.exists
  Returns true if the file or directory exists.
  + _category
   System
  + _type
   (string)->bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + file.mime
  Get the MIME type of a file, according to libmagic.
  + _category
   Liquidsoap
  + _type
   (string)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + file.mime_default
  Alias of file.mime (because it is available)
  + _category
   System
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
  + _type
   (string)->string
 + filter
  Perform several kinds of filtering on the signal
  + _category
   Source / Sound Processing
  + _type
   (?id:string,freq:'a,mode:string,?q:'b,?wetness:'c,
 source(audio='#d,video='#e,midi='#f))->
source(audio='#d,video='#e,midi='#f)
where 'a, 'b, 'c is either float or ()->float
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + freq
   (no doc)
   + default
    None
   + type
    anything that is either float or ()->float
  + mode
   Available modes are 'low' (for low-pass filter), 'high' (for high-pass filter), 'band' (for band-pass filter) and 'notch' (for notch / band-stop / band-rejection filter).
   + default
    None
   + type
    string
  + q
   (no doc)
   + default
    1.
   + type
    anything that is either float or ()->float
  + wetness
   How much of the original signal should be added (1. means only filtered and 0. means only original signal).
   + default
    1.
   + type
    anything that is either float or ()->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#d,video='#e,midi='#f)
 + filter.fir
  Low-pass FIR filter.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,beta:float,?coeffs:int,frequency:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + beta
   Beta should range between 0 and 1.
   + default
    None
   + type
    float
  + coeffs
   Number of coefficients
   + default
    255
   + type
    int
  + frequency
   Corner frequency in Hz (frequency at which the response is 0.5, that is -6 dB).
   + default
    None
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.butterworth.bandpass
  IIR filter
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency1:float,frequency2:float,?order:int,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency1
   First corner frequency
   + default
    None
   + type
    float
  + frequency2
   Second corner frequency
   + default
    None
   + type
    float
  + order
   Filter order
   + default
    4
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.butterworth.bandstop
  IIR filter
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency1:float,frequency2:float,?order:int,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency1
   First corner frequency
   + default
    None
   + type
    float
  + frequency2
   Second corner frequency
   + default
    None
   + type
    float
  + order
   Filter order
   + default
    4
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.butterworth.high
  IIR filter
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency:float,?order:int,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency
   Corner frequency
   + default
    None
   + type
    float
  + order
   Filter order
   + default
    4
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.butterworth.low
  IIR filter
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency:float,?order:int,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency
   Corner frequency
   + default
    None
   + type
    float
  + order
   Filter order
   + default
    4
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.eq.allpass
  All pass biquad filter.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?bandwidth:float,frequency:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + bandwidth
   Bandwidth (in octaves)
   + default
    0.333333333333
   + type
    float
  + frequency
   Center frequency
   + default
    None
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.eq.bandpass
  Band pass biquad filter.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency:float,?q:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency
   Center frequency
   + default
    None
   + type
    float
  + q
   Q
   + default
    1.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.eq.high
  High pass biquad filter.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency:float,?q:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency
   Corner frequency
   + default
    None
   + type
    float
  + q
   Q
   + default
    1.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.eq.highshelf
  High shelf biquad filter.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency:float,?slope:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency
   Center frequency
   + default
    None
   + type
    float
  + slope
   Shelf slope (in dB/octave)
   + default
    1.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.eq.low
  Low pass biquad filter.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency:float,?q:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency
   Corner frequency
   + default
    None
   + type
    float
  + q
   Q
   + default
    1.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.eq.lowshelf
  Low shelf biquad filter.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency:float,?slope:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency
   Corner frequency
   + default
    None
   + type
    float
  + slope
   Shelf slope (dB/octave)
   + default
    1.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.eq.notch
  Band pass biquad filter.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency:float,?q:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency
   Center frequency
   + default
    None
   + type
    float
  + q
   Q
   + default
    1.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.eq.peak
  Peak EQ biquad filter.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency:float,?gain:float,?q:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency
   Center frequency
   + default
    None
   + type
    float
  + gain
   Gain (in dB)
   + default
    1.
   + type
    float
  + q
   Q
   + default
    1.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.resonator.allpass
  IIR filter
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency:float,?q:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency
   Corner frequency
   + default
    None
   + type
    float
  + q
   Quality factor
   + default
    60.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.resonator.bandpass
  IIR filter
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency:float,?q:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency
   Corner frequency
   + default
    None
   + type
    float
  + q
   Quality factor
   + default
    60.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + filter.iir.resonator.bandstop
  IIR filter
  + _category
   Source / Sound Processing
  + _type
   (?id:string,frequency:float,?q:float,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + frequency
   Corner frequency
   + default
    None
   + type
    float
  + q
   Quality factor
   + default
    60.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + flanger
  Flanger effect.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?delay:float,?feedback:'a,?freq:'b,?phase:'c,
 source(audio='#d,video='#e,midi='#f))->
source(audio='#d,video='#e,midi='#f)
where 'a, 'b, 'c is either float or ()->float
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + delay
   Delay in seconds.
   + default
    0.001
   + type
    float
  + feedback
   Feedback coefficient in dB.
   + default
    0.
   + type
    anything that is either float or ()->float
  + freq
   Frequency in Hz.
   + default
    0.5
   + type
    anything that is either float or ()->float
  + phase
   Phase difference between channels in radians.
   + default
    1.
   + type
    anything that is either float or ()->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#d,video='#e,midi='#f)
 + float_of_int
  Convert an int to a float.
  + _category
   Math
  + _type
   (int)->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    int
 + float_of_string
  Convert a string to a float.
  + _category
   String
  + _type
   (?default:float,string)->float
  + default
   (no doc)
   + default
    0.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + fst
  Get the first component of a pair.
  + _category
   Pair
  + _type
   (('a*'b))->'a
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ('a*'b)
 + garbage_collect
  Trigger full major garbage collection.
  + _category
   Liquidsoap
  + _type
   ()->unit
 + get
  Get a setting's value.
  + _category
   Liquidsoap
  + _type
   (default:'a,string)->'a
where 'a is bool, int, float, string or [string]
  + default
   (no doc)
   + default
    None
   + type
    anything that is bool, int, float, string or [string]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + get_clock_status
  Get the current time for all allocated clocks.
  + _category
   Liquidsoap
  + _type
   ()->[(string*int)]
 + get_mime
  Generic mime test. First try to use file.mime if it exist.
Otherwise try to get the value using the file binary.
Returns "" (empty string) if no value can be find.
  + _category
   System
  + (unlabeled)
   The file to test
   + default
    None
   + type
    string
  + _type
   (string)->string
 + get_process_lines
  Perform a shell call and return the list of its output lines.
  + _category
   System
  + _type
   (string)->[string]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + get_process_output
  Perform a shell call and return its output.
  + _category
   System
  + _type
   (string)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + getenv
  Get the value associated to a variable in the process environment. Return "" if variable is not set.
  + _category
   System
  + _type
   (string)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + getopt
  Parse command line options:
<code>getopt("-o")</code> returns "1" if "-o" was passed without any parameter, "0" otherwise.
<code>getopt(default="X","-o")</code> returns "Y" if "-o Y" was passed, "X" otherwise.
The result is removed from the list of arguments, affecting subsequent
calls to <code>argv()</code> and <code>getopt()</code>.
  + _category
   System
  + _type
   (?default:string,string)->string
  + default
   (no doc)
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + getpid
  Get the process' pid.
  + _category
   System
  + _type
   ()->int
 + gettimeofday
  Return the current time since 00:00:00 GMT, Jan. 1, 1970, in seconds.
  + _category
   System
  + _type
   ()->float
 + harbor.http.register
  Register a HTTP handler on the harbor. The given function receives as argument the full requested uri (e.g. "foo?var=bar"), http protocol version, possible input data and the list of HTTP headers and returns the answer sent to the client, including HTTP headers. Registered uri can be regular expressions (e.g. ".+\.php") and can override default metadata handlers.
  + _category
   Liquidsoap
  + _type
   (port:int,method:string,string,
 ((protocol:string,data:string,headers:[(string*string)],
   string)->string))->unit
  + port
   Port to server.
   + default
    None
   + type
    int
  + method
   Accepted method
   + default
    None
   + type
    string
  + (unlabeled)
   URI to serve.
   + default
    None
   + type
    string
  + (unlabeled)
   Function to execute. method argument is "PUT" or "GET", protocol argument is "HTTP/1.1" or "HTTP/1.0" etc., data argument contains data passed in case of a PUT request, and "" otherwise. headers argument contains the HTTP headers. Unlabeled argument contains the requested URI.
   + default
    None
   + type
    (protocol:string,data:string,headers:[(string*string)],
 string)->string
 + harbor.http.remove
  Remove a registered HTTP handler on the harbor.
  + _category
   Liquidsoap
  + _type
   (method:string,port:int,string)->unit
  + method
   Method served.
   + default
    None
   + type
    string
  + port
   Port to server.
   + default
    None
   + type
    int
  + (unlabeled)
   URI served.
   + default
    None
   + type
    string
 + http.get
  Perform a full Http GET request and return (status,headers),data.
  + _category
   Interaction
  + _type
   (?headers:[(string*string)],?timeout:float,string)->
((((string*int)*string)*[(string*string)])*string)
  + headers
   Additional headers.
   + default
    []
   + type
    [(string*string)]
  + timeout
   Timeout for network operations.
   + default
    10.
   + type
    float
  + (unlabeled)
   Requested URL, e.g. "http://www.google.com:80/index.html".
   + default
    None
   + type
    string
 + http.post
  Perform a full Http POST request and return (status,headers),data.
  + _category
   Interaction
  + _type
   (?data:string,?headers:[(string*string)],?timeout:float,
 string)->
((((string*int)*string)*[(string*string)])*string)
  + data
   Http POST data.
   + default
    ""
   + type
    string
  + headers
   Additional headers.
   + default
    []
   + type
    [(string*string)]
  + timeout
   Timeout for network operations.
   + default
    10.
   + type
    float
  + (unlabeled)
   Requested URL, e.g. "http://www.google.com:80/index.html".
   + default
    None
   + type
    string
 + http_codes
  List of HTTP response codes and statuses.
  + _category
   Interaction
  + _type
   [(string*string)]
 + http_response
  Create a HTTP response string
  + _category
   Interaction
  + protocol
   HTTP protocol used.
   + default
    "HTTP/1.1"
   + type
    string
  + code
   Response code.
   + default
    200
   + type
    int
  + headers
   Response headers.
   + default
    []
   + type
    [(string*string)]
  + data
   Response data
   + default
    ""
   + type
    string
  + _type
   (?protocol:string,?code:int,?headers:[(string*string)],
 ?data:string)->string
 + id
  Does not do anything, simply forwards its input stream.
  + _category
   Source / Conversions
  + _type
   (?id:string,source('a))->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + if
  The basic conditional.
  + _category
   Control
  + _type
   (bool,then:(()->'a),else:(()->'a))->'a
  + _flag
   hidden
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    bool
  + then
   (no doc)
   + default
    None
   + type
    ()->'a
  + else
   (no doc)
   + default
    None
   + type
    ()->'a
 + ignore
  Convert anything to unit, preventing warnings.
  + _category
   Control
  + _type
   ('a)->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    'a
 + in
  Create a source from the first available input driver in pulseaudio, portaudio, oss, alsa, blank.
  + _category
   Source / Input
  + id
   (no doc)
   + default
    ""
   + type
    string
  + start
   (no doc)
   + default
    true
   + type
    bool
  + on_start
   (no doc)
   + default
    {()}
   + type
    ()->unit
  + on_stop
   (no doc)
   + default
    {()}
   + type
    ()->unit
  + fallible
   (no doc)
   + default
    false
   + type
    bool
  + _type
   (?id:string,?start:bool,?on_start:(()->unit),
 ?on_stop:(()->unit),?fallible:bool)->source('a)
 + input.external
  Stream data from an external application.
  + _category
   Source / Input
  + _type
   (?id:string,?buffer:float,?channels:int,?max:float,
 ?restart:bool,?restart_on_error:bool,?samplerate:int,
 string)->source(audio='#a+1,video=0,midi=0)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + buffer
   Duration of the pre-buffered data.
   + default
    2.
   + type
    float
  + channels
   Number of channels.
   + default
    2
   + type
    int
  + max
   Maximum duration of the buffered data.
   + default
    10.
   + type
    float
  + restart
   Restart process when exited.
   + default
    true
   + type
    bool
  + restart_on_error
   Restart process when exited with error.
   + default
    false
   + type
    bool
  + samplerate
   Samplerate.
   + default
    44100
   + type
    int
  + (unlabeled)
   Command to execute.
   + default
    None
   + type
    string
 + input.harbor
  Retrieves the given http stream from the harbor.
  + _category
   Source / Input
  + _type
   (?id:string,?auth:((string,string)->bool),?buffer:float,
 ?debug:bool,?dumpfile:string,?icy:bool,
 ?icy_metadata_charset:string,?logfile:string,?max:float,
 ?metadata_charset:string,
 ?on_connect:(([(string*string)])->unit),
 ?on_disconnect:(()->unit),?password:string,?port:int,
 ?timeout:float,?user:string,string)->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + auth
   Authentication function. <code>f(login,password)</code> returns <code>true</code> if the user should be granted access for this login. Override any other method if used.
   + default
    fun (_,_) -> false
   + type
    (string,string)->bool
  + buffer
   Duration of the pre-buffered data.
   + default
    2.
   + type
    float
  + debug
   Run in debugging mode by not catching some exceptions.
   + default
    false
   + type
    bool
  + dumpfile
   Dump stream to file, for debugging purpose. Disabled if empty.
   + default
    ""
   + type
    string
  + icy
   Enable ICY (shoutcast) protocol.
   + default
    false
   + type
    bool
  + icy_metadata_charset
   ICY (shoutcast) metadata charset. Guessed if empty. Default for shoutcast is ISO-8859-1. Set to that value if all your clients send metadata using this charset and automatic detection is not working for you.
   + default
    ""
   + type
    string
  + logfile
   Log buffer status to file, for debugging purpose. Disabled if empty.
   + default
    ""
   + type
    string
  + max
   Maximum duration of the buffered data.
   + default
    10.
   + type
    float
  + metadata_charset
   Metadata charset for non-ICY (shoutcast) source protocols. Guessed if empty.
   + default
    ""
   + type
    string
  + on_connect
   Function to execute when a source is connected. Its receives the list of headers, of the form: (<label>,<value>). All labels are lowercase.
   + default
    fun (_) -> ()
   + type
    ([(string*string)])->unit
  + on_disconnect
   Functions to excecute when a source is disconnected
   + default
    {()}
   + type
    ()->unit
  + password
   Source password.
   + default
    "hackme"
   + type
    string
  + port
   Port used to connect to the source.
   + default
    8005
   + type
    int
  + timeout
   Timeout for source connectionn.
   + default
    30.
   + type
    float
  + user
   Source user.
   + default
    "source"
   + type
    string
  + (unlabeled)
   Mountpoint to look for.
   + default
    None
   + type
    string
 + input.http
  Forwards the given http stream. The relay can be paused/resumed using the start/stop telnet commands.
  + _category
   Source / Input
  + _type
   (?id:string,?autostart:bool,?bind_address:string,
 ?buffer:float,?debug:bool,?force_mime:string,
 ?logfile:string,?max:float,?new_track_on_metadata:bool,
 ?playlist_mode:string,?poll_delay:float,?timeout:float,
 ?user_agent:string,string)->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + autostart
   Initially start relaying or not.
   + default
    true
   + type
    bool
  + bind_address
   Address to bind on the local machine. This option can be useful if your machine is bound to multiple IPs. Empty means no bind address.
   + default
    ""
   + type
    string
  + buffer
   Duration of the pre-buffered data.
   + default
    2.
   + type
    float
  + debug
   Run in debugging mode, not catching some exceptions.
   + default
    false
   + type
    bool
  + force_mime
   Force mime data type. Not used if empty.
   + default
    ""
   + type
    string
  + logfile
   Log buffer status to file, for debugging purpose. Disabled if empty.
   + default
    ""
   + type
    string
  + max
   Maximum duration of the buffered data.
   + default
    10.
   + type
    float
  + new_track_on_metadata
   Treat new metadata as new track.
   + default
    true
   + type
    bool
  + playlist_mode
   Valid modes are "normal", "random", "randomize" and "first". The first ones have the same meaning as for the mode parameter of the playlist operator. The last one discards all entries but the first one.
   + default
    "normal"
   + type
    string
  + poll_delay
   Polling delay when trying to connect to the stream.
   + default
    2.
   + type
    float
  + timeout
   Timeout for source connectionn.
   + default
    30.
   + type
    float
  + user_agent
   User agent.
   + default
    "Liquidsoap/1.0.1 (Unix; OCaml 3.12.1)"
   + type
    string
  + (unlabeled)
   URL of an http stream (default port is 80).
   + default
    None
   + type
    string
 + input.keyboard
  Play notes from the keyboard.
  + _category
   Source / Input
  + _type
   (?id:string)->source(audio='#a,video=0,midi='#b+1)
  + _flag
   hidden
  + _flag
   experimental
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
 + input.mplayer
  Stream data from mplayer
  + _category
   Source / Input
  + _category
   Source / Input
  + id
   (no doc)
   + default
    "input.mplayer"
   + type
    string
  + restart
   restart on exit.
   + default
    true
   + type
    bool
  + restart_on_error
   restart on exit with error.
   + default
    false
   + type
    bool
  + buffer
   Duration of the pre-buffered data.
   + default
    0.2
   + type
    float
  + max
   Maximum duration of the buffered data.
   + default
    10.
   + type
    float
  + (unlabeled)
   data URI.
   + default
    None
   + type
    string
  + _type
   (?id:string,?restart:bool,?restart_on_error:bool,
 ?buffer:float,?max:float,string)->
source(audio='#a+1,video=0,midi=0)
 + input.udp
  Input encoded data from UDP, without any control whatsoever.
  + _category
   Source / Input
  + _type
   (?id:string,?buffer:float,host:string,port:int,string)->
active_source('a)
  + _flag
   experimental
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + buffer
   Duration of buffered data before starting playout.
   + default
    1.
   + type
    float
  + host
   (no doc)
   + default
    None
   + type
    string
  + port
   (no doc)
   + default
    None
   + type
    int
  + (unlabeled)
   Mime type.
   + default
    None
   + type
    string
 + insert_metadata
  Dynamically insert metadata in a stream. Returns a pair (f,s) where s is a new source and f is a function of type (metadata)->unit, used to insert metadata in s.
  + _category
   Source / Track Processing
  + _type
   (?id:string,source('a))->
((([(string*string)])->unit)*source('a))
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + int_of_float
  Convert a float to a int.
  + _category
   Math
  + _type
   (float)->int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    float
 + int_of_string
  Convert a string to a int.
  + _category
   String
  + _type
   (?default:int,string)->int
  + default
   (no doc)
   + default
    0
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + interactive.float
  Read a float from an interactive input.
  + _category
   Interaction
  + _type
   (string,float)->()->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    float
 + interactive.string
  Read a string from an interactive input.
  + _category
   Interaction
  + _type
   (string,string)->()->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + is_directory
  Returns true if the directory exists.
  + _category
   System
  + _type
   (string)->bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + json_of
  Convert a value to a json string.
  + _category
   String
  + _type
   (?compact:bool,'a)->string
  + compact
   Output compact text.
   + default
    false
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    'a
 + limit
  Limit the signal.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?attack:'a,?gain:'b,?knee:'c,?ratio:float,
 ?release:'d,?rms_window:float,?threshold:'e,
 source(audio='#f,video='#g,midi='#h))->
source(audio='#f,video='#g,midi='#h)
where 'a, 'b, 'c, 'd, 'e is either float or ()->float
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + attack
   Attack time (ms).
   + default
    100.
   + type
    anything that is either float or ()->float
  + gain
   Additional gain (dB).
   + default
    0.
   + type
    anything that is either float or ()->float
  + knee
   Knee radius (dB).
   + default
    1.
   + type
    anything that is either float or ()->float
  + ratio
   Gain reduction ratio (n:1).
   + default
    20.
   + type
    float
  + release
   Release time (ms).
   + default
    400.
   + type
    anything that is either float or ()->float
  + rms_window
   Window for computing RMS (in sec).
   + default
    0.1
   + type
    float
  + threshold
   Threshold level (dB).
   + default
    -10.
   + type
    anything that is either float or ()->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#f,video='#g,midi='#h)
 + lin_of_dB
  Convert decibels into linear scale.
  + _category
   Math
  + _type
   (float)->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    float
 + liquidsoap.version
  Liquidsoap version string.
  + _category
   Liquidsoap
  + _type
   string
 + list.append
  Catenate two lists.
  + _category
   List
  + _type
   (['a],['a])->['a]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ['a]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ['a]
 + list.assoc
  Alias for the <code>l[k]</code> notation.
  + _category
   List
  + (unlabeled)
   Key to look for
   + default
    None
   + type
    string
  + (unlabeled)
   List of pairs (key,value)
   + default
    None
   + type
    [(string*string)]
  + _type
   (string,[(string*string)])->string
 + list.fold
  Fold a function on every element of a list: list.fold(f,x1,[e1,..,en]) is f(...f(f(x1,e1),e2)...,en).
  + _category
   List
  + _type
   ((('a,'b)->'a),'a,['b])->'a
  + (unlabeled)
   Function f for which f(x,e) which will be called on every element e with the current value of x, returning the new value of x.
   + default
    None
   + type
    ('a,'b)->'a
  + (unlabeled)
   Initial value x1, to be updated by successive calls of f(x,e).
   + default
    None
   + type
    'a
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ['b]
 + list.hd
  Return the head (first element) of a list, or "" if the list is empty.
  + _category
   List
  + _type
   ([string])->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    [string]
 + list.iter
  Call a function on every element of a list.
  + _category
   List
  + _type
   ((('a)->unit),['a])->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ('a)->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ['a]
 + list.length
  Get the length of a list, i.e. its number of elements.
  + _category
   List
  + _type
   (['a])->int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ['a]
 + list.map
  Map a function on every element of a list.
  + _category
   List
  + _type
   ((('a)->'b),['a])->['b]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ('a)->'b
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ['a]
 + list.mem
  Check if an element belongs to a list.
  + _category
   List
  + _type
   ('a,['a])->bool where 'a is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is an orderable type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ['a] where 'a is an orderable type
 + list.mem_assoc
  list.mem_assoc(key,l) returns true if l contains a pair (key,value)
  + _category
   List
  + (unlabeled)
   Key to look for
   + default
    None
   + type
    anything that is an orderable type
  + (unlabeled)
   List of pairs (key,value)
   + default
    None
   + type
    [('a*'b)] where 'a is an orderable type
  + _type
   ('a,[('a*'b)])->bool where 'a is an orderable type
 + list.nth
  Get the n-th element of a list (the first element is at position 0).
  + _category
   List
  + _type
   (['a],int)->'a
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ['a]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    int
 + list.remove
  Remove a value from a list.
  + _category
   List
  + _type
   ('a,['a])->['a]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    'a
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ['a]
 + list.remove_assoc
  Remove a pair from an associative list
  + _category
   List
  + (unlabeled)
   Key of pair to be removed
   + default
    None
   + type
    string
  + (unlabeled)
   List of pairs (key,value)
   + default
    None
   + type
    [(string*string)]
  + _type
   (string,[(string*string)])->[(string*string)]
 + list.rev
  Revert list order.
  + _category
   List
  + _type
   (['a])->['a]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ['a]
 + list.sort
  Sort a list according to a comparison function.
  + _category
   List
  + _type
   ((('a,'a)->int),['a])->['a]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ('a,'a)->int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ['a]
 + list.tl
  Return the list without its first element.
  + _category
   List
  + _type
   (['a])->['a]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ['a]
 + log
  Log a message.
  + _category
   Liquidsoap
  + _type
   (?label:string,?level:int,string)->unit
  + label
   (no doc)
   + default
    "lang"
   + type
    string
  + level
   (no doc)
   + default
    3
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + log_clocks
  Create a log of clock times for all the clocks initially present.
The log is in a simple format which you can directly use with gnuplot.
  + _category
   Liquidsoap
  + delay
   Delay before setting up the clock logger. This should be used to ensure that the logger starts only after the clocks are created.
   + default
    0.
   + type
    float
  + interval
   Polling interval.
   + default
    1.
   + type
    float
  + (unlabeled)
   Path of the log file.
   + default
    None
   + type
    string
  + _type
   (?delay:float,?interval:float,string)->unit
 + map_metadata
  Rewrite metadata on the fly using a function.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?insert_missing:bool,?strip:bool,
 ?update:bool,(([(string*string)])->[(string*string)]),
 source('a))->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + insert_missing
   Treat track beginnings without metadata as having empty ones. The operational order is: create empty if needed, map and strip if enabled.
   + default
    true
   + type
    bool
  + strip
   Completely remove empty metadata. Operates on both empty values and empty metadata chunk.
   + default
    false
   + type
    bool
  + update
   Only update metadata. If false, only returned values will be set as metadata.
   + default
    true
   + type
    bool
  + (unlabeled)
   A function that returns new metadata.
   + default
    None
   + type
    ([(string*string)])->[(string*string)]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + mean
  Produce mono audio by taking the mean of all audio channels.
  + _category
   Source / Conversions
  + _type
   (?id:string,source(audio='#a,video='#b,midi='#c))->
source(audio=1,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + merge_tracks
  Merge all tracks from a source, provided that it does not fail
  + _category
   Source / Track Processing
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
  + _type
   (source('a))->source('a)
 + metadata.export
  Filter-out internal metadata.
  + _category
   Liquidsoap
  + _type
   ([(string*string)])->[(string*string)]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    [(string*string)]
 + mic_filter
  Remove low frequencies often produced by microphones.
  + _category
   Source / Sound Processing
  + (unlabeled)
   The input source.
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
  + _type
   (source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
 + midi.chord
  Generate a chord.
  + _category
   Source / MIDI Processing
  + _type
   (?id:string,?metadata:string,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c+1)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + metadata
   Name of the metadata containing the chords.
   + default
    "chord"
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + midi.merge_all
  Merge all MIDI tracks in one.
  + _category
   Source / MIDI Processing
  + _type
   (?id:string,?track_out:int,
 source(audio='#a,video='#b,midi='#c+1))->
source(audio='#a,video='#b,midi='#c+1)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + track_out
   Destination track.
   + default
    0
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c+1)
 + midi.remove
  Remove MIDI tracks.
  + _category
   Source / MIDI Processing
  + _type
   (?id:string,[int],source(audio='#a,video='#b,midi='#c+1))->
source(audio='#a,video='#b,midi='#c+1)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   Tracks to remove.
   + default
    None
   + type
    [int]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c+1)
 + midimeter
  Display midi events.
  + _category
   Source / Visualization
  + _type
   (?id:string,source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + _flag
   hidden
  + _flag
   experimental
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + mix
  Mixing table controllable via the telnet interface.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,[source(audio='#a,video='#b,midi='#c)])->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    [source(audio='#a,video='#b,midi='#c)]
 + mksafe
  Turn a source into an infaillible source.
by adding blank when the source is not available.
  + _category
   Source / Track Processing
  + (unlabeled)
   the source to turn infaillible
   + default
    None
   + type
    source('a)
  + _type
   (source('a))->source('a)
 + mod
  Integer remainder. If y is not zero, x == (x / y) * y + x mod y, and abs(x mod y) <= abs(y)-1.
  + _category
   Math
  + _type
   (int,int)->int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    int
 + mux_audio
  Add audio channnels to a stream.
  + _category
   Source / Conversions
  + _type
   (?id:string,audio:source(audio='#a,video=0,midi=0),
 source(audio=0,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + audio
   (no doc)
   + default
    None
   + type
    source(audio='#a,video=0,midi=0)
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio=0,video='#b,midi='#c)
 + mux_mono
  Add audio channnels to a stream.
  + _category
   Source / Conversions
  + _type
   (?id:string,mono:source(audio=1,video=0,midi=0),
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a+1,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + mono
   (no doc)
   + default
    None
   + type
    source(audio=1,video=0,midi=0)
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + mux_video
  Add video channnels to a stream.
  + _category
   Source / Conversions
  + _type
   (?id:string,video:source(audio=0,video='#a,midi=0),
 source(audio='#b,video=0,midi='#c))->
source(audio='#b,video='#a,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + video
   (no doc)
   + default
    None
   + type
    source(audio=0,video='#a,midi=0)
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#b,video=0,midi='#c)
 + noise
  Generate white noise.
  + _category
   Source / Input
  + _type
   (?id:string,?duration:float)->
source(audio='a,video='b,midi=0)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + duration
   (no doc)
   + default
    0.
   + type
    float
 + normalize
  Normalize the signal. Dynamic normalization of the signal is sometimes the only option, and can make a listening experience much nicer. However, its dynamic aspect implies some limitations which can go as far as creating saturation in some extreme cases. If possible, consider using some track-based normalization techniques such as those based on replay gain. See the documentation for more details.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?gain_max:'a,?gain_min:'b,?k_down:'c,
 ?k_up:'d,?target:'e,?threshold:'f,?window:float,
 source(audio='#g,video='#h,midi='#i))->
source(audio='#g,video='#h,midi='#i)
where 'a, 'b, 'c, 'd, 'e, 'f is either float or ()->float
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + gain_max
   Maximal gain value (dB).
   + default
    6.
   + type
    anything that is either float or ()->float
  + gain_min
   Minimal gain value (dB).
   + default
    -6.
   + type
    anything that is either float or ()->float
  + k_down
   Coefficient when the power must go down (between 0 and 1, slowest to fastest).
   + default
    0.1
   + type
    anything that is either float or ()->float
  + k_up
   Coefficient when the power must go up (between 0 and 1, slowest to fastest).
   + default
    0.005
   + type
    anything that is either float or ()->float
  + target
   Desired RMS (dB).
   + default
    -13.
   + type
    anything that is either float or ()->float
  + threshold
   Minimal RMS for activaing gain control (dB).
   + default
    -40.
   + type
    anything that is either float or ()->float
  + window
   Duration of the window used to compute the current RMS power (second).
   + default
    0.1
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#g,video='#h,midi='#i)
 + not
  Returns the negation of its argument.
  + _category
   Bool
  + _type
   (bool)->bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    bool
 + notify_metadata
  Use notify to display metadata info.
  + _category
   Source / Track Processing
  + urgency
   Urgency (low|normal|critical).
   + default
    "low"
   + type
    string
  + icon
   Icon filename or stock icon to display.
   + default
    "stock_smiley-22"
   + type
    string
  + time
   Timeout in milliseconds.
   + default
    3000
   + type
    int
  + display
   Function used to display a metadata packet.
   + default
    <fun>
   + type
    ([(string*string)])->string
  + title
   Title of the notification message.
   + default
    "Liquidsoap: new track"
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
  + _type
   (?urgency:string,?icon:string,?time:int,
 ?display:(([(string*string)])->string),?title:string,
 source('a))->source('a)
 + nrj
  Compress and normalize, producing a more uniform and "full" sound.
  + _category
   Source / Sound Processing
  + (unlabeled)
   The input source.
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
  + _type
   (source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
 + of_json
  Parse a json string into a liquidsoap value.
  + _category
   String
  + _type
   (default:'a,string)->'a
  + default
   Default value if string cannot be parsed.
   + default
    None
   + type
    'a
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + on_blank
  Calls a given handler when detecting a blank.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?length:float,?on_noise:(()->unit),
 ?threshold:float,?track_sensitive:bool,(()->unit),
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + length
   Maximum silence length allowed, in seconds.
   + default
    20.
   + type
    float
  + on_noise
   Handler called when noise is detected.
   + default
    {()}
   + type
    ()->unit
  + threshold
   Power in decibels under which the stream is considered silent.
   + default
    -40.
   + type
    float
  + track_sensitive
   Reset blank counter at each track.
   + default
    true
   + type
    bool
  + (unlabeled)
   Handler called when blank is detected.
   + default
    None
   + type
    ()->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + on_end
  Call a given handler when there is less than a given amount of time remaining before then end of track.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?delay:float,
 ((float,[(string*string)])->unit),source('a))->
source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + delay
   Execute handler when remaining time is less or equal to this value.
   + default
    5.
   + type
    float
  + (unlabeled)
   Function to execute. First argument is the remaining time, second is the latest metadata.
   + default
    None
   + type
    (float,[(string*string)])->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + on_metadata
  Call a given handler on metadata packets.
  + _category
   Source / Track Processing
  + _type
   (?id:string,(([(string*string)])->unit),source('a))->
source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   Function called on every metadata packet in the stream. It should be fast because it is ran in the main thread.
   + default
    None
   + type
    ([(string*string)])->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + on_shutdown
  Register a function to be called when Liquidsoap shuts down.
  + _category
   System
  + _type
   ((()->unit))->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ()->unit
 + on_track
  Call a given handler on new tracks.
  + _category
   Source / Track Processing
  + _type
   (?id:string,(([(string*string)])->unit),source('a))->
source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   Function called on every beginning of track in the stream, with the corresponding metadata as argument. If there is no metadata at the beginning of track, the empty list is passed. That function should be fast because it is ran in the main thread.
   + default
    None
   + type
    ([(string*string)])->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + once
  Creates a source that plays only one track of the input source.
  + _category
   Source / Track Processing
  + (unlabeled)
   The input source.
   + default
    None
   + type
    source('a)
  + _type
   (source('a))->source('a)
 + or
  Return the disjunction of its arguments
  + _category
   Bool
  + _type
   (bool,bool)->bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    bool
 + os.type
  Type of OS running liquidsoap.
  + _category
   System
  + _type
   string
 + osd_metadata
  Use X On Screen Display to display metadata info.
  + _category
   Source / Track Processing
  + color
   Color of the text.
   + default
    "green"
   + type
    string
  + position
   Position of the text (top|middle|bottom).
   + default
    "top"
   + type
    string
  + font
   Font used (xfontsel is your friend...)
   + default
    "-*-courier-*-r-*-*-*-240-*-*-*-*-*-*"
   + type
    string
  + display
   Function used to display a metadata packet.
   + default
    <fun>
   + type
    ([(string*string)])->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
  + _type
   (?color:string,?position:string,?font:string,
 ?display:(([(string*string)])->string),source('a))->
source('a)
 + out
  Output a stream using the 'output.prefered' operator. The input source does not need to be infallible, blank will just be played during failures.
  + _category
   Source / Output
  + (unlabeled)
   the source to output
   + default
    None
   + type
    source('a)
  + _type
   (source('a))->active_source('a)
 + output.dummy
  Dummy output for debugging purposes.
  + _category
   Source / Output
  + _type
   (?id:string,?fallible:bool,?on_start:(()->unit),
 ?on_stop:(()->unit),?start:bool,source('a))->
active_source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + fallible
   Allow the child source to fail, in which case the output will be (temporarily) stopped.
   + default
    false
   + type
    bool
  + on_start
   Callback executed when outputting starts.
   + default
    {()}
   + type
    ()->unit
  + on_stop
   Callback executed when outputting stops.
   + default
    {()}
   + type
    ()->unit
  + start
   Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
   + default
    true
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + output.external
  Send the stream to a process' standard input.
  + _category
   Source / Output
  + _type
   (?id:string,?fallible:bool,?flush:bool,
 ?on_start:(()->unit),?on_stop:(()->unit),
 ?reopen_delay:float,?reopen_on_metadata:bool,
 ?reopen_when:(()->bool),?start:bool,format('a),string,
 source('a))->active_source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + fallible
   Allow the child source to fail, in which case the output will be (temporarily) stopped.
   + default
    false
   + type
    bool
  + flush
   Perform a flush after each write.
   + default
    false
   + type
    bool
  + on_start
   Callback executed when outputting starts.
   + default
    {()}
   + type
    ()->unit
  + on_stop
   Callback executed when outputting stops.
   + default
    {()}
   + type
    ()->unit
  + reopen_delay
   Prevent re-opening within that delay, in seconds.
   + default
    120.
   + type
    float
  + reopen_on_metadata
   Re-open on every new metadata information.
   + default
    false
   + type
    bool
  + reopen_when
   When should the output be re-opened.
   + default
    {false}
   + type
    ()->bool
  + start
   Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
   + default
    true
   + type
    bool
  + (unlabeled)
   Encoding format.
   + default
    None
   + type
    format('a)
  + (unlabeled)
   Process to pipe data to. Some strftime conversion specifiers are available: <code>%SMHdmY</code>. You can also use <code>$(..)</code> interpolation notation for metadata.
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + output.file
  Output the source stream to a file.
  + _category
   Source / Output
  + _type
   (?id:string,?append:bool,?dir_perm:int,?fallible:bool,
 ?flush:bool,?on_close:((string)->unit),
 ?on_start:(()->unit),?on_stop:(()->unit),?perm:int,
 ?reopen_delay:float,?reopen_on_metadata:bool,
 ?reopen_when:(()->bool),?start:bool,format('a),string,
 source('a))->active_source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + append
   Do not truncate but append in the file if it exists.
   + default
    false
   + type
    bool
  + dir_perm
   Permission of the directories if some have to be created, up to umask. Although you can enter values in octal notation (0oXXX) they will be displayed in decimal (for instance, 0o777 = 7*8^2 + 7*8 + 7 = 511).
   + default
    511
   + type
    int
  + fallible
   Allow the child source to fail, in which case the output will be (temporarily) stopped.
   + default
    false
   + type
    bool
  + flush
   Perform a flush after each write.
   + default
    false
   + type
    bool
  + on_close
   This function will be called for each file, after that it is finished and closed. The filename will be passed as argument.
   + default
    fun (_) -> ()
   + type
    (string)->unit
  + on_start
   Callback executed when outputting starts.
   + default
    {()}
   + type
    ()->unit
  + on_stop
   Callback executed when outputting stops.
   + default
    {()}
   + type
    ()->unit
  + perm
   Permission of the file if it has to be created, up to umask. You can and should write this number in octal notation: 0oXXX. The default value is however displayed in decimal (0o666 = 6*8^2 + 6*8 + 6 = 438).
   + default
    438
   + type
    int
  + reopen_delay
   Prevent re-opening within that delay, in seconds.
   + default
    120.
   + type
    float
  + reopen_on_metadata
   Re-open on every new metadata information.
   + default
    false
   + type
    bool
  + reopen_when
   When should the output be re-opened.
   + default
    {false}
   + type
    ()->bool
  + start
   Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
   + default
    true
   + type
    bool
  + (unlabeled)
   Encoding format.
   + default
    None
   + type
    format('a)
  + (unlabeled)
   Filename where to output the stream. Some strftime conversion specifiers are available: <code>%SMHdmY</code>. You can also use <code>$(..)</code> interpolation notation for metadata.
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + output.harbor
  Encode and output the stream using the harbor server.
  + _category
   Source / Output
  + _type
   (?id:string,?auth:((string,string)->bool),?buffer:int,
 ?burst:int,?chunk:int,?dumpfile:string,?encoding:string,
 ?fallible:bool,?format:string,
 ?headers:[(string*string)],?icy_metadata:string,
 ?metaint:int,mount:string,
 ?on_connect:((headers:[(string*string)],uri:string,
               protocol:string,string)->unit),
 ?on_disconnect:((string)->unit),?on_start:(()->unit),
 ?on_stop:(()->unit),?password:string,?port:int,
 ?protocol:string,?start:bool,?timeout:float,?url:string,
 ?user:string,format('a),source('a))->active_source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + auth
   Authentication function. <code>f(login,password)</code> returns <code>true</code> if the user should be granted access for this login. Override any other method if used.
   + default
    fun (_,_) -> false
   + type
    (string,string)->bool
  + buffer
   Maximun buffer per-client.
   + default
    327675
   + type
    int
  + burst
   Initial burst of data sent to the client.
   + default
    65534
   + type
    int
  + chunk
   Send data to clients using chunks of at least this length.
   + default
    1024
   + type
    int
  + dumpfile
   Dump stream to file, for debugging purpose. Disabled if empty.
   + default
    ""
   + type
    string
  + encoding
   Encoding used to send metadata. If empty, defaults to "ISO-8859-1" for non-ogg formats and "UTF-8" otherwise.
   + default
    ""
   + type
    string
  + fallible
   Allow the child source to fail, in which case the output will be (temporarily) stopped.
   + default
    false
   + type
    bool
  + format
   Format, e.g. "audio/ogg". When empty, the encoder is used to guess.
   + default
    ""
   + type
    string
  + headers
   Additional headers.
   + default
    []
   + type
    [(string*string)]
  + icy_metadata
   Send new metadata using the ICY protocol. One of: "guess", "true", "false"
   + default
    "guess"
   + type
    string
  + metaint
   Interval used to send ICY metadata
   + default
    16000
   + type
    int
  + mount
   (no doc)
   + default
    None
   + type
    string
  + on_connect
   Callback executed when connection is established.
   + default
    fun (~headers,~uri,~protocol,_) -> ()
   + type
    (headers:[(string*string)],uri:string,protocol:string,
 string)->unit
  + on_disconnect
   Callback executed when connection stops.
   + default
    fun (_) -> ()
   + type
    (string)->unit
  + on_start
   Callback executed when outputting starts.
   + default
    {()}
   + type
    ()->unit
  + on_stop
   Callback executed when outputting stops.
   + default
    {()}
   + type
    ()->unit
  + password
   (no doc)
   + default
    "hackme"
   + type
    string
  + port
   (no doc)
   + default
    8000
   + type
    int
  + protocol
   Protocol of the streaming server: 'http' for Icecast, 'icy' for shoutcast.
   + default
    "http"
   + type
    string
  + start
   Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
   + default
    true
   + type
    bool
  + timeout
   Timeout for network operations.
   + default
    30.
   + type
    float
  + url
   (no doc)
   + default
    ""
   + type
    string
  + user
   User for client connection, disabled if empty.
   + default
    ""
   + type
    string
  + (unlabeled)
   Encoding format.
   + default
    None
   + type
    format('a)
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + output.prefered
  Output to local audio card using the first available driver in pulseaudio, portaudio, oss, alsa, ao, dummy.
  + _category
   Source / Output
  + id
   (no doc)
   + default
    ""
   + type
    string
  + fallible
   (no doc)
   + default
    false
   + type
    bool
  + on_start
   (no doc)
   + default
    {()}
   + type
    ()->unit
  + on_stop
   (no doc)
   + default
    {()}
   + type
    ()->unit
  + start
   (no doc)
   + default
    true
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
  + _type
   (?id:string,?fallible:bool,?on_start:(()->unit),
 ?on_stop:(()->unit),?start:bool,source('a))->
active_source('a)
 + output.udp
  Output encoded data to UDP, without any control whatsoever.
  + _category
   Source / Output
  + _type
   (?id:string,?fallible:bool,host:string,
 ?on_start:(()->unit),?on_stop:(()->unit),port:int,
 ?start:bool,format('a),source('a))->active_source('a)
  + _flag
   experimental
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + fallible
   Allow the child source to fail, in which case the output will be (temporarily) stopped.
   + default
    false
   + type
    bool
  + host
   (no doc)
   + default
    None
   + type
    string
  + on_start
   Callback executed when outputting starts.
   + default
    {()}
   + type
    ()->unit
  + on_stop
   Callback executed when outputting stops.
   + default
    {()}
   + type
    ()->unit
  + port
   (no doc)
   + default
    None
   + type
    int
  + start
   Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
   + default
    true
   + type
    bool
  + (unlabeled)
   Encoding format.
   + default
    None
   + type
    format('a)
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + path.concat
  Concatenate two paths, using the appropriate directory separator.
  + _category
   System
  + _type
   (string,string)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + pitch
  Compute the pitch of a sound.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?freq_max:float,?freq_min:float,
 ?length:float,source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + _flag
   hidden
  + _flag
   experimental
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + freq_max
   Maximal frequency
   + default
    10000.
   + type
    float
  + freq_min
   Minimal frequency
   + default
    40.
   + type
    float
  + length
   Length in seconds of the analysis window
   + default
    0.1
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + playlist
  Loop on a playlist of URIs.
  + _category
   Source / Input
  + _type
   (?id:string,?conservative:bool,?default_duration:float,
 ?length:float,?mime_type:string,?mode:string,
 ?prefix:string,?reload:int,?reload_mode:string,
 ?timeout:float,string)->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + conservative
   If true, estimated remaining time on the current track is not considered when computing queue length.
   + default
    false
   + type
    bool
  + default_duration
   When unknown, assume this duration (in sec.) for files.
   + default
    30.
   + type
    float
  + length
   How much audio (in sec.) should be queued in advance.
   + default
    10.
   + type
    float
  + mime_type
   Default MIME type for the playlist. Empty string means automatic detection.
   + default
    ""
   + type
    string
  + mode
   Play the files in the playlist either in the order ("normal" mode), or shuffle the playlist each time it is loaded, and play it in this order for a whole round ("randomize" mode), or pick a random file in the playlist each time ("random" mode).
   + default
    "randomize"
   + type
    string
  + prefix
   Add a constant prefix to all requests. Useful for passing extra information using annotate, or for resolution through a particular protocol, such as replaygain.
   + default
    ""
   + type
    string
  + reload
   Amount of time (in seconds or rounds) before which the playlist is reloaded; 0 means never.
   + default
    0
   + type
    int
  + reload_mode
   Unit of the reload parameter, either 'rounds' or 'seconds'.
   + default
    "seconds"
   + type
    string
  + timeout
   Timeout (in sec.) for a single download.
   + default
    20.
   + type
    float
  + (unlabeled)
   URI where to find the playlist.
   + default
    None
   + type
    string
 + playlist.once
  Custom playlist source written using the script language.
Will read directory or playlist, play all files and stop
  + _category
   Source / Input
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + random
   Randomize playlist content
   + default
    false
   + type
    bool
  + on_done
   Function to execute when the playlist is finished
   + default
    {()}
   + type
    ()->unit
  + (unlabeled)
   Playlist URI
   + default
    None
   + type
    string
  + _type
   (?id:string,?random:bool,?on_done:(()->unit),string)->
source('a)
 + playlist.parse
  Try to parse a local playlist. Return a list of (metadata,URI) items, where metadata is a list of (key,value) bindings.
  + _category
   Liquidsoap
  + _type
   (string)->[([(string*string)]*string)]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + playlist.reloadable
  Custom playlist source written using the script language.
Will read directory or playlist, play all files and stop.
Returns a pair @(reload,source)@ where @reload@ is a function of type @(?uri:string)->unit@ used to reload the source and @source@ is the actual source. The reload function can optionally be called with a new playlist URI. Otherwise, it reloads the previous URI.
  + _category
   Source / Input
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + random
   Randomize playlist content
   + default
    false
   + type
    bool
  + on_done
   Function to execute when the playlist is finished
   + default
    {()}
   + type
    ()->unit
  + (unlabeled)
   Playlist URI
   + default
    None
   + type
    string
  + _type
   (?id:string,?random:bool,?on_done:(()->unit),string)->
(((?uri:string)->unit)*source('a))
 + playlist.safe
  Loop on a playlist of local files, and never fail. In order to do so, it has to check every file at the loading, so the streamer startup may take a few seconds. To avoid this, use a standard playlist, and put only a few local files in a default safe_playlist in order to ensure the liveness of the streamer.
  + _category
   Source / Input
  + _type
   (?id:string,?mime_type:string,?mode:string,
 ?prefix:string,?reload:int,?reload_mode:string,string)->
source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + mime_type
   Default MIME type for the playlist. Empty string means automatic detection.
   + default
    ""
   + type
    string
  + mode
   Play the files in the playlist either in the order ("normal" mode), or shuffle the playlist each time it is loaded, and play it in this order for a whole round ("randomize" mode), or pick a random file in the playlist each time ("random" mode).
   + default
    "randomize"
   + type
    string
  + prefix
   Add a constant prefix to all requests. Useful for passing extra information using annotate, or for resolution through a particular protocol, such as replaygain.
   + default
    ""
   + type
    string
  + reload
   Amount of time (in seconds or rounds) before which the playlist is reloaded; 0 means never.
   + default
    0
   + type
    int
  + reload_mode
   Unit of the reload parameter, either 'rounds' or 'seconds'.
   + default
    "seconds"
   + type
    string
  + (unlabeled)
   URI where to find the playlist.
   + default
    None
   + type
    string
 + pow
  Exponentiation of numbers.
  + _category
   Math
  + _type
   ('a,'a)->'a where 'a is a number type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is a number type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is a number type
 + prepend
  Prepend an extra track before every track. Set the metadata 'liq_prepend' to 'false' to inhibit prepending on one track.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?merge:bool,
 source(audio='#a,video='#b,midi='#c),
 (([(string*string)])->
  source(audio='#a,video='#b,midi='#c)))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + merge
   Merge the track with its appended track.
   + default
    false
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
  + (unlabeled)
   Given the metadata, build the source producing the track to prepend. This source is allowed to fail (produce nothing) if no relevant track is to be appended. However, success must be immediate or it will not be taken into account.
   + default
    None
   + type
    ([(string*string)])->source(audio='#a,video='#b,midi='#c)
 + print
  Print on standard output.
  + _category
   Interaction
  + _type
   (?newline:bool,'a)->unit
  + newline
   If true, a newline is added after displaying the value.
   + default
    true
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    'a
 + quote
  Escape shell metacharacters.
  + _category
   String
  + _type
   (string)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + random
  At the beginning of every track, select a random ready child.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?replay_metadata:bool,?track_sensitive:bool,
 ?transitions:[(source('a),source('a))->source('a)],
 ?weights:[int],[source('a)])->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + replay_metadata
   Replay the last metadata of a child when switching to it in the middle of a track.
   + default
    true
   + type
    bool
  + track_sensitive
   Re-select only on end of tracks.
   + default
    true
   + type
    bool
  + transitions
   Transition functions, padded with <code>fun (x,y) -> y</code> functions.
   + default
    []
   + type
    [(source('a),source('a))->source('a)]
  + weights
   Weights of the children (padded with 1), defining for each child the probability that it is selected.
   + default
    []
   + type
    [int]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    [source('a)]
 + random.bool
  Generate a random value.
  + _category
   Bool
  + _type
   ()->bool
 + random.float
  Generate a random value.
  + _category
   Math
  + _type
   (?min:float,?max:float)->float
  + min
   (no doc)
   + default
    -1000000.
   + type
    float
  + max
   (no doc)
   + default
    1000000.
   + type
    float
 + read
  Read some value from standard input (console).
  + _category
   System
  + hide
   Hide typed characters (for passwords).
   + default
    false
   + type
    bool
  + _type
   (?hide:bool)->string
 + register_flow
  Register a radio on Liquidsoap Flows.
  + _category
   Liquidsoap
  + server
   (no doc)
   + default
    ""
   + type
    string
  + user
   (no doc)
   + default
    "default"
   + type
    string
  + password
   (no doc)
   + default
    "default"
   + type
    string
  + email
   (no doc)
   + default
    ""
   + type
    string
  + radio
   Name of the radio.
   + default
    None
   + type
    string
  + website
   URL of the website of the radio.
   + default
    None
   + type
    string
  + description
   Description of the radio.
   + default
    None
   + type
    string
  + genre
   Genre of the radio (rock or rap or etc.).
   + default
    None
   + type
    string
  + streams
   List of streams for the radio described by a pair of strings consisting of the format of the stream and the url of the stream. The format should be of the form "ogg/128k" consisting of the codec and the bitrate, separated by "/".
   + default
    None
   + type
    [(string*string)]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
  + _type
   (?server:string,?user:string,?password:string,
 ?email:string,radio:string,website:string,
 description:string,genre:string,
 streams:[(string*string)],source('a))->source('a)
 + reopen.stderr
  Reopen standard error on the given file
  + _category
   System
  + _type
   (string)->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + reopen.stdin
  Reopen standard input on the given file
  + _category
   System
  + _type
   (string)->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + reopen.stdout
  Reopen standard output on the given file
  + _category
   System
  + _type
   (string)->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + replaygain_protocol
  Register the replaygain protocol.
  + _category
   Liquidsoap
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    'a
  + _type
   (string,'a)->[string]
 + request.create
  Create a request. Creation may fail if there is no available RID, which cannot be detected currently: in that case one will obtain a request that will fail to be resolved.
  + _category
   Liquidsoap
  + _type
   (?indicators:[string],?persistent:bool,string)->
request('a)
  + indicators
   (no doc)
   + default
    []
   + type
    [string]
  + persistent
   (no doc)
   + default
    false
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + request.create.raw
  Create a raw request, i.e. for files that should not be decoded for streaming. Creation may fail if there is no available RID, which cannot be detected currently: in that case one will obtain a request that will fail to be resolved.
  + _category
   Liquidsoap
  + _type
   (?indicators:[string],?persistent:bool,string)->
request(audio=0,video=0,midi=0)
  + indicators
   (no doc)
   + default
    []
   + type
    [string]
  + persistent
   (no doc)
   + default
    false
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + request.destroy
  Destroying a request causes any temporary associated file to be deleted, and releases its RID. Persistent requests resist to destroying, unless forced.
  + _category
   Liquidsoap
  + _type
   (?force:bool,request('a))->unit
  + force
   Destroy the request even if it is persistent.
   + default
    false
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    request('a)
 + request.dynamic
  Play request dynamically created by a given function.
  + _category
   Source / Input
  + _type
   (?id:string,?conservative:bool,?default_duration:float,
 ?length:float,?timeout:float,(()->request('a)))->
source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + conservative
   If true, estimated remaining time on the current track is not considered when computing queue length.
   + default
    false
   + type
    bool
  + default_duration
   When unknown, assume this duration (in sec.) for files.
   + default
    30.
   + type
    float
  + length
   How much audio (in sec.) should be queued in advance.
   + default
    10.
   + type
    float
  + timeout
   Timeout (in sec.) for a single download.
   + default
    20.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ()->request('a)
 + request.equeue
  Receive URIs from users, and play them. Insertion and deletion possible at any position.
  + _category
   Source / Input
  + _type
   (?id:string,?conservative:bool,?default_duration:float,
 ?length:float,?timeout:float)->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + conservative
   If true, estimated remaining time on the current track is not considered when computing queue length.
   + default
    false
   + type
    bool
  + default_duration
   When unknown, assume this duration (in sec.) for files.
   + default
    30.
   + type
    float
  + length
   How much audio (in sec.) should be queued in advance.
   + default
    10.
   + type
    float
  + timeout
   Timeout (in sec.) for a single download.
   + default
    20.
   + type
    float
 + request.filename
  Return a valid local filename if the request is ready, and the empty string otherwise.
  + _category
   Liquidsoap
  + _type
   (request('a))->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    request('a)
 + request.metadata
  Get the metadata associated to a request.
  + _category
   Liquidsoap
  + _type
   (request('a))->[(string*string)]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    request('a)
 + request.queue
  Receive URIs from users, and play them.
  + _category
   Source / Input
  + _type
   (?id:string,?conservative:bool,?default_duration:float,
 ?interactive:bool,?length:float,?queue:[request('a)],
 ?timeout:float)->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + conservative
   If true, estimated remaining time on the current track is not considered when computing queue length.
   + default
    false
   + type
    bool
  + default_duration
   When unknown, assume this duration (in sec.) for files.
   + default
    30.
   + type
    float
  + interactive
   Should the queue be controllable via telnet?
   + default
    true
   + type
    bool
  + length
   How much audio (in sec.) should be queued in advance.
   + default
    10.
   + type
    float
  + queue
   Initial queue of requests.
   + default
    []
   + type
    [request('a)]
  + timeout
   Timeout (in sec.) for a single download.
   + default
    20.
   + type
    float
 + request.ready
  Check if a request is ready, i.e. is associated to a valid local file. Unless the initial URI was such a file, a request has to be resolved before being ready.
  + _category
   Liquidsoap
  + _type
   (request('a))->bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    request('a)
 + request.resolve
  Resolve a request, i.e. attempt to get a valid local file. The operation can take some time. Return true if the resolving was successful, false otherwise (timeout or invalid URI).
  + _category
   Liquidsoap
  + _type
   (?timeout:float,request('a))->bool
  + timeout
   Limit in seconds to the duration of the resolving.
   + default
    30.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    request('a)
 + rewrite_metadata
  Rewrite metadata on the fly using a list of (target,rules).
  + _category
   Source / Track Processing
  + (unlabeled)
   List of (target,value) rewriting rules.
   + default
    None
   + type
    [(string*string)]
  + insert_missing
   Treat track beginnings without metadata as having empty ones. The operational order is: create empty if needed, map and strip if enabled.
   + default
    true
   + type
    bool
  + update
   Only update metadata. If false, only returned values will be set as metadata.
   + default
    true
   + type
    bool
  + strip
   Completly remove empty metadata. Operates on both empty values and empty metadata chunk.
   + default
    false
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
  + _type
   ([(string*string)],?insert_missing:bool,?update:bool,
 ?strip:bool,source('a))->source('a)
 + rms
  Get current audio RMS volume of the source. Returns a pair @(f,s)@ where s is a new source and @f@ is a function of type @() -> float@ and returns the current RMS of the source.
  + _category
   Source / Visualization
  + _type
   (?id:string,source(audio='#a+1,video='#b,midi='#c))->
((()->float)*source(audio='#a+1,video='#b,midi='#c))
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a+1,video='#b,midi='#c)
 + rotate
  Rotate between the sources.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?replay_metadata:bool,?track_sensitive:bool,
 ?transitions:[(source('a),source('a))->source('a)],
 ?weights:[int],[source('a)])->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + replay_metadata
   Replay the last metadata of a child when switching to it in the middle of a track.
   + default
    true
   + type
    bool
  + track_sensitive
   Re-select only on end of tracks.
   + default
    true
   + type
    bool
  + transitions
   Transition functions, padded with <code>fun (x,y) -> y</code> functions.
   + default
    []
   + type
    [(source('a),source('a))->source('a)]
  + weights
   Weights of the children (padded with 1), defining for each child how many tracks are played from it per round, if that many are actually available.
   + default
    []
   + type
    [int]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    [source('a)]
 + saw
  Generate a saw wave.
  + _category
   Source / Input
  + _type
   (?id:string,?amplitude:float,?duration:float,?float)->
source(audio='#a+1,video=0,midi=0)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + amplitude
   Maximal value of the waveform.
   + default
    1.
   + type
    float
  + duration
   Duration in seconds (0. means infinite).
   + default
    0.
   + type
    float
  + (unlabeled)
   Frequency of the saw.
   + default
    440.
   + type
    float
 + say_metadata
  Append speech-synthesized tracks reading the metadata.
  + _category
   Source / Track Processing
  + (unlabeled)
   The source to use
   + default
    None
   + type
    source(?A)
  + pattern
   Pattern to use
   + default
    "say:$(if $(artist),\"It was $(artist)$(if $(title),\\\", $(title)\\\").\")"
   + type
    string
  + _type
   (source(?A),?pattern:string)->source(?A)
 + sequence
  Play only one track of every successive source, except for the last one which is played as much as available.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?merge:bool,[source('a)])->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + merge
   (no doc)
   + default
    false
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    [source('a)]
 + server.execute
  Execute a liquidsoap server command.
  + _category
   Liquidsoap
  + _type
   (string,?string)->[string]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    ""
   + type
    string
 + server.insert_metadata
  Register a server/telnet command to update a source's metadata. Returns a new source, which will receive the updated metadata. The command has the following format: insert key1="val1",key2="val2",...
  + _category
   Source / Track Processing
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
  + _type
   (?id:string,source('a))->source('a)
 + server.register
  Register a command. You can then execute this function through the server, either telnet or socket.
  + _category
   System
  + _type
   (?namespace:string,?description:string,?usage:string,
 string,((string)->string))->unit
  + namespace
   (no doc)
   + default
    ""
   + type
    string
  + description
   A description of your command.
   + default
    "No documentation available."
   + type
    string
  + usage
   (no doc)
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    (string)->string
 + server.rms
  Register a command that outputs the RMS of the returned source.
  + _category
   Source / Visualization
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a+1,video='#b,midi='#c)
  + _type
   (?id:string,source(audio='#a+1,video='#b,midi='#c))->
source(audio='#a+1,video='#b,midi='#c)
 + set
  Change some setting. Use <code>liquidsoap --conf-descr</code> and <code>liquidsoap --conf-descr-key KEY</code> on the command-line to get some information about available settings.
  + _category
   Liquidsoap
  + _type
   (string,'a)->unit
where 'a is bool, int, float, string or [string]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is bool, int, float, string or [string]
 + setenv
  Set the value associated to a variable in the process environment.
  + _category
   System
  + _type
   (string,string)->unit
  + (unlabeled)
   Variable to be set.
   + default
    None
   + type
    string
  + (unlabeled)
   Value to set.
   + default
    None
   + type
    string
 + shutdown
  Shutdown the application.
  + _category
   System
  + _type
   ()->unit
 + sine
  Generate a sine wave.
  + _category
   Source / Input
  + _type
   (?id:string,?amplitude:float,?duration:float,?float)->
source(audio='#a+1,video=0,midi=0)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + amplitude
   Maximal value of the waveform.
   + default
    1.
   + type
    float
  + duration
   Duration in seconds (0. means infinite).
   + default
    0.
   + type
    float
  + (unlabeled)
   Frequency of the sine.
   + default
    440.
   + type
    float
 + single
  Loop on a request. It never fails if the request is static, meaning that it can be fetched once. Typically, http, ftp, say requests are static, and time is not.
  + _category
   Source / Input
  + _type
   (?id:string,?conservative:bool,?default_duration:float,
 ?length:float,?timeout:float,string)->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + conservative
   If true, estimated remaining time on the current track is not considered when computing queue length.
   + default
    false
   + type
    bool
  + default_duration
   When unknown, assume this duration (in sec.) for files.
   + default
    30.
   + type
    float
  + length
   How much audio (in sec.) should be queued in advance.
   + default
    10.
   + type
    float
  + timeout
   Timeout (in sec.) for a single download.
   + default
    20.
   + type
    float
  + (unlabeled)
   URI where to find the file
   + default
    None
   + type
    string
 + skip_blank
  Skip track when detecting a blank.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?length:float,?threshold:float,
 ?track_sensitive:bool,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + length
   Maximum silence length allowed, in seconds.
   + default
    20.
   + type
    float
  + threshold
   Power in decibels under which the stream is considered silent.
   + default
    -40.
   + type
    float
  + track_sensitive
   Reset blank counter at each track.
   + default
    true
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + sky
  Multiband-compression.
  + _category
   Source / Sound Processing
  + (unlabeled)
   The input source.
   + default
    None
   + type
    source(audio='#a,video='#b,midi=0)
  + _type
   (source(audio='#a,video='#b,midi=0))->
source(audio='#a,video='#b,midi=0)
 + smart_cross
  Cross operator, allowing the composition of the N last seconds of a track with the beginning of the next track, using a transition function depending on the relative power of the signal before and after the end of track.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?active:bool,?conservative:bool,
 ?duration:float,?inhibit:float,?minimum:float,
 ?width:float,
 ((float,float,[(string*string)],[(string*string)],
   source(audio='#a+1,video=0,midi=0),
   source(audio='#a+1,video=0,midi=0))->
  source(audio='#a+1,video=0,midi=0)),
 source(audio='#a+1,video=0,midi=0))->
source(audio='#a+1,video=0,midi=0)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + active
   The active behavior is to keep ticking the child's clock when the operator is not streaming. Otherwise the child's clock is strictly based on what is streamed off the child source, which results in time-dependent active sources to be frozen when that source is stopped.
   + default
    false
   + type
    bool
  + conservative
   Do not trust remaining time estimations, always buffering data in advance. This avoids being tricked by skips, either manual or caused by skip_blank().
   + default
    false
   + type
    bool
  + duration
   Duration in seconds of the crossed end of track.
   + default
    5.
   + type
    float
  + inhibit
   Minimum delay between two transitions. It is useful in order to avoid that a transition is triggered on top of another when an end-of-track occurs in the first one. Negative values mean <code>duration+1</code>. Warning: zero inhibition can cause infinite loops.
   + default
    -1.
   + type
    float
  + minimum
   Minimum duration (in sec.) for a cross: If the track ends without any warning (e.g. in case of skip) there may not be enough data for a decent composition. Set to 0. to avoid having transitions after skips, or more to avoid transitions on short tracks. With the negative default, transitions always occur.
   + default
    -1.
   + type
    float
  + width
   Width of the power computation window.
   + default
    1.
   + type
    float
  + (unlabeled)
   Transition function, composing from the end of a track and the next track. It also takes the power of the signal before and after the transition, and the metadata.
   + default
    None
   + type
    (float,float,[(string*string)],[(string*string)],
 source(audio='#a+1,video=0,midi=0),
 source(audio='#a+1,video=0,midi=0))->
source(audio='#a+1,video=0,midi=0)
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a+1,video=0,midi=0)
 + smart_crossfade
  Crossfade between tracks, taking the respective volume levels into account in the choice of the transition.
  + _category
   Source / Track Processing
  + start_next
   Crossing duration, if any.
   + default
    5.
   + type
    float
  + fade_in
   Fade-in duration, if any.
   + default
    3.
   + type
    float
  + fade_out
   Fade-out duration, if any.
   + default
    3.
   + type
    float
  + default
   Transition used when no rule applies (default: sequence).
   + default
    <fun>
   + type
    (source(audio='#a+1,video=0,midi=0),
 source(audio='#a+1,video=0,midi=0))->
source(audio='#a+1,video=0,midi=0)
  + high
   Value, in dB, for loud sound level.
   + default
    -15.
   + type
    float
  + medium
   Value, in dB, for medium sound level.
   + default
    -32.
   + type
    float
  + margin
   Margin to detect sources that have too different sound level for crossing.
   + default
    4.
   + type
    float
  + width
   Width of the volume analysis window.
   + default
    2.
   + type
    float
  + conservative
   Always prepare for a premature end-of-track.
   + default
    true
   + type
    bool
  + (unlabeled)
   The input source.
   + default
    None
   + type
    source(audio='#a+1,video=0,midi=0)
  + _type
   (?start_next:float,?fade_in:float,?fade_out:float,
 ?default:((source(audio='#a+1,video=0,midi=0),
            source(audio='#a+1,video=0,midi=0))->
           source(audio='#a+1,video=0,midi=0)),
 ?high:float,?medium:float,?margin:float,?width:float,
 ?conservative:bool,source(audio='#a+1,video=0,midi=0))->
source(audio='#a+1,video=0,midi=0)
 + smooth_add
  Mixes two streams, with faded transitions between the state when only the normal stream is available and when the special stream gets added on top of it.
  + _category
   Source / Track Processing
  + delay
   Delay before starting the special source.
   + default
    0.5
   + type
    float
  + p
   Portion of amplitude of the normal source in the mix.
   + default
    0.2
   + type
    float
  + normal
   The normal source, which could be called the carrier too.
   + default
    None
   + type
    source(audio='#a,video='#b,midi=0)
  + special
   The special source.
   + default
    None
   + type
    source(audio='#a,video='#b,midi=0)
  + _type
   (?delay:float,?p:float,
 normal:source(audio='#a,video='#b,midi=0),
 special:source(audio='#a,video='#b,midi=0))->
source(audio='#a,video='#b,midi=0)
 + snd
  Get the second component of a pair.
  + _category
   Pair
  + _type
   (('a*'b))->'b
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ('a*'b)
 + source.dynamic
  Dynamically change the underlying source.
  + _category
   Source / Track Processing
  + _type
   (?id:string,(()->[source('a)]))->source('a)
  + _flag
   experimental
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    ()->[source('a)]
 + source.fallible
  Indicate if a source may fail, i.e. may not be ready to stream.
  + _category
   Liquidsoap
  + _type
   (source('a))->bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + source.id
  Get one source's identifier.
  + _category
   Liquidsoap
  + _type
   (source('a))->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + source.init
  Simultaneously initialize sources, return the sublist of sources that failed to initialized.
  + _category
   Liquidsoap
  + _type
   ([source(audio=*,video=*,midi=*)])->
[source(audio=*,video=*,midi=*)]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    [source(audio=*,video=*,midi=*)]
 + source.is_ready
  Indicate if a source is ready to stream, or currently streaming.
  + _category
   Liquidsoap
  + _type
   (source('a))->bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + source.remaining
  Estimation of remaining time in the current track.
  + _category
   Liquidsoap
  + _type
   (source('a))->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + source.seek
  Seek forward, in seconds. Returns the amount of time effectively seeked.
  + _category
   Liquidsoap
  + _type
   (source('a),float)->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    float
 + source.shutdown
  Desactivate a source.
  + _category
   Liquidsoap
  + _type
   (source('a))->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + source.skip
  Skip to the next track.
  + _category
   Liquidsoap
  + _type
   (source('a))->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + square
  Generate a square wave.
  + _category
   Source / Input
  + _type
   (?id:string,?amplitude:float,?duration:float,?float)->
source(audio='#a+1,video=0,midi=0)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + amplitude
   Maximal value of the waveform.
   + default
    1.
   + type
    float
  + duration
   Duration in seconds (0. means infinite).
   + default
    0.
   + type
    float
  + (unlabeled)
   Frequency of the square.
   + default
    440.
   + type
    float
 + stereo.ms.decode
  Decode mid+side stereo (M/S) to left+right stereo.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?width:float,source(audio=2,video=0,midi=0))->
source(audio=2,video=0,midi=0)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + width
   Width of the stereo field.
   + default
    1.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio=2,video=0,midi=0)
 + stereo.ms.encode
  Encode left+right stereo to mid+side stereo (M/S).
  + _category
   Source / Sound Processing
  + _type
   (?id:string,source(audio=2,video=0,midi=0))->
source(audio=2,video=0,midi=0)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio=2,video=0,midi=0)
 + stereo.pan
  Pan a stereo sound.
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?field:'a,?pan:'b,
 source(audio=2,video=0,midi=0))->
source(audio=2,video=0,midi=0)
where 'a, 'b is either float or ()->float
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + field
   Field width in degrees (between 0 and 90).
   + default
    90.
   + type
    anything that is either float or ()->float
  + pan
   Pan ranges between -1 and 1.
   + default
    0.
   + type
    anything that is either float or ()->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio=2,video=0,midi=0)
 + store_metadata
  Keep track of the last N metadata packets in the stream, and make the history available via a server command.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?size:int,source('a))->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + size
   Size of the history
   + default
    10
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source('a)
 + stretch
  Slow down or accelerate an audio stream by stretching (sounds lower) or squeezing it (sounds higher).
  + _category
   Source / Sound Processing
  + _type
   (?id:string,?active:bool,ratio:'a,
 source(audio='#b+1,video=0,midi=0))->
source(audio='#c+1,video=0,midi=0)
where 'a is either float or ()->float
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + active
   The active behavior is to keep ticking the child's clock when the operator is not streaming. Otherwise the child's clock is strictly based on what is streamed off the child source, which results in time-dependent active sources to be frozen when that source is stopped.
   + default
    true
   + type
    bool
  + ratio
   A value higher than 1 means slowing down.
   + default
    None
   + type
    anything that is either float or ()->float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#b+1,video=0,midi=0)
 + string.capitalize
  Return a string with the first character set to upper case (capitalize), or to lower case (uncapitalize).
  + _category
   String
  + _type
   (?capitalize:bool,?space_sensitive:bool,string)->string
  + capitalize
   Capitalize if true, uncapitalize otherwise
   + default
    true
   + type
    bool
  + space_sensitive
   Capitalize each space separated sub-string.
   + default
    true
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + string.case
  Convert a string to lower or upper case.
  + _category
   String
  + _type
   (?lower:bool,string)->string
  + lower
   Convert to lower case if true and uppercase otherwise.
   + default
    true
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + string.concat
  Concatenate strings.
  + _category
   String
  + _type
   (?separator:string,[string])->string
  + separator
   (no doc)
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    [string]
 + string.escape
  Escape special charaters in a string. String is parsed char by char. See @string.utf8.escape@ for an UTF8-aware parsing function.
  + _category
   String
  + _type
   (?special_chars:[string],?escape_char:((string)->string),
 string)->string
  + special_chars
   List of characters that should be escaped. The first character of each element in the list is considered.
   + default
    ["\127", "\\", "\"", "\000", "\001", "\002", "\003", "\004", "\005", "\006", "\007", "\b", "\t", "\n", "\011", "\012", "\r", "\014", "\015", "\016", "\017", "\018", "\019", "\020", "\021", "\022", "\023", "\024", "\025", "\026", "\027", "\028", "\029", "\030", "\031"]
   + type
    [string]
  + escape_char
   Function used to escape a character.
   + default
    <fun>
   + type
    (string)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + string.extract
  Extract substrings from a string.
Perl compatible regular expressions are recognized. Hence, special characters should be escaped.
Returns a list of (index,value).
If the list does not have a pair associated to some index, it means that the corresponding pattern was not found.
  + _category
   String
  + _type
   (pattern:string,string)->[(string*string)]
  + pattern
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + string.length
  Get the length of a string.
  + _category
   String
  + _type
   (string)->int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + string.match
  Match a string with an expression.
Perl compatible regular expressions are recognized. Hence, special characters should be escaped.
  + _category
   String
  + _type
   (pattern:string,string)->bool
  + pattern
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + string.recode
  Convert a string. Effective only if Camomile is enabled.
  + _category
   String
  + _type
   (?in_enc:string,?out_enc:string,string)->string
  + in_enc
   Input encoding. Autodetected if empty.
   + default
    ""
   + type
    string
  + out_enc
   Output encoding.
   + default
    "UTF-8"
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + string.replace
  Replace substrings in a string.
Will replace all substrings matched in the pattern by the string returned by the replace function.
  + _category
   String
  + _type
   (pattern:string,((string)->string),string)->string
  + pattern
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    (string)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + string.split
  Split a string at 'separator'.
Perl compatible regular expressions are recognized. Hence, special characters should be escaped.
  + _category
   String
  + _type
   (separator:string,string)->[string]
  + separator
   (no doc)
   + default
    None
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + string.utf8.escape
  Escape special charaters in an UTF8 string.
  + _category
   String
  + _type
   (?special_chars:[string],?escape_char:((string)->string),
 string)->string
  + special_chars
   List of characters that should be escaped. The first character of each element in the list is considered.
   + default
    ["\127", "\\", "\"", "\000", "\001", "\002", "\003", "\004", "\005", "\006", "\007", "\b", "\t", "\n", "\011", "\012", "\r", "\014", "\015", "\016", "\017", "\018", "\019", "\020", "\021", "\022", "\023", "\024", "\025", "\026", "\027", "\028", "\029", "\030", "\031"]
   + type
    [string]
  + escape_char
   Function used to escape a character.
   + default
    <fun>
   + type
    (string)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + string_of
  Return the representation of a value.
  + _category
   String
  + _type
   ('a)->string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    'a
 + string_of_metadata
  Standard function for displaying metadata.
Shows artist and title, using "Unknown" when a field is empty.
  + _category
   String
  + (unlabeled)
   Metadata packet to be displayed.
   + default
    None
   + type
    [(string*string)]
  + _type
   ([(string*string)])->string
 + strip_blank
  Make the source unavailable when it is streaming blank.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?length:float,?threshold:float,
 ?track_sensitive:bool,
 source(audio='#a,video='#b,midi='#c))->
source(audio='#a,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + length
   Maximum silence length allowed, in seconds.
   + default
    20.
   + type
    float
  + threshold
   Power in decibels under which the stream is considered silent.
   + default
    -40.
   + type
    float
  + track_sensitive
   Reset blank counter at each track.
   + default
    true
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b,midi='#c)
 + swap
  Swap two channels of a stereo source.
  + _category
   Source / Conversions
  + _type
   (?id:string,source(audio=2,video=0,midi=0))->
source(audio=2,video=0,midi=0)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio=2,video=0,midi=0)
 + switch
  At the beginning of a track, select the first source
              whose predicate is true.
  + _category
   Source / Track Processing
  + _type
   (?id:string,?replay_metadata:bool,?single:[bool],
 ?track_sensitive:bool,
 ?transitions:[(source('a),source('a))->source('a)],
 [((()->bool)*source('a))])->source('a)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + replay_metadata
   Replay the last metadata of a child when switching to it in the middle of a track.
   + default
    true
   + type
    bool
  + single
   Forbid the selection of a branch for two tracks in a row. The empty list stands for <code>[false,...,false]</code>.
   + default
    []
   + type
    [bool]
  + track_sensitive
   Re-select only on end of tracks.
   + default
    true
   + type
    bool
  + transitions
   Transition functions, padded with <code>fun (x,y) -> y</code> functions.
   + default
    []
   + type
    [(source('a),source('a))->source('a)]
  + (unlabeled)
   Sources with the predicate telling when they can be played.
   + default
    None
   + type
    [((()->bool)*source('a))]
 + synth.all.saw
  Saw synthesizer. It creates one synthesizer for each channel.
  + _category
   Source / Sound Synthesis
  + _type
   (?id:string,?attack:float,?decay:float,?envelope:bool,
 ?release:float,?sustain:float,
 source(audio='#a+1,video='#b,midi='#c+16))->
source(audio='#a+1,video='#b,midi='#c+16)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + attack
   Envelope attack (in seconds).
   + default
    0.02
   + type
    float
  + decay
   Envelope decay (in seconds).
   + default
    0.01
   + type
    float
  + envelope
   Use envelope.
   + default
    true
   + type
    bool
  + release
   Envelope release (in seconds).
   + default
    0.01
   + type
    float
  + sustain
   Envelope sustain level.
   + default
    0.9
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a+1,video='#b,midi='#c+16)
 + synth.all.sine
  Sine synthesizer. It creates one synthesizer for each channel.
  + _category
   Source / Sound Synthesis
  + _type
   (?id:string,?attack:float,?decay:float,?envelope:bool,
 ?release:float,?sustain:float,
 source(audio='#a+1,video='#b,midi='#c+16))->
source(audio='#a+1,video='#b,midi='#c+16)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + attack
   Envelope attack (in seconds).
   + default
    0.02
   + type
    float
  + decay
   Envelope decay (in seconds).
   + default
    0.01
   + type
    float
  + envelope
   Use envelope.
   + default
    true
   + type
    bool
  + release
   Envelope release (in seconds).
   + default
    0.01
   + type
    float
  + sustain
   Envelope sustain level.
   + default
    0.9
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a+1,video='#b,midi='#c+16)
 + synth.all.square
  Square synthesizer. It creates one synthesizer for each channel.
  + _category
   Source / Sound Synthesis
  + _type
   (?id:string,?attack:float,?decay:float,?envelope:bool,
 ?release:float,?sustain:float,
 source(audio='#a+1,video='#b,midi='#c+16))->
source(audio='#a+1,video='#b,midi='#c+16)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + attack
   Envelope attack (in seconds).
   + default
    0.02
   + type
    float
  + decay
   Envelope decay (in seconds).
   + default
    0.01
   + type
    float
  + envelope
   Use envelope.
   + default
    true
   + type
    bool
  + release
   Envelope release (in seconds).
   + default
    0.01
   + type
    float
  + sustain
   Envelope sustain level.
   + default
    0.9
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a+1,video='#b,midi='#c+16)
 + synth.saw
  Saw synthesizer.
  + _category
   Source / Sound Synthesis
  + _type
   (?id:string,?attack:float,?channel:int,?decay:float,
 ?envelope:bool,?release:float,?sustain:float,
 ?volume:float,source(audio='#a+1,video='#b,midi='#c+1))->
source(audio='#a+1,video='#b,midi='#c+1)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + attack
   Envelope attack (in seconds).
   + default
    0.02
   + type
    float
  + channel
   MIDI channel to handle.
   + default
    0
   + type
    int
  + decay
   Envelope decay (in seconds).
   + default
    0.01
   + type
    float
  + envelope
   Use envelope.
   + default
    true
   + type
    bool
  + release
   Envelope release (in seconds).
   + default
    0.05
   + type
    float
  + sustain
   Envelope sustain level.
   + default
    0.9
   + type
    float
  + volume
   Initial volume.
   + default
    0.3
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a+1,video='#b,midi='#c+1)
 + synth.sine
  Sine synthesizer.
  + _category
   Source / Sound Synthesis
  + _type
   (?id:string,?attack:float,?channel:int,?decay:float,
 ?envelope:bool,?release:float,?sustain:float,
 ?volume:float,source(audio='#a+1,video='#b,midi='#c+1))->
source(audio='#a+1,video='#b,midi='#c+1)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + attack
   Envelope attack (in seconds).
   + default
    0.02
   + type
    float
  + channel
   MIDI channel to handle.
   + default
    0
   + type
    int
  + decay
   Envelope decay (in seconds).
   + default
    0.01
   + type
    float
  + envelope
   Use envelope.
   + default
    true
   + type
    bool
  + release
   Envelope release (in seconds).
   + default
    0.05
   + type
    float
  + sustain
   Envelope sustain level.
   + default
    0.9
   + type
    float
  + volume
   Initial volume.
   + default
    0.3
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a+1,video='#b,midi='#c+1)
 + synth.square
  Square synthesizer.
  + _category
   Source / Sound Synthesis
  + _type
   (?id:string,?attack:float,?channel:int,?decay:float,
 ?envelope:bool,?release:float,?sustain:float,
 ?volume:float,source(audio='#a+1,video='#b,midi='#c+1))->
source(audio='#a+1,video='#b,midi='#c+1)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + attack
   Envelope attack (in seconds).
   + default
    0.02
   + type
    float
  + channel
   MIDI channel to handle.
   + default
    0
   + type
    int
  + decay
   Envelope decay (in seconds).
   + default
    0.01
   + type
    float
  + envelope
   Use envelope.
   + default
    true
   + type
    bool
  + release
   Envelope release (in seconds).
   + default
    0.05
   + type
    float
  + sustain
   Envelope sustain level.
   + default
    0.9
   + type
    float
  + volume
   Initial volume.
   + default
    0.3
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a+1,video='#b,midi='#c+1)
 + system
  Shell command call. Set verbose to true to log process' output and errors.
  + _category
   System
  + _type
   (string)->unit
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + test_process
  Return true if process exited with 0 code. Command should return quickly.
  + _category
   System
  + (unlabeled)
   Command to test
   + default
    None
   + type
    string
  + _type
   (string)->bool
 + time_in_mod
  INTERNAL: time_in_mod(a,b,c) checks that the unix time T satisfies a <= T mod c < b
  + _category
   Other
  + _type
   (int,int,int)->bool
  + _flag
   hidden
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    int
 + unsafe.single.infallible
  Loops on a request, which has to be ready and should be persistent. WARNING: if used uncarefully, it can crash your application!
  + _category
   Source / Input
  + _type
   (?id:string,request('a))->source('a)
  + _flag
   hidden
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    request('a)
 + url.decode
  Decode an encoded url (e.g. "%20" becomes " ").
  + _category
   String
  + _type
   (?plus:bool,string)->string
  + plus
   (no doc)
   + default
    true
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + url.encode
  Encode an url (e.g. " " becomes "%20").
  + _category
   String
  + _type
   (?plus:bool,string)->string
  + plus
   (no doc)
   + default
    true
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    string
 + url.split
  Split an url of the form foo?arg=bar&arg2=bar2 into ("foo",[("arg","bar"),("arg2","bar2")]).
  + _category
   String
  + (unlabeled)
   Url to split
   + default
    None
   + type
    string
  + _type
   (string)->(string*[(string*string)])
 + video.add_image
  Add a static image on the first video channel. The image can be changed based on metadata found at the beginning of a track.
  + _category
   Source / Video Processing
  + _type
   (?id:string,?alpha:int,?duration:float,?file:string,
 ?height:int,?metadata:string,?width:int,?x:int,?y:int,
 source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + alpha
   Color to convert to alpha (in 0xRRGGBB format, negative means no alpha).
   + default
    -1
   + type
    int
  + duration
   (no doc)
   + default
    0.
   + type
    float
  + file
   Path to image file.
   + default
    ""
   + type
    string
  + height
   Scale to width (negative means original height).
   + default
    -1
   + type
    int
  + metadata
   Metadata on which file name should be read (empty means disabled).
   + default
    ""
   + type
    string
  + width
   Scale to width (negative means original width).
   + default
    -1
   + type
    int
  + x
   x position (negative means from right).
   + default
    0
   + type
    int
  + y
   y position (negative means from bottom).
   + default
    0
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.fade.final
  Fade a stream to black.
  + _category
   Source / Video Processing
  + _type
   (?id:string,?duration:float,?transition:string,
 ?type:string,source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + duration
   Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
   + default
    3.
   + type
    float
  + transition
   Kind of transition (fade|slide_left|slide_right|slide_up|slide_down|grow|disc|random).
   + default
    "fade"
   + type
    string
  + type
   Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
   + default
    "lin"
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.fade.in
  Fade the beginning of tracks. Metadata 'liq_video_fade_in' can be used to set the duration for a specific track (float in seconds).
  + _category
   Source / Video Processing
  + _type
   (?id:string,?duration:float,?override:string,
 ?transition:string,?type:string,
 source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + duration
   Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
   + default
    3.
   + type
    float
  + override
   Metadata field which, if present and containing a float, overrides the 'duration' parameter for current track.
   + default
    "liq_video_fade_in"
   + type
    string
  + transition
   Kind of transition (fade|slide_left|slide_right|slide_up|slide_down|grow|disc|random).
   + default
    "fade"
   + type
    string
  + type
   Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
   + default
    "lin"
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.fade.initial
  Fade the beginning of a stream.
  + _category
   Source / Video Processing
  + _type
   (?id:string,?duration:float,?transition:string,
 ?type:string,source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + duration
   Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
   + default
    3.
   + type
    float
  + transition
   Kind of transition (fade|slide_left|slide_right|slide_up|slide_down|grow|disc|random).
   + default
    "fade"
   + type
    string
  + type
   Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
   + default
    "lin"
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.fade.out
  Fade the end of tracks. Metadata 'liq_video_fade_out' can be used to set the duration for a specific track (float in seconds).
  + _category
   Source / Video Processing
  + _type
   (?id:string,?duration:float,?override:string,
 ?transition:string,?type:string,
 source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + duration
   Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
   + default
    3.
   + type
    float
  + override
   Metadata field which, if present and containing a float, overrides the 'duration' parameter for current track.
   + default
    "liq_video_fade_out"
   + type
    string
  + transition
   Kind of transition (fade|slide_left|slide_right|slide_up|slide_down|grow|disc|random).
   + default
    "fade"
   + type
    string
  + type
   Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
   + default
    "lin"
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.fill
  Fill frame with a color.
  + _category
   Source / Video Processing
  + _type
   (?id:string,?color:int,
 source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + color
   Color to fill the image with.
   + default
    0
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.greyscale
  Convert video to greyscale.
  + _category
   Source / Video Processing
  + _type
   (?id:string,source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.invert
  Invert video.
  + _category
   Source / Video Processing
  + _type
   (?id:string,source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.lomo
  Emulate the "Lomo effect".
  + _category
   Source / Video Processing
  + _type
   (?id:string,source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.opacity
  Scale opacity of video.
  + _category
   Source / Video Processing
  + _type
   (?id:string,float,source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   Coefficient to scale opacity with.
   + default
    None
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.opacity.blur
  Blur opacity of video.
  + _category
   Source / Video Processing
  + _type
   (?id:string,source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.rotate
  Rotate video.
  + _category
   Source / Video Processing
  + _type
   (?id:string,?angle:float,?speed:float,
 source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + angle
   Initial angle in radians.
   + default
    0.
   + type
    float
  + speed
   Rotation speed in radians per sec.
   + default
    3.1416
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.scale
  Scale and translate video.
  + _category
   Source / Video Processing
  + _type
   (?id:string,?coef:float,?coef_x:float,?coef_y:float,
 ?offset_x:int,?offset_y:int,
 source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + coef
   Scaling coefficient in both directions.
   + default
    1.
   + type
    float
  + coef_x
   x scaling
   + default
    1.
   + type
    float
  + coef_y
   y scaling
   + default
    1.
   + type
    float
  + offset_x
   x offset
   + default
    1
   + type
    int
  + offset_y
   y offset
   + default
    1
   + type
    int
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.sepia
  Convert video to sepia.
  + _category
   Source / Video Processing
  + _type
   (?id:string,source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.tile
  Tile sources (same as add but produces tiles of videos).
  + _category
   Source / Video Processing
  + _type
   (?id:string,?normalize:bool,?proportional:bool,
 ?weights:[int],[source(audio='#a,video='#b+1,midi='#c)])->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + normalize
   (no doc)
   + default
    true
   + type
    bool
  + proportional
   Scale preserving the proportions.
   + default
    true
   + type
    bool
  + weights
   Relative weight of the sources in the sum. The empty list stands for the homogeneous distribution.
   + default
    []
   + type
    [int]
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    [source(audio='#a,video='#b+1,midi='#c)]
 + video.transparent
  Set a color to be transparent.
  + _category
   Source / Video Processing
  + _type
   (?id:string,?color:int,?precision:float,
 source(audio='#a,video='#b+1,midi='#c))->
source(audio='#a,video='#b+1,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + color
   Color which should be transparent (in 0xRRGGBB format).
   + default
    0
   + type
    int
  + precision
   Precision in color matching (0. means match precisely the color and 1. means match every color).
   + default
    0.
   + type
    float
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a,video='#b+1,midi='#c)
 + video.volume
  Graphical visualization of the sound.
  + _category
   Source / Visualization
  + _type
   (?id:string,source(audio='#a+1,video=0,midi=0))->
source(audio='#a+1,video=1,midi=0)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a+1,video=0,midi=0)
 + vumeter
  VU meter (display the audio volume).
  + _category
   Source / Visualization
  + _type
   (?id:string,?scroll:bool,
 source(audio='#a+1,video='#b,midi='#c))->
source(audio='#a+1,video='#b,midi='#c)
  + id
   Force the value of the source ID.
   + default
    ""
   + type
    string
  + scroll
   Scroll.
   + default
    false
   + type
    bool
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    source(audio='#a+1,video='#b,midi='#c)
 + ~-
  Returns the opposite of its argument.
  + _category
   Math
  + _type
   ('a)->'a where 'a is a number type
  + (unlabeled)
   (no doc)
   + default
    None
   + type
    anything that is a number type
+ stream decoding
 Stream decoding methods.
 + PCM/BASIC
  Decode audio/basic as headerless stereo U8 PCM at 8kHz.
 + WAV
  Decode a WAV stream with an appropriate MIME type.
+ stream encoding formats
 Methods to encode streams.
 + EXTERNAL
  (no doc)
 + WAV
  (no doc)
+ video converters
 Methods for converting video frames.
 + native
  (no doc)