Liquidsoap scripting language reference

The Source / … categories contain all functions that return sources. The Input functions are those which build elementary sources (playing files, synthesizing sound, etc.). The Output functions are those which take a source and register it for being streamed to the outside (file, soundcard, audio server, etc.). The Visualization functions are experimental ones that let you visualize in real-time some aspects of the audio stream. The Sound Processing functions are those which basically work on the source as a continuous audio stream. They would typically be mixers of streams, audio effects or analysis. Finally, Track Processing functions are basically all others, often having a behaviour that depends on or affects the extra information that liquidsoap puts in streams: track limits and metadata.

• Source / Conversions
• Source / Input
• Source / Liquidsoap
• Source / MIDI Processing
• Source / Output
• Source / Sound Processing
• Source / Sound Synthesis
• Source / Track Processing
• Source / Video Processing
• Source / Visualization
• FFmpeg Filter
• Bool
• Control
• Interaction
• Liquidsoap
• List
• Math
• Pair
• String
• System

Bool

!=

Comparison of comparable values.

Type:

('a, 'a) -> bool where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type)
• (unlabeled) (of type anything that is an orderable type)

<

Comparison of comparable values.

Type:

('a, 'a) -> bool where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type)
• (unlabeled) (of type anything that is an orderable type)

<=

Comparison of comparable values.

Type:

('a, 'a) -> bool where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type)
• (unlabeled) (of type anything that is an orderable type)

==

Comparison of comparable values.

Type:

('a, 'a) -> bool where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type)
• (unlabeled) (of type anything that is an orderable type)

>

Comparison of comparable values.

Type:

('a, 'a) -> bool where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type)
• (unlabeled) (of type anything that is an orderable type)

>=

Comparison of comparable values.

Type:

('a, 'a) -> bool where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type)
• (unlabeled) (of type anything that is an orderable type)

and

Return the conjunction of its arguments

Type:

({bool}, {bool}) -> bool

Arguments:

• (unlabeled) (of type {bool})
• (unlabeled) (of type {bool})

not

Returns the negation of its argument.

Type:

(bool) -> bool

Arguments:

• (unlabeled) (of type bool)

or

Return the disjunction of its arguments

Type:

({bool}, {bool}) -> bool

Arguments:

• (unlabeled) (of type {bool})
• (unlabeled) (of type {bool})

random.bool

Generate a random boolean.

Type:

() -> bool

Arguments:

Control

ignore

Convert anything to unit, preventing warnings.

Type:

('a) -> unit

Arguments:

• (unlabeled) (of type 'a)

thread.run

Run a function in a separate thread.

Type:

(?fast : bool, ?delay : float, ?every : {float}?,
 (() -> unit)) -> unit

Arguments:

• fast (of type bool, which defaults to true): Whether the thread is supposed to return quickly or not. Typically, blocking tasks (e.g. fetching data over the internet) should not be considered to be fast. When set to false its priority will be lowered 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.
• delay (of type float, which defaults to 0.): Delay (in seconds) after which the thread should be launched.
• every (of type {float}?, which defaults to null): How often (in seconds) the thread should be run. If negative or null, run once.
• (unlabeled) (of type () -> unit): Function to execute.

File

file.digest

Return an MD5 digest for the given file.

Type:

(string) -> string

Arguments:

• (unlabeled) (of type string)

file.exists

Returns true if the file or directory exists.

Type:

(string) -> bool

Arguments:

• (unlabeled) (of type string)

file.extension

Returns a file’s extension.

Type:

(?dir_sep : string, ?leading_dot : bool, string) ->
string

Arguments:

• dir_sep (of type string, which defaults to "/"): Directory separator.
• leading_dot (of type bool, which defaults to true): Return extension with a leading dot, e.g. .foo.
• (unlabeled) (of type string)

file.is_directory

Returns true if the file exists and is a directory.

Type:

(string) -> bool

Arguments:

• (unlabeled) (of type string)

file.ls

List all the files in a directory.

Type:

(?absolute : bool, ?recursive : bool, ?pattern : string?,
 string) -> [string]

Arguments:

• absolute (of type bool, which defaults to false): Whether to return absolute paths.
• recursive (of type bool, which defaults to false): Whether to look recursively in subdirectories.
• pattern (of type string?, which defaults to null): Pattern that the filenames should match (e.g. "*.mp3").
• (unlabeled) (of type string): Directory to look in.

file.metadata

Read metadata from a file.

Type:

(string) -> [string * string]

Arguments:

• (unlabeled) (of type string): File from which the metadata should be read.

file.metadata.ffmpeg

Read metadata from a file using the ffmpeg decoder.

Type:

(string) -> [string * string]

Arguments:

• (unlabeled) (of type string): File from which the metadata should be read.

file.metadata.flac

Read metadata from a file using the flac decoder.

Type:

(string) -> [string * string]

Arguments:

• (unlabeled) (of type string): File from which the metadata should be read.

file.metadata.gstreamer

Read metadata from a file using the gstreamer decoder.

Type:

(string) -> [string * string]

Arguments:

• (unlabeled) (of type string): File from which the metadata should be read.

file.metadata.id3v2

Read metadata from a file using the id3v2 decoder.

Type:

(string) -> [string * string]

Arguments:

• (unlabeled) (of type string): File from which the metadata should be read.

file.metadata.mp4

Read metadata from a file using the mp4 decoder.

Type:

(string) -> [string * string]

Arguments:

• (unlabeled) (of type string): File from which the metadata should be read.

file.metadata.ogg

Read metadata from a file using the ogg decoder.

Type:

(string) -> [string * string]

Arguments:

• (unlabeled) (of type string): File from which the metadata should be read.

file.metadata.taglib

Read metadata from a file using the taglib decoder.

Type:

(string) -> [string * string]

Arguments:

• (unlabeled) (of type string): File from which the metadata should be read.

file.mime

Get the MIME type of a file, according to libmagic.

Type:

(string) -> string

Arguments:

• (unlabeled) (of type string)

file.mkdir

Create a directory.

Type:

(?perms : int, string) -> unit

Arguments:

• perms (of type int, which defaults to 493): Default file rights if created (default is 0o755).
• (unlabeled) (of type string)

file.read

Read the content of a file. Returns a function of type ()->string. File is done reading when function returns the empty string "".

Type:

(string) -> () -> string

Arguments:

• (unlabeled) (of type string)

file.remove

Remove a file.

Type:

(string) -> unit

Arguments:

• (unlabeled) (of type string)

file.rmdir

Remove a directory and its content.

Type:

(string) -> unit

Arguments:

• (unlabeled) (of type string)

file.size

File size in bytes.

Type:

(string) -> int

Arguments:

• (unlabeled) (of type string)

file.temp

Return a fresh temporary filename. The temporary file is created empty, with permissions 0o600 (readable and writable only by the file owner).

Type:

(string, string) -> string

Arguments:

• (unlabeled) (of type string): File prefix
• (unlabeled) (of type string): File suffix

file.temp_dir

Return a fresh temporary directory name. The temporary directory is created empty, with permissions 0o700 (readable, writable and listable only by the file owner).

Type:

(string, string) -> string

Arguments:

• (unlabeled) (of type string): Directory prefix
• (unlabeled) (of type string): Directory suffix

file.watch

Call a function when a file is modified. Returns unwatch function in unwatch method.

Type:

(string, (() -> unit)) -> unit

Arguments:

• (unlabeled) (of type string): File to watch.
• (unlabeled) (of type () -> unit): Handler function.

Methods:

• unwatch (of type () -> unit): Function to remove the watch on the file.

file.which

file.which("progname") looks for an executable named “progname” using directories from the PATH environment variable and returns “” if it could not find one.

Type:

(string) -> string?

Arguments:

• (unlabeled) (of type string)

file.write

Write data to a file.

Type:

(data : {string?}, ?append : bool, ?perms : int, string) ->
unit

Arguments:

• data (of type {string?}): Data to write. If passing a callback () -> string?, the callback must return null when it has finished sending all its data.
• append (of type bool, which defaults to false): Append data if file exists.
• perms (of type int, which defaults to 420): Default file rights if created
• (unlabeled) (of type string): Path to write to

file.write.stream

Stream data to a file. Returns a callback to write to the file. Execute with null to signify the end of the writing operation.

Type:

(?append : bool, ?perms : int, string) ->
(string?) -> unit

Arguments:

• append (of type bool, which defaults to false): Append data if file exists.
• perms (of type int, which defaults to 420): Default file rights if created
• (unlabeled) (of type string): Path to write to

path.basename

Get the base name of a path.

Type:

(string) -> string

Arguments:

• (unlabeled) (of type string)

path.concat

Concatenate two paths, using the appropriate directory separator.

Type:

(string, string) -> string

Arguments:

• (unlabeled) (of type string)
• (unlabeled) (of type string)

path.dirname

Get the directory name of a path.

Type:

(string) -> string

Arguments:

• (unlabeled) (of type string)

path.home.unrelate

Expand path that start with ‘~’ with the current home directory.

Type:

(string) -> string

Arguments:

• (unlabeled) (of type string)

path.remove_extension

Remove the file extension from a path.

Type:

(string) -> string

Arguments:

• (unlabeled) (of type string)

string.apic.parse

Parse APIC ID3v2 tags (such as those obtained in the APIC tag from file.metadata.id3v2). The returned values are: mime, picture type, description, and picture data.

Type:

(string) -> string

Arguments:

• (unlabeled) (of type string): APIC data.

Methods:

• description (of type string): Description
• mime (of type string): Mime type
• picture_type (of type int): Picture type

Filter

ffmpeg.filter.audio.input

Attach an audio source to a filter’s input

Type:

(?pass_metadata : bool, ffmpeg.filter.graph,
 source(audio=ffmpeg.audio.raw('a), video=none,
 midi=none)) -> ffmpeg.filter.audio

Arguments:

• pass_metadata (of type bool, which defaults to true): Pass liquidsoap’s metadata to this stream
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type source(audio=ffmpeg.audio.raw('a), video=none, midi=none))

ffmpeg.filter.create

Configure and launch a filter graph

Type:

(((ffmpeg.filter.graph) -> 'a)) -> 'a

Arguments:

• (unlabeled) (of type (ffmpeg.filter.graph) -> 'a)

ffmpeg.filter.video.input

Attach a video source to a filter’s input

Type:

(?pass_metadata : bool, ffmpeg.filter.graph,
 source(audio=none, video=ffmpeg.video.raw('a),
 midi=none)) -> ffmpeg.filter.video

Arguments:

• pass_metadata (of type bool, which defaults to false): Pass liquidsoap’s metadata to this stream
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type source(audio=none, video=ffmpeg.video.raw('a), midi=none))

Input

input

Input an audio stream using the default operator.

Type:

(?id : string?, ?start : bool, ?on_start : (() -> unit),
 ?on_stop : (() -> unit), ?fallible : bool) ->
source(audio=pcm(?A), video=?B, midi=?C)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• start (of type bool, which defaults to true): 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.
• on_start (of type () -> unit, which defaults to <fun>): Callback executed when outputting starts.
• on_stop (of type () -> unit, which defaults to <fun>): Callback executed when outputting stops.
• fallible (of type bool, which defaults to false): Allow the child source to fail, in which case the output will be (temporarily) stopped.

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_started (of type () -> bool): true if the output or source is started.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• start (of type () -> unit): Ask the source or output to start.
• stop (of type () -> unit): Ask the source or output to stop.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

Interaction

audioscrobbler.nowplaying

Submit a now playing song using the audioscrobbler protocol.

Type:

(user : string, password : string, ?host : string,
 ?port : int, ?length : bool, [string * string]) -> unit

Arguments:

• user (of type string)
• password (of type string)
• host (of type string, which defaults to "post.audioscrobbler.com"): Host for audioscrobbling submissions.
• port (of type int, which defaults to 80): Port for audioscrobbling submissions.
• length (of type bool, which defaults to false): Try to submit length information. This operation can be CPU intensive. Value forced to true when used with the “user” source type.
• (unlabeled) (of type [string * string])

audioscrobbler.submit

Submit a played song using the audioscrobbler protocol.

Type:

(?source : string, user : string, password : string,
 ?host : string, ?port : int, ?length : bool,
 [string * string]) -> unit

Arguments:

• source (of type string, which defaults to "broadcast"): Source for tracks. Should be one of: “broadcast”, “user”, “recommendation” or “unknown”. Since liquidsoap is intended for radio broadcasting, this is the default. Sources other than user don’t need duration to be set.
• user (of type string)
• password (of type string)
• host (of type string, which defaults to "post.audioscrobbler.com"): Host for audioscrobbling submissions.
• port (of type int, which defaults to 80): Port for audioscrobbling submissions.
• length (of type bool, which defaults to false): Try to submit length information. This operation can be CPU intensive. Value forced to true when used with the “user” source type.
• (unlabeled) (of type [string * string])

compress.multiband.interactive

Create a multiband compressor whose parameters are interactive variables.

Type:

(?id : string, ?bands : int, source(audio=pcm('a),
 video=internal('b), midi=internal('c))) ->
source(audio=pcm('a), video=internal('b),
midi=internal('c))

Arguments:

• id (of type string, which defaults to "compress"): Id of the source. Variable names are prefixed with this.
• bands (of type int, which defaults to 5): Number of bands.
• (unlabeled) (of type source(audio=pcm('a), video=internal('b), midi=internal('c))): Source to compress.

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• gain (of type () -> float): Gain (dB).
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• rms (of type () -> float): RMS or peak power (linear).
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

harbor.http.static

Serve a static path.

Type:

(?port : int, ?path : string, ?browse : bool,
 ?content_type : ((string) -> string),
 ?headers : [string * string], string) -> unit

Arguments:

• port (of type int, which defaults to 8000): Port for incoming harbor (http) connections.
• path (of type string, which defaults to "/"): Base path.
• browse (of type bool, which defaults to false): List files in directories.
• content_type (of type (string) -> string, which defaults to <fun>): Callback to specify Content-Type on a per file basis. Default: file.mime if compiled or file CLI if present.
• headers (of type [string * string], which defaults to [("Access-Control-Allow-Origin", "*")]): Default response headers.
• (unlabeled) (of type string): Local path to be served.

harbor.https.static

Serve a static path.

Type:

(?port : int, ?path : string, ?browse : bool,
 ?content_type : ((string) -> string),
 ?headers : [string * string], string) -> unit

Arguments:

• port (of type int, which defaults to 8000): Port for incoming harbor (https) connections.
• path (of type string, which defaults to "/"): Base path.
• browse (of type bool, which defaults to false): List files in directories.
• content_type (of type (string) -> string, which defaults to <fun>): Callback to specify Content-Type on a per file basis. Default: file.mime if compiled or file CLI if present.
• headers (of type [string * string], which defaults to [("Access-Control-Allow-Origin", "*")]): Default response headers.
• (unlabeled) (of type string): Local path to be served.

http.delete

Perform a full Http DELETE request.

Type:

(?headers : [string * string], ?http_version : string?,
 ?redirect : bool, ?timeout : int, string) -> unit

Arguments:

• headers (of type [string * string], which defaults to []): Additional headers.
• http_version (of type string?, which defaults to null): Http request version.
• redirect (of type bool, which defaults to true): Perform redirections if needed.
• timeout (of type int, which defaults to 10): Timeout for network operations (in seconds).
• (unlabeled) (of type string): Requested URL, e.g. “http://www.google.com/”.

Methods:

• headers (of type [string * string]): HTTP headers.
• protocol_version (of type string): Version of the HTTP protocol.
• status_code (of type int): Status code.
• status_message (of type string): Status message.

http.delete.stream

Perform a full Http DELETE request.

Type:

(?headers : [string * string], ?http_version : string?,
 ?redirect : bool, ?timeout : int, string,
 on_body_data : ((string?) -> unit)) -> unit

Arguments:

• headers (of type [string * string], which defaults to []): Additional headers.
• http_version (of type string?, which defaults to null): Http request version.
• redirect (of type bool, which defaults to true): Perform redirections if needed.
• timeout (of type int, which defaults to 10): Timeout for network operations (in seconds).
• (unlabeled) (of type string): Requested URL, e.g. “http://www.google.com/”.
• on_body_data (of type (string?) -> unit): function called when receiving response body data. null means that all the data has been passed.

Methods:

• headers (of type [string * string]): HTTP headers.
• protocol_version (of type string): Version of the HTTP protocol.
• status_code (of type int): Status code.
• status_message (of type string): Status message.

http.get

Perform a full Http GET request.

Type:

(?headers : [string * string], ?http_version : string?,
 ?redirect : bool, ?timeout : int, string) -> string

Arguments:

• headers (of type [string * string], which defaults to []): Additional headers.
• http_version (of type string?, which defaults to null): Http request version.
• redirect (of type bool, which defaults to true): Perform redirections if needed.
• timeout (of type int, which defaults to 10): Timeout for network operations (in seconds).
• (unlabeled) (of type string): Requested URL, e.g. “http://www.google.com/”.

Methods:

• headers (of type [string * string]): HTTP headers.
• protocol_version (of type string): Version of the HTTP protocol.
• status_code (of type int): Status code.
• status_message (of type string): Status message.

http.get.stream

Perform a full Http GET request.

Type:

(?headers : [string * string], ?http_version : string?,
 ?redirect : bool, ?timeout : int, string,
 on_body_data : ((string?) -> unit)) -> unit

Arguments:

• headers (of type [string * string], which defaults to []): Additional headers.
• http_version (of type string?, which defaults to null): Http request version.
• redirect (of type bool, which defaults to true): Perform redirections if needed.
• timeout (of type int, which defaults to 10): Timeout for network operations (in seconds).
• (unlabeled) (of type string): Requested URL, e.g. “http://www.google.com/”.
• on_body_data (of type (string?) -> unit): function called when receiving response body data. null means that all the data has been passed.

Methods:

• headers (of type [string * string]): HTTP headers.
• protocol_version (of type string): Version of the HTTP protocol.
• status_code (of type int): Status code.
• status_message (of type string): Status message.

http.head

Perform a full Http HEAD request.

Type:

(?headers : [string * string], ?http_version : string?,
 ?redirect : bool, ?timeout : int, string) -> unit

Arguments:

• headers (of type [string * string], which defaults to []): Additional headers.
• http_version (of type string?, which defaults to null): Http request version.
• redirect (of type bool, which defaults to true): Perform redirections if needed.
• timeout (of type int, which defaults to 10): Timeout for network operations (in seconds).
• (unlabeled) (of type string): Requested URL, e.g. “http://www.google.com/”.

Methods:

• headers (of type [string * string]): HTTP headers.
• protocol_version (of type string): Version of the HTTP protocol.
• status_code (of type int): Status code.
• status_message (of type string): Status message.

http.head.stream

Perform a full Http HEAD request.

Type:

(?headers : [string * string], ?http_version : string?,
 ?redirect : bool, ?timeout : int, string,
 on_body_data : ((string?) -> unit)) -> unit

Arguments:

• headers (of type [string * string], which defaults to []): Additional headers.
• http_version (of type string?, which defaults to null): Http request version.
• redirect (of type bool, which defaults to true): Perform redirections if needed.
• timeout (of type int, which defaults to 10): Timeout for network operations (in seconds).
• (unlabeled) (of type string): Requested URL, e.g. “http://www.google.com/”.
• on_body_data (of type (string?) -> unit): function called when receiving response body data. null means that all the data has been passed.

Methods:

• headers (of type [string * string]): HTTP headers.
• protocol_version (of type string): Version of the HTTP protocol.
• status_code (of type int): Status code.
• status_message (of type string): Status message.

http.post

Perform a full Http POST request`.

Type:

(?data : string, ?headers : [string * string],
 ?http_version : string?, ?redirect : bool,
 ?timeout : int, string) -> string

Arguments:

• data (of type string, which defaults to ""): POST data.
• headers (of type [string * string], which defaults to []): Additional headers.
• http_version (of type string?, which defaults to null): Http request version.
• redirect (of type bool, which defaults to true): Perform redirections if needed.
• timeout (of type int, which defaults to 10): Timeout for network operations (in seconds).
• (unlabeled) (of type string): Requested URL, e.g. “http://www.google.com/”.

Methods:

• headers (of type [string * string]): HTTP headers.
• protocol_version (of type string): Version of the HTTP protocol.
• status_code (of type int): Status code.
• status_message (of type string): Status message.

http.post.stream

Perform a full Http POST request`.

Type:

(?data : string, ?headers : [string * string],
 ?http_version : string?, ?redirect : bool,
 ?timeout : int, string,
 on_body_data : ((string?) -> unit)) -> unit

Arguments:

• data (of type string, which defaults to ""): POST data.
• headers (of type [string * string], which defaults to []): Additional headers.
• http_version (of type string?, which defaults to null): Http request version.
• redirect (of type bool, which defaults to true): Perform redirections if needed.
• timeout (of type int, which defaults to 10): Timeout for network operations (in seconds).
• (unlabeled) (of type string): Requested URL, e.g. “http://www.google.com/”.
• on_body_data (of type (string?) -> unit): function called when receiving response body data. null means that all the data has been passed.

Methods:

• headers (of type [string * string]): HTTP headers.
• protocol_version (of type string): Version of the HTTP protocol.
• status_code (of type int): Status code.
• status_message (of type string): Status message.

http.put

Perform a full Http PUT request.

Type:

(?data : string, ?headers : [string * string],
 ?http_version : string?, ?redirect : bool,
 ?timeout : int, string) -> string

Arguments:

• data (of type string, which defaults to ""): POST data.
• headers (of type [string * string], which defaults to []): Additional headers.
• http_version (of type string?, which defaults to null): Http request version.
• redirect (of type bool, which defaults to true): Perform redirections if needed.
• timeout (of type int, which defaults to 10): Timeout for network operations (in seconds).
• (unlabeled) (of type string): Requested URL, e.g. “http://www.google.com/”.

Methods:

• headers (of type [string * string]): HTTP headers.
• protocol_version (of type string): Version of the HTTP protocol.
• status_code (of type int): Status code.
• status_message (of type string): Status message.

http.put.stream

Perform a full Http PUT request.

Type:

(?data : string, ?headers : [string * string],
 ?http_version : string?, ?redirect : bool,
 ?timeout : int, string,
 on_body_data : ((string?) -> unit)) -> unit

Arguments:

• data (of type string, which defaults to ""): POST data.
• headers (of type [string * string], which defaults to []): Additional headers.
• http_version (of type string?, which defaults to null): Http request version.
• redirect (of type bool, which defaults to true): Perform redirections if needed.
• timeout (of type int, which defaults to 10): Timeout for network operations (in seconds).
• (unlabeled) (of type string): Requested URL, e.g. “http://www.google.com/”.
• on_body_data (of type (string?) -> unit): function called when receiving response body data. null means that all the data has been passed.

Methods:

• headers (of type [string * string]): HTTP headers.
• protocol_version (of type string): Version of the HTTP protocol.
• status_code (of type int): Status code.
• status_message (of type string): Status message.

http.response

Create a HTTP response string.

Type:

(?protocol : string, ?code : int,
 ?headers : [string * string], ?content_type : string,
 ?data : string) -> () -> string

Arguments:

• protocol (of type string, which defaults to "HTTP/1.1"): HTTP protocol used.
• code (of type int, which defaults to 200): Response code.
• headers (of type [string * string], which defaults to []): Response headers.
• content_type (of type string, which defaults to ""): Content type for the data.
• data (of type string, which defaults to ""): Response data.

http.response.stream

Create a streamed HTTP response.

Type:

(?protocol : string, ?code : int,
 ?headers : [string * string], ?content_type : string,
 data_len : 'a, data : (() -> string)) -> () -> string

Arguments:

• protocol (of type string, which defaults to "HTTP/1.1"): HTTP protocol used.
• code (of type int, which defaults to 200): Response code.
• headers (of type [string * string], which defaults to []): Response headers.
• content_type (of type string, which defaults to ""): Content type for the data.
• data_len (of type 'a): Response length in bytes.
• data (of type () -> string): Response data.

icy.update_metadata

Update metata on an icecast mountpoint using the ICY protocol.

Type:

(?host : string, ?port : int, ?user : string,
 ?password : string, ?mount : string, ?icy_id : int,
 ?protocol : string, ?encoding : string?,
 ?headers : [string * string], [string * string]) -> unit

Arguments:

• host (of type string, which defaults to "localhost")
• port (of type int, which defaults to 8000)
• user (of type string, which defaults to "source")
• password (of type string, which defaults to "hackme")
• mount (of type string, which defaults to ""): Source mount point. Mandatory when streaming to icecast.
• icy_id (of type int, which defaults to 1): Shoutcast source ID. Only supported by Shoutcast v2.
• protocol (of type string, which defaults to "http"): Protocol to use. One of: “icy”, “http” or “https”
• encoding (of type string?, which defaults to null): Encoding used to send metadata, default (UTF-8) if null.
• headers (of type [string * string], which defaults to [("User-Agent", "Liquidsoap/2.0.0 (Unix; OCaml 4.12.0)")]): Additional headers.
• (unlabeled) (of type [string * string])

interactive.bool

Read a boolean from an interactive input.

Type:

(?description : string, ?osc : string, string, bool) ->
() -> bool

Arguments:

• description (of type string, which defaults to ""): Description of the variable.
• osc (of type string, which defaults to ""): OSC address.
• (unlabeled) (of type string): Name of the variable.
• (unlabeled) (of type bool): Initial value.

Methods:

• remove (of type () -> unit)
• set (of type (bool) -> unit)

interactive.float

Read a float from an interactive input.

Type:

(?min : float, ?max : float, ?step : float,
 ?description : string, ?unit : string, ?osc : string,
 string, float) -> () -> float

Arguments:

• min (of type float, which defaults to -inf): Minimal value.
• max (of type float, which defaults to inf): Maximal value.
• step (of type float, which defaults to 0.1): Typical variation of the value.
• description (of type string, which defaults to ""): Description of the variable.
• unit (of type string, which defaults to ""): Unit for the variable.
• osc (of type string, which defaults to ""): OSC address.
• (unlabeled) (of type string): Name of the variable.
• (unlabeled) (of type float): Initial value.

Methods:

• remove (of type () -> unit)
• set (of type (float) -> unit)

interactive.harbor

Expose interactive variables through habor http server.

Type:

(?port : int, ?uri : string) -> unit

Arguments:

• port (of type int, which defaults to 8000): Port of the server.
• uri (of type string, which defaults to "/interactive"): URI of the server.

interactive.int

Read an integer from an interactive input.

Type:

(?description : string, ?osc : string, string, int) ->
() -> int

Arguments:

• description (of type string, which defaults to ""): Description of the variable.
• osc (of type string, which defaults to ""): OSC address.
• (unlabeled) (of type string): Name of the variable.
• (unlabeled) (of type int): Initial value.

Methods:

• remove (of type () -> unit)
• set (of type (int) -> unit)

interactive.string

Read a string from an interactive input.

Type:

(?description : string, ?osc : string, string, string) ->
() -> string

Arguments:

• description (of type string, which defaults to ""): Description of the variable.
• osc (of type string, which defaults to ""): OSC address.
• (unlabeled) (of type string): Name of the variable.
• (unlabeled) (of type string): Initial value.

Methods:

• remove (of type () -> unit)
• set (of type (string) -> unit)

metadata.getter

Create a getter from a metadata: this is a string, whose value can be changed with a metadata.

Type:

(string, string, source('a)) -> () -> string

Arguments:

• (unlabeled) (of type string): Initial value.
• (unlabeled) (of type string): Metadata on which the value should be updated.
• (unlabeled) (of type source('a)): Source containing the metadata.

metadata.getter.float

Create a float getter from a metadata: this is a float, whose value can be changed with a metadata.

Type:

(float, string, source('a)) -> () -> float

Arguments:

• (unlabeled) (of type float): Initial value.
• (unlabeled) (of type string): Metadata on which the value should be updated.
• (unlabeled) (of type source('a)): Source containing the metadata.

osc.bool

Read from an OSC path.

Type:

(string, bool) -> () -> bool

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type bool): Initial value.

osc.float

Read from an OSC path.

Type:

(string, float) -> () -> float

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type float): Initial value.

osc.float_pair

Read from an OSC path.

Type:

(string, (float * float)) -> () -> float * float

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type float * float): Initial value.

osc.int

Read from an OSC path.

Type:

(string, int) -> () -> int

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type int): Initial value.

osc.int_pair

Read from an OSC path.

Type:

(string, (int * int)) -> () -> int * int

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type int * int): Initial value.

osc.on_bool

Register a callback on OSC messages.

Type:

(string, ((bool) -> unit)) -> unit

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type (bool) -> unit): Callback function.

osc.on_float

Register a callback on OSC messages.

Type:

(string, ((float) -> unit)) -> unit

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type (float) -> unit): Callback function.

osc.on_float_pair

Register a callback on OSC messages.

Type:

(string, (((float * float)) -> unit)) -> unit

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type ((float * float)) -> unit): Callback function.

osc.on_int

Register a callback on OSC messages.

Type:

(string, ((int) -> unit)) -> unit

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type (int) -> unit): Callback function.

osc.on_int_pair

Register a callback on OSC messages.

Type:

(string, (((int * int)) -> unit)) -> unit

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type ((int * int)) -> unit): Callback function.

osc.on_string

Register a callback on OSC messages.

Type:

(string, ((string) -> unit)) -> unit

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type (string) -> unit): Callback function.

osc.on_string_pair

Register a callback on OSC messages.

Type:

(string, (((string * string)) -> unit)) -> unit

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type ((string * string)) -> unit): Callback function.

osc.send_bool

Send a value to an OSC client.

Type:

(host : string, port : int, string, bool) -> unit

Arguments:

• host (of type string): OSC client address.
• port (of type int): OSC client port.
• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type bool): Value to send.

osc.send_float

Send a value to an OSC client.

Type:

(host : string, port : int, string, float) -> unit

Arguments:

• host (of type string): OSC client address.
• port (of type int): OSC client port.
• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type float): Value to send.

osc.send_float_pair

Send a value to an OSC client.

Type:

(host : string, port : int, string, (float * float)) ->
unit

Arguments:

• host (of type string): OSC client address.
• port (of type int): OSC client port.
• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type float * float): Value to send.

osc.send_int

Send a value to an OSC client.

Type:

(host : string, port : int, string, int) -> unit

Arguments:

• host (of type string): OSC client address.
• port (of type int): OSC client port.
• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type int): Value to send.

osc.send_int_pair

Send a value to an OSC client.

Type:

(host : string, port : int, string, (int * int)) -> unit

Arguments:

• host (of type string): OSC client address.
• port (of type int): OSC client port.
• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type int * int): Value to send.

osc.send_string

Send a value to an OSC client.

Type:

(host : string, port : int, string, string) -> unit

Arguments:

• host (of type string): OSC client address.
• port (of type int): OSC client port.
• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type string): Value to send.

osc.send_string_pair

Send a value to an OSC client.

Type:

(host : string, port : int, string, (string * string)) ->
unit

Arguments:

• host (of type string): OSC client address.
• port (of type int): OSC client port.
• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type string * string): Value to send.

osc.string

Read from an OSC path.

Type:

(string, string) -> () -> string

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type string): Initial value.

osc.string_pair

Read from an OSC path.

Type:

(string, (string * string)) -> () -> string * string

Arguments:

• (unlabeled) (of type string): OSC path.
• (unlabeled) (of type string * string): Initial value.

print

Print on standard output.

Type:

(?newline : bool, 'a) -> unit

Arguments:

• newline (of type bool, which defaults to true): If true, a newline is added after displaying the value.
• (unlabeled) (of type 'a)

prometheus.counter

Register a prometheus counter

Type:

(help : string, ?namespace : string, ?subsystem : string,
 labels : [string], string) ->
(label_values : [string]) -> (float) -> unit

Arguments:

• help (of type string): Help of the metric
• namespace (of type string, which defaults to ""): namespace of the metric
• subsystem (of type string, which defaults to ""): subsystem of the metric
• labels (of type [string]): labels for the metric
• (unlabeled) (of type string): Name of the metric

prometheus.gauge

Register a prometheus gauge

Type:

(help : string, ?namespace : string, ?subsystem : string,
 labels : [string], string) ->
(label_values : [string]) -> (float) -> unit

Arguments:

• help (of type string): Help of the metric
• namespace (of type string, which defaults to ""): namespace of the metric
• subsystem (of type string, which defaults to ""): subsystem of the metric
• labels (of type [string]): labels for the metric
• (unlabeled) (of type string): Name of the metric

prometheus.summary

Register a prometheus summary

Type:

(help : string, ?namespace : string, ?subsystem : string,
 labels : [string], string) ->
(label_values : [string]) -> (float) -> unit

Arguments:

• help (of type string): Help of the metric
• namespace (of type string, which defaults to ""): namespace of the metric
• subsystem (of type string, which defaults to ""): subsystem of the metric
• labels (of type [string]): labels for the metric
• (unlabeled) (of type string): Name of the metric

server.broadcast

Restart all server clients waiting on the given condition.

Type:

(('a * ('b * (() -> 'c)))) -> 'c

Arguments:

• (unlabeled) (of type 'a * ('b * (() -> 'c))): condition

server.register

Register a command. You can then execute this function through the server, either telnet or socket.

Type:

(?namespace : string?, ?description : string,
 ?usage : string?, string, ((string) -> string)) -> unit

Arguments:

• namespace (of type string?, which defaults to null): Used to group multiple commands for the same functionality. If specified, the command will be named namespace.command.
• description (of type string, which defaults to "No documentation available."): A description of your command.
• usage (of type string?, which defaults to null): Description of how the command should be used.
• (unlabeled) (of type string): Name of the command.
• (unlabeled) (of type (string) -> string): Function called when the command is executed. It takes as argument the argument passed on the commandline and returns the message which will be printed on the commandline.

server.register_operator

Register an operator. This is mainly used to populate the list command on the telnet server.

Type:

(kind : string, string) -> unit

Arguments:

• kind (of type string): Kind of the operator (generally, the name of the function used to create it).
• (unlabeled) (of type string): Identifier of the operator.

server.signal

Restart one server client waiting on the given condition.

Type:

(('a * ((() -> 'b) * 'c))) -> 'b

Arguments:

• (unlabeled) (of type 'a * ((() -> 'b) * 'c)): condition

server.telnet

Enable telnet server.

Type:

() -> unit

Arguments:

Interactive

interactive.bool.remove

Remove an interactive variable. flag hidden

Type:

(string) -> unit

Arguments:

• (unlabeled) (of type string): Name of the variable.

interactive.load

Load the value of interactive variables from a file.

Type:

(string) -> unit

Arguments:

• (unlabeled) (of type string): Name of the file.

interactive.persistent

Make the value of interactive variables persistent: they are loaded from the given file and stored there whenever updated. This function should be called after all interactive variables have been defined (variables not declared yet will not be loaded).

Type:

(string) -> unit

Arguments:

• (unlabeled) (of type string): Name of the file.

interactive.save

Save the value of all interactive variables in a file.

Type:

(string) -> unit

Arguments:

• (unlabeled) (of type string): Name of the file.

Liquidsoap

add_decoder

Register an external decoder. The encoder should output in WAV format to his standard output (stdout) and read data from its standard input (stdin).

Type:

(name : string, description : string, ?mimes : [string],
 ?file_extensions : [string], ?priority : int,
 test : ((string) -> int), string) -> unit

Arguments:

• name (of type string): Format/decoder’s name.
• description (of type string): Description of the decoder.
• mimes (of type [string], which defaults to []): List of mime types supported by this decoder. Empty means any mime type should be accepted.
• file_extensions (of type [string], which defaults to []): List of file extensions. Empty means any file extension should be accepted.
• priority (of type int, which defaults to 1): Decoder priority
• test (of type (string) -> int): Function used to determine if a 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.
• (unlabeled) (of type string): Process to start.

add_metadata_resolver

Register an external file metadata decoder.

Type:

(string, ((string) -> [string * string])) -> unit

Arguments:

• (unlabeled) (of type string): Format/resolver’s name.
• (unlabeled) (of type (string) -> [string * string]): Process to start. The function takes the format and filename as argument and returns a list of (name,value) fields.

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.

Type:

(name : string, description : string,
 test : ((string) -> int), ?priority : int,
 ?mimes : [string], ?file_extensions : [string],
 ?buffer : float, ((string) -> string)) -> unit

Arguments:

• name (of type string): Format/decoder’s name.
• description (of type string): Description of the decoder.
• test (of type (string) -> int): Function used to determine if a 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.
• priority (of type int, which defaults to 1): Decoder priority
• mimes (of type [string], which defaults to []): List of mime types supported by this decoder. Empty means any mime type should be accepted.
• file_extensions (of type [string], which defaults to []): List of file extensions. Empty means any file extension should be accepted.
• buffer (of type float, which defaults to 5.)
• (unlabeled) (of type (string) -> string): Process to start. The function takes the filename as argument and returns the process to start.

add_protocol

Register a new protocol.

Type:

(?temporary : bool, ?static : bool, ?syntax : string,
 ?doc : string, string,
 ((rlog : ((string) -> unit), maxtime : float, string) ->
  [string])) -> unit

Arguments:

• temporary (of type bool, which defaults to false): if true, file is removed when it is finished.
• static (of type bool, which defaults to false): if true, then requests can be resolved once and for all. Typically, static protocols can be used to create infallible sources.
• syntax (of type string, which defaults to "Undocumented"): URI syntax.
• doc (of type string, which defaults to "Undocumented"): Protocol documentation.
• (unlabeled) (of type string): Protocol name. Resolver will be called on uris of the form: <protocol name>:....
• (unlabeled) (of type (rlog : ((string) -> unit), maxtime : float, string) -> [string]): Protocol resolver. Receives a function to log protocol resolution, the <arg> in <protocol name>:<arg> and the max delay that resolution should take.

assert

Ensure that a condition is satisfied (raise error.assertion exception otherwise).

Type:

(bool) -> unit

Arguments:

• (unlabeled) (of type bool): Condition which should be satisfied.

audio.channels

Channels for audio.

Type:

() -> int

Arguments:

audio.samplerate

Samplerate for audio.

Type:

() -> int

Arguments:

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.

Type:

(?sync : string, ?id : string?, source('a)) -> source('a)

Arguments:

• sync (of type string, which defaults to "auto"): Synchronization mode. One of: "auto", "cpu", or "none". Defaults to "auto", which synchronizes with the CPU clock if none of the active sources are attached to their own clock (e.g. ALSA input, etc). "cpu" always synchronizes with the CPU clock. "none" removes all synchronization control.
• id (of type string?, which defaults to null)
• (unlabeled) (of type source('a))

clock.assign_new

Create a new clock and assign it to a list of sources.

Type:

(?id : string?, ?sync : string, [source('a)]) -> unit

Arguments:

• id (of type string?, which defaults to null): Identifier for the new clock. The default empty string means that the identifier of the first source will be used.
• sync (of type string, which defaults to "auto"): Synchronization mode. One of: "auto", "cpu", or "none". Defaults to "auto", which synchronizes with the CPU clock if none of the active sources are attached to their own clock (e.g. ALSA input, etc). "cpu" always synchronizes with the CPU clock. "none" removes all synchronization control.
• (unlabeled) (of type [source('a)]): List of sources to which the new clock will be assigned.

clock.log

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.

Type:

(?delay : float, ?every : float, string) -> unit

Arguments:

• delay (of type float, which defaults to 0.): Delay before setting up the clock logger. This should be used to ensure that the logger starts only after the clocks are created.
• every (of type float, which defaults to 1.): Polling interval.
• (unlabeled) (of type string): Path of the log file.

clock.status

Get the current time (in ticks) for all allocated clocks.

Type:

() -> [string * int]

Arguments:

clock.status.seconds

Get the current time in seconds for all allocated clocks.

Type:

() -> [string * float]

Arguments:

clock.unify

Enforce that a list of sources all belong to the same clock.

Type:

([source('a)]) -> unit

Arguments:

• (unlabeled) (of type [source('a)])

configure.bindir

Liquidsoap’s Internal script directory.

Type:

string

Arguments:

configure.default_font

Liquidsoap’s default font file.

Type:

string

Arguments:

configure.libdir

Liquidsoap’s library directory.

Type:

string

Arguments:

configure.logdir

Liquidsoap’s logging directory.

Type:

string

Arguments:

configure.rundir

Liquidsoap’s PID file directory.

Type:

string

Arguments:

enable_external_faad_decoder

Enable or disable external FAAD (AAC/AAC+/M4A) decoders. 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.

Type:

() -> unit

Arguments:

enable_external_ffmpeg_decoder

Enable ffmpeg decoder.

Type:

() -> unit

Arguments:

enable_external_flac_decoder

Enable external FLAC decoders. Please note that built-in support for FLAC is available in liquidsoap if compiled and should be preferred over the external decoder.

Type:

() -> unit

Arguments:

enable_external_mpc_decoder

Enable external Musepack decoder.

Type:

() -> unit

Arguments:

enable_replaygain_metadata

Enable ReplayGain metadata resolver. This resolver will process any file decoded by Liquidsoap and add a replaygain_track_gain metadata when this value could be computed. For a finer-grained replay gain processing, use the replaygain: protocol.

Type:

(?delay : float, ?extract_replaygain : string) -> unit

Arguments:

• delay (of type float, which defaults to -1.): Maximum delay for extracting metadata.
• extract_replaygain (of type string, which defaults to "/usr/share/liquidsoap/2.0.0/bin/extract-replaygain"): The extraction program.

encoder.content_type

Return the content-type (mime) of an encoder, if known.

Type:

(format('a)) -> string

Arguments:

• (unlabeled) (of type format('a))

encoder.extension

Return the file extension of an encoder, if known.

Type:

(format('a)) -> string

Arguments:

• (unlabeled) (of type format('a))

error.kind

Get the kind of an error

Type:

(error) -> string

Arguments:

• (unlabeled) (of type error)

error.message

Get the message of an error

Type:

(error) -> string?

Arguments:

• (unlabeled) (of type error)

error.raise

Raise an error.

Type:

(error, ?string?) -> 'a

Arguments:

• (unlabeled) (of type error): Error kind.
• (unlabeled) (of type string?, which defaults to null): Description of the error.

error.register

Register an error of the given kind

Type:

(string) -> error

Arguments:

• (unlabeled) (of type string): Kind of the error

failwith

Major failure.

Type:

(string?) -> 'a

Arguments:

• (unlabeled) (of type string?): Explanation about the failure.

frame.duration

Duration of a frame.

Type:

() -> float

Arguments:

fst

Get the first component of a pair.

Type:

(('a * 'b)) -> 'a

Arguments:

• (unlabeled) (of type 'a * 'b)

garbage_collect

Trigger full major garbage collection.

Type:

() -> unit

Arguments:

getter

Create a getter.

Type:

({'a}) -> {'a}

Arguments:

• (unlabeled) (of type {'a}): Value from which the getter should be created.

getter.case

Return a value depending on whether the getter is constant or not.

Type:

({'a}, (('a) -> 'c), (((() -> 'a)) -> 'c)) -> 'c

Arguments:

• (unlabeled) (of type {'a}): Getter to inspect.
• (unlabeled) (of type ('a) -> 'c)
• (unlabeled) (of type ((() -> 'a)) -> 'c)

getter.changes

Detect whether the value of the getter changes.

Type:

({'a}) -> () -> bool where 'a is an orderable type

Arguments:

• (unlabeled) (of type {'a} where 'a is an orderable type)

getter.float_of_int

Convert an int getter to a float getter.

Type:

({int}) -> {float}

Arguments:

• (unlabeled) (of type {int})

getter.function

Construct a function returning the value of a getter.

Type:

({'a}) -> () -> 'a

Arguments:

• (unlabeled) (of type {'a})

getter.get

Get the value of a getter.

Type:

({'a}) -> 'a

Arguments:

• (unlabeled) (of type {'a})

getter.int_of_float

Convert a float getter to a int getter.

Type:

({float}) -> {int}

Arguments:

• (unlabeled) (of type {float})

getter.is_constant

Determine if a getter is a constant.

Type:

({'a}) -> bool

Arguments:

• (unlabeled) (of type {'a})

getter.map

Apply a function on a getter.

Type:

((('a) -> 'b), {'a}) -> {'b}

Arguments:

• (unlabeled) (of type ('a) -> 'b): Function to apply.
• (unlabeled) (of type {'a})

getter.map.memoize

Apply a function on a getter. If the input value has not changed compared to last call, the previous result is returned without computing the function again.

Type:

((('a) -> 'b), {'a}) -> {'b}
where 'a is an orderable type

Arguments:

• (unlabeled) (of type ('a) -> 'b where 'a is an orderable type): Function to apply.
• (unlabeled) (of type {'a} where 'a is an orderable type)

getter.on_change

Execute a function when the value of the getter changes.

Type:

((('a) -> unit), {'a}) -> () -> 'a
where 'a is an orderable type

Arguments:

• (unlabeled) (of type ('a) -> unit where 'a is an orderable type)
• (unlabeled) (of type {'a} where 'a is an orderable type)

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. Response is a string getter, i.e. either of type string or type ()->string. In the later case, getter function will be called until it returns an empty string.

Type:

(?port : int, ?method : string, string,
 ((protocol : string, data : string,
   headers : [string * string], string) -> {string})) ->
unit

Arguments:

• port (of type int, which defaults to 8000): Port to server.
• method (of type string, which defaults to "GET"): Accepted method (“GET” / “POST” / “PUT” / “DELETE” / “HEAD” / “OPTIONS”).
• (unlabeled) (of type string): URI to serve.
• (unlabeled) (of type (protocol : string, data : string, headers : [string * string], string) -> {string}): 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.

harbor.http.remove

Remove a registered HTTP handler on the harbor.

Type:

(?port : int, ?method : string, string) -> unit

Arguments:

• port (of type int, which defaults to 8000): Port to server.
• method (of type string, which defaults to "GET"): Method served.
• (unlabeled) (of type string): URI served.

harbor.https.register

Register a HTTPS 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. Response is a string getter, i.e. either of type string or type ()->string. In the later case, getter function will be called until it returns an empty string.

Type:

(?port : int, ?method : string, string,
 ((protocol : string, data : string,
   headers : [string * string], string) -> {string})) ->
unit

Arguments:

• port (of type int, which defaults to 8000): Port to server.
• method (of type string, which defaults to "GET"): Accepted method (“GET” / “POST” / “PUT” / “DELETE” / “HEAD” / “OPTIONS”).
• (unlabeled) (of type string): URI to serve.
• (unlabeled) (of type (protocol : string, data : string, headers : [string * string], string) -> {string}): 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.

harbor.https.remove

Remove a registered HTTPS handler on the harbor.

Type:

(?port : int, ?method : string, string) -> unit

Arguments:

• port (of type int, which defaults to 8000): Port to server.
• method (of type string, which defaults to "GET"): Method served.
• (unlabeled) (of type string): URI served.

http.error

Base error for http

Type:

error

Arguments:

liquidsoap.executable

Path to the Liquidsoap executable.

Type:

string

Arguments:

liquidsoap.version

Liquidsoap version string.

Type:

string

Arguments:

log

Log a message.

Type:

(?label : string, ?level : int, string) -> unit

Arguments:

• label (of type string, which defaults to "lang")
• level (of type int, which defaults to 3)
• (unlabeled) (of type string)

log.critical

Log a critical message

Type:

(?label : string, string) -> unit

Arguments:

• label (of type string, which defaults to "lang")
• (unlabeled) (of type string)

log.debug

Log a debug message

Type:

(?label : string, string) -> unit

Arguments:

• label (of type string, which defaults to "lang")
• (unlabeled) (of type string)

log.file

Get and set the file logging

Type:

() -> bool

Arguments:

log.important

Log an important message

Type:

(?label : string, string) -> unit

Arguments:

• label (of type string, which defaults to "lang")
• (unlabeled) (of type string)

log.info

Log a normal message

Type:

(?label : string, string) -> unit

Arguments:

• label (of type string, which defaults to "lang")
• (unlabeled) (of type string)

log.level

Get and set the log level.

Type:

() -> int

Arguments:

log.severe

Log a severe message

Type:

(?label : string, string) -> unit

Arguments:

• label (of type string, which defaults to "lang")
• (unlabeled) (of type string)

log.stdout

Get and set logging to stdout

Type:

() -> bool

Arguments:

null

Create a nullable value.

Type:

(?'a?) -> 'a?

Arguments:

• (unlabeled) (of type 'a?, which defaults to null): Value to make nullable.

null.case

Return a result dending on whether a value is nothing or not.

Type:

('a?, (() -> 'b), (('a) -> 'b)) -> 'b

Arguments:

• (unlabeled) (of type 'a?): Value to reason by case analysis on.
• (unlabeled) (of type () -> 'b): Value to return in case we have nothing.
• (unlabeled) (of type ('a) -> 'b): Value to return in case we have something.

null.default

Return a result dending on whether a value is nothing or not.

Type:

('a?, (() -> 'a)) -> 'a

Arguments:

• (unlabeled) (of type 'a?): Value to reason by case analysis on.
• (unlabeled) (of type () -> 'a): Value to return in case we have nothing.

null.defined

Determine whether a nullable value is not null.

Type:

('a?) -> bool

Arguments:

• (unlabeled) (of type 'a?)

null.get

Get the value of a nullable. Raises error.not_found if the value is null and no default value was specified.

Type:

(?default : 'a?, 'a?) -> 'a

Arguments:

• default (of type 'a?, which defaults to null): Returned value when the value is null.
• (unlabeled) (of type 'a?)

null.to_list

Convert a nullable value to a list containing zero or one element depending on whether the value is null or not.

Type:

('a?) -> ['a]

Arguments:

• (unlabeled) (of type 'a?)

playlist.files

Retrieve the list of files contained in a playlist.

Type:

(?id : string?, ?mime_type : string?, ?timeout : float,
 string) -> [string]

Arguments:

• id (of type string?, which defaults to null)
• mime_type (of type string?, which defaults to null): Default MIME type for the playlist. null means automatic detection.
• timeout (of type float, which defaults to 20.): Timeout for resolving the playlist
• (unlabeled) (of type string): Path to the playlist

playlist.id

Default id assignment for playlists

Type:

(default : string, string) -> string

Arguments:

• default (of type string): Default name pattern when no useful name can be extracted from uri
• (unlabeled) (of type string): Playlist uri

playlist.parse

Try to parse a local playlist. Return a list of (metadata,URI) items, where metadata is a list of (key,value) bindings.

Type:

(?path : string, ?mime : string?, string) ->
[[string * string] * string]

Arguments:

• path (of type string, which defaults to ""): Default path for files.
• mime (of type string?, which defaults to null): Mime type for the playlist
• (unlabeled) (of type string)

playlist.parse.register

Register a new playlist parser. An empty playlist is considered as a failure to resolve.

Type:

(format : string, strict : bool,
 ((?pwd : string, string) ->
  [[string * string] * string])) -> unit

Arguments:

• format (of type string): Playlist format. If possible, a mime-type.
• strict (of type bool): True if playlist format can be detected unambiguously.
• (unlabeled) (of type (?pwd : string, string) -> [[string * string] * string]): Playlist parser

predicate.activates

Detect when a predicate becomes true.

Type:

(?init : bool, (() -> bool)) -> () -> bool

Arguments:

• init (of type bool, which defaults to false): Detect at beginning.
• (unlabeled) (of type () -> bool): Predicate.

predicate.changes

Detect when a predicate changes.

Type:

((() -> 'a)) -> () -> bool where 'a is an orderable type

Arguments:

• (unlabeled) (of type () -> 'a where 'a is an orderable type): Predicate.

predicate.first

First occurrence of a predicate.

Type:

((() -> bool)) -> () -> bool

Arguments:

• (unlabeled) (of type () -> bool): Predicate.

predicate.once

Become true once every time a predicate is true.

Type:

((() -> bool)) -> () -> bool

Arguments:

• (unlabeled) (of type () -> bool): Predicate.

predicate.signal

Predicate which is true when a signal is sent. The returned predicate has a method signal to send the signal.

Type:

() -> () -> bool

Arguments:

Methods:

• signal (of type () -> unit): Send a signal.

process_uri

Create a process: uri, replacing : with $(colon)

Type:

(extname : 'a, ?uri : string, string) -> string

Arguments:

• extname (of type 'a): Output file extension (with no leading ‘.’)
• uri (of type string, which defaults to ""): Input uri
• (unlabeled) (of type string): Command line to execute

profiler.disable

Record profiling statistics.

Type:

() -> unit

Arguments:

profiler.enable

Record profiling statistics.

Type:

() -> unit

Arguments:

profiler.run

Time a function with the profiler.

Type:

(string, (() -> 'a)) -> 'a

Arguments:

• (unlabeled) (of type string): Name of the profiled function.
• (unlabeled) (of type () -> 'a): Function to profile.

profiler.stats.string

Profiling statistics.

Type:

() -> string

Arguments:

prometheus.latency

Monitor a source’s internal latencies on Prometheus

Type:

(?window : float, ?prefix : string, labels : [string]) ->
(label_values : [string], source('a)) -> unit

Arguments:

• window (of type float, which defaults to 5.): Window over which mean and peak metrics are reported.
• prefix (of type string, which defaults to "liquidsoap_"): Prefix for the metric’s name
• labels (of type [string]): labels for the metric

ref

Create a reference, i.e. a value which can be modified.

Type:

('a) -> ref('a)

Arguments:

• (unlabeled) (of type 'a)

ref.get

Retrieve the contents of a reference.

Type:

(ref('a)) -> 'a

Arguments:

• (unlabeled) (of type ref('a))

ref.getter

Create a getter from a reference.

Type:

(ref('a)) -> () -> 'a

Arguments:

• (unlabeled) (of type ref('a))

Methods:

• set (of type (?A) -> unit)

ref.incr

Increment a reference to an integer.

Type:

(ref(int)) -> unit

Arguments:

• (unlabeled) (of type ref(int))

ref.set

Set the value of a reference.

Type:

(ref('a), 'a) -> unit

Arguments:

• (unlabeled) (of type ref('a))
• (unlabeled) (of type 'a)

request.create

Create a request from an URI.

Type:

(?indicators : [string], ?persistent : bool,
 ?temporary : bool, string) -> request

Arguments:

• indicators (of type [string], which defaults to [])
• persistent (of type bool, which defaults to false): Indicate that the request is persistent, i.e. that it may be used again once it has been played.
• temporary (of type bool, which defaults to false): Indicate that the request is a temporary file: it will be destroyed after being played.
• (unlabeled) (of 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.

Type:

(?force : bool, request) -> unit

Arguments:

• force (of type bool, which defaults to false): Destroy the request even if it is persistent.
• (unlabeled) (of type request)

request.duration

Compute the duration in seconds of audio data contained in a request. The computation may be expensive. Returns -1. if computation failed, typically if the file was not recognized as valid audio.

Type:

(string) -> float

Arguments:

• (unlabeled) (of type string)

request.filename

Return a valid local filename if the request is ready, and the empty string otherwise.

Type:

(request) -> string

Arguments:

• (unlabeled) (of type request)

request.id

Identifier of a request.

Type:

(request) -> int

Arguments:

• (unlabeled) (of type request)

request.log

Get log data associated to a request.

Type:

(request) -> string

Arguments:

• (unlabeled) (of type request)

request.metadata

Get the metadata associated to a request.

Type:

(request) -> [string * string]

Arguments:

• (unlabeled) (of type request)

request.read_metadata

Force reading the metadata of a request.

Type:

(request) -> unit

Arguments:

• (unlabeled) (of type request)

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.

Type:

(request) -> bool

Arguments:

• (unlabeled) (of type request)

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). The request should not be decoded afterward: this is mostly useful to download files such as playlists, etc.

Type:

(?content_type : source('a)?, ?timeout : float, request) ->
bool

Arguments:

• content_type (of type source('a)?, which defaults to null): If specified, the request will be decoded with the same content type as the given source.
• timeout (of type float, which defaults to 30.): Limit in seconds to the duration of the resolving.
• (unlabeled) (of type request)

request.status

Current status of a request. Can be idle, resolving, ready, playing or destroyed.

Type:

(request) -> string

Arguments:

• (unlabeled) (of type request)

request.uri

Initial URI of a request.

Type:

(request) -> string

Arguments:

• (unlabeled) (of type request)

seconds_of_main

Convert a number of main ticks in seconds.

Type:

(int) -> float

Arguments:

• (unlabeled) (of type int)

server.execute

Execute a liquidsoap server command.

Type:

(string, ?string) -> [string]

Arguments:

• (unlabeled) (of type string): Command to execute.
• (unlabeled) (of type string, which defaults to ""): Argument for the command.

settings

All settings.

Type:

{
  video : 
  {
    converter : 
    {
      proportional_scale : (() -> bool)
      .{
        set : (bool) -> unit,
        comments : string,
        description : string
      },
      preferred : (() -> string)
      .{
        set : (string) -> unit,
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  tag : 
  {
    encodings : (() -> [string])
    .{
      set : ([string]) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  srt : 
  {
    poll : 
    {
      timeout : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    log : (() -> bool)
    .{
      level : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    enforced_encryption : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  server : 
  {
    timeout : (() -> float)
    .{
      set : (float) -> unit,
      comments : string,
      description : string
    },
    telnet : (() -> bool)
    .{
      revdns : (() -> bool)
      .{
        set : (bool) -> unit,
        comments : string,
        description : string
      },
      port : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      bind_addr : (() -> string)
      .{
        set : (string) -> unit,
        comments : string,
        description : string
      },
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    socket : (() -> bool)
    .{
      permissions : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      path : (() -> string)
      .{
        set : (string) -> unit,
        comments : string,
        description : string
      },
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    log : 
    {
      level : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  scheduler : 
  {
    non_blocking_queues : (() -> int)
    .{
      set : (int) -> unit,
      comments : string,
      description : string
    },
    log : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    generic_queues : (() -> int)
    .{
      set : (int) -> unit,
      comments : string,
      description : string
    },
    fast_queues : (() -> int)
    .{
      set : (int) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  sandbox : (() -> bool)
  .{
    unsetenv : (() -> [string])
    .{
      set : ([string]) -> unit,
      comments : string,
      description : string
    },
    shell : (() -> bool)
    .{
      path : (() -> string)
      .{
        set : (string) -> unit,
        comments : string,
        description : string
      },
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    setenv : (() -> [string])
    .{
      set : ([string]) -> unit,
      comments : string,
      description : string
    },
    rw : (() -> [string])
    .{
      set : ([string]) -> unit,
      comments : string,
      description : string
    },
    ro : (() -> [string])
    .{
      set : ([string]) -> unit,
      comments : string,
      description : string
    },
    network : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    binary : (() -> string)
    .{
      set : (string) -> unit,
      comments : string,
      description : string
    },
    set : (bool) -> unit,
    comments : string,
    description : string
  },
  root : 
  {
    max_latency : (() -> float)
    .{
      set : (float) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  request : 
  {
    metadata_decoders : (() -> [string])
    .{
      override : (() -> bool)
      .{
        set : (bool) -> unit,
        comments : string,
        description : string
      },
      duration : (() -> bool)
      .{
        set : (bool) -> unit,
        comments : string,
        description : string
      },
      set : ([string]) -> unit,
      comments : string,
      description : string
    },
    leak_warning : (() -> int)
    .{
      set : (int) -> unit,
      comments : string,
      description : string
    },
    grace_time : (() -> float)
    .{
      set : (float) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  prometheus : 
  {
    server : (() -> bool)
    .{
      port : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  playlists : 
  {
    mime_types : 
    {
      xml : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    cue_out_metadata : (() -> string)
    .{
      set : (string) -> unit,
      comments : string,
      description : string
    },
    cue_in_metadata : (() -> string)
    .{
      set : (string) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  osc : 
  {
    port : (() -> int)
    .{
      set : (int) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  mpd : 
  {
    randomize : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    port : (() -> int)
    .{
      set : (int) -> unit,
      comments : string,
      description : string
    },
    path : (() -> string)
    .{
      set : (string) -> unit,
      comments : string,
      description : string
    },
    host : (() -> string)
    .{
      set : (string) -> unit,
      comments : string,
      description : string
    },
    debug : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  log : 
  {
    unix_timestamps : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    stdout : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    level : (() -> int)
    .{
      video : (() -> int?)
      .{
        converter : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      threads : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      srt : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      source : (() -> int?)
      .{
        dump : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      single : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      server : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      sandbox : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      request : (() -> int?)
      .{
        dynamic : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      prometheus : (() -> int?)
      .{
        server : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      process : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      playlist_parser : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      playlist : (() -> int?)
      .{
        xml : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        basic : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      oggmuxer : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      metadata : (() -> int?)
      .{
        mp4 : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        flac : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      lo : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      lifecycle : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      lastfm : (() -> int?)
      .{
        submit : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      langfile : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      lang : (() -> int?)
      .{
        json : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      io : (() -> int?)
      .{
        gstreamer : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      input : (() -> int?)
      .{
        jack : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        http : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        external : (() -> int?)
        .{
          video : (() -> int?)
          .{
            set : (int) -> unit,
            comments : string,
            description : string
          },
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      image : (() -> int?)
      .{
        decoder : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      icy : (() -> int?)
      .{
        update_metadata : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      hls : (() -> int?)
      .{
        output : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      harbor : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      gstreamer : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      frei0r : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      frame : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      ffmpeg : (() -> int?)
      .{
        internal : (() -> int?)
        .{
          decoder : (() -> int?)
          .{
            set : (int) -> unit,
            comments : string,
            description : string
          },
          set : (int) -> unit,
          comments : string,
          description : string
        },
        filter : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        encoder : (() -> int?)
        .{
          internal : (() -> int?)
          .{
            set : (int) -> unit,
            comments : string,
            description : string
          },
          set : (int) -> unit,
          comments : string,
          description : string
        },
        decoder : (() -> int?)
        .{
          copy : (() -> int?)
          .{
            set : (int) -> unit,
            comments : string,
            description : string
          },
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      encoder : (() -> int?)
      .{
        gstreamer : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      dynamic : (() -> int?)
      .{
        loader : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      decoder : (() -> int?)
      .{
        wav_aiff : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        taglib : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        raw : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        ppm : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        ogg : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        mp4 : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        midi : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        mad : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        id3v2 : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        gstreamer : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        flac : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        ffmpeg : (() -> int?)
        .{
          internal : (() -> int?)
          .{
            set : (int) -> unit,
            comments : string,
            description : string
          },
          image : (() -> int?)
          .{
            set : (int) -> unit,
            comments : string,
            description : string
          },
          set : (int) -> unit,
          comments : string,
          description : string
        },
        external : (() -> int?)
        .{
          oblivious : (() -> int?)
          .{
            set : (int) -> unit,
            comments : string,
            description : string
          },
          set : (int) -> unit,
          comments : string,
          description : string
        },
        camlimages : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        aac : (() -> int?)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      console : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      clock : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      camomile : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      audioscrobbler : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      audio : (() -> int?)
      .{
        converter : (() -> int?)
        .{
          libsamplerate : (() -> int?)
          .{
            set : (int) -> unit,
            comments : string,
            description : string
          },
          set : (int) -> unit,
          comments : string,
          description : string
        },
        set : (int) -> unit,
        comments : string,
        description : string
      },
      annotate : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      ladspa_extension : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      dssi_synthesizer : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      set : (int) -> unit,
      comments : string,
      description : string
    },
    file : (() -> bool)
    .{
      perms : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      path : (() -> string?)
      .{
        set : (string) -> unit,
        comments : string,
        description : string
      },
      append : (() -> bool)
      .{
        set : (bool) -> unit,
        comments : string,
        description : string
      },
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  lang : 
  {
    debug_errors : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    debug : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  init : 
  {
    trace : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    force_start : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    daemon : (() -> bool)
    .{
      pidfile : (() -> bool)
      .{
        perms : (() -> int)
        .{
          set : (int) -> unit,
          comments : string,
          description : string
        },
        path : (() -> string?)
        .{
          set : (string) -> unit,
          comments : string,
          description : string
        },
        set : (bool) -> unit,
        comments : string,
        description : string
      },
      change_user : (() -> bool)
      .{
        user : (() -> string)
        .{
          set : (string) -> unit,
          comments : string,
          description : string
        },
        group : (() -> string)
        .{
          set : (string) -> unit,
          comments : string,
          description : string
        },
        set : (bool) -> unit,
        comments : string,
        description : string
      },
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    catch_exn : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    allow_root : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  harbor : 
  {
    verbose : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    timeout : (() -> float)
    .{
      set : (float) -> unit,
      comments : string,
      description : string
    },
    ssl : 
    {
      write_timeout : (() -> float)
      .{
        set : (float) -> unit,
        comments : string,
        description : string
      },
      read_timeout : (() -> float)
      .{
        set : (float) -> unit,
        comments : string,
        description : string
      },
      private_key : (() -> string)
      .{
        set : (string) -> unit,
        comments : string,
        description : string
      },
      password : (() -> string)
      .{
        set : (string) -> unit,
        comments : string,
        description : string
      },
      certificate : (() -> string)
      .{
        set : (string) -> unit,
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    reverse_dns : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    max_connections : (() -> int)
    .{
      set : (int) -> unit,
      comments : string,
      description : string
    },
    icy_formats : (() -> [string])
    .{
      set : ([string]) -> unit,
      comments : string,
      description : string
    },
    bind_addrs : (() -> [string])
    .{
      set : ([string]) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  gstreamer : 
  {
    max_buffers : (() -> int)
    .{
      set : (int) -> unit,
      comments : string,
      description : string
    },
    add_borders : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  frame : 
  {
    video : 
    {
      width : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      height : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      framerate : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      default : (() -> bool)
      .{
        set : (bool) -> unit,
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    midi : 
    {
      channels : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    duration : (() -> float)
    .{
      set : (float) -> unit,
      comments : string,
      description : string
    },
    audio : 
    {
      size : (() -> int?)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      samplerate : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      channels : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  ffmpeg : 
  {
    scaling_algorithm : (() -> string)
    .{
      set : (string) -> unit,
      comments : string,
      description : string
    },
    log : 
    {
      verbosity : (() -> string)
      .{
        set : (string) -> unit,
        comments : string,
        description : string
      },
      level : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  encoder : 
  {
    metadata : 
    {
      export : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  decoder : 
  {
    taglib : 
    {comments : string, description : string
    },
    priorities : 
    {
      wav : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      ogg : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      mp4 : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      mad : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      gstreamer : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      flac : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      ffmpeg : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      basic : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      aiff : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      aac : (() -> int)
      .{
        set : (int) -> unit,
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    mime_types : 
    {
      wav : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      taglib : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      ogg : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      mp4 : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      mp3 : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      mad : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      id3v2 : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      gstreamer : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      flac : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      ffmpeg : (() -> [string])
      .{
        images : (() -> [string])
        .{
          set : ([string]) -> unit,
          comments : string,
          description : string
        },
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      basic : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      aiff : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      aac : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    image_file_decoders : (() -> [string])
    .{
      set : ([string]) -> unit,
      comments : string,
      description : string
    },
    id3v2 : 
    {comments : string, description : string
    },
    file_extensions : 
    {
      wav : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      taglib : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      ogg : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      mp4 : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      mp3 : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      mad : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      id3v2 : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      gstreamer : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      flac : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      ffmpeg : (() -> [string])
      .{
        images : (() -> [string])
        .{
          set : ([string]) -> unit,
          comments : string,
          description : string
        },
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      aiff : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      aac : (() -> [string])
      .{
        set : ([string]) -> unit,
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    ffmpeg : 
    {
      codecs : 
      {
        zmbv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        zlib : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        yuv4 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        yop : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        ylc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        y41p : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        xwd : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        xpm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        xma2 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        xma1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        xbm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        xan_wc4 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        xan_wc3 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        ws_vqa : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        wnv1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        wmv3 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        wmv2 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        wmv1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        wmavoice : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        wmalossless : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        westwood_snd1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        webp : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        wcmv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        wavpack : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        wavesynth : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vp9 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vp8 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vp7 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vp6f : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vp6a : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vp6 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vp5 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vp4 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vp3 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vorbis : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vmnc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vmdvideo : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vmdaudio : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vixl : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vcr1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vc1image : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vc1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vble : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        vb : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        v410 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        v408 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        v308 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        v210x : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        v210 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        ulti : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        txd : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        tta : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        tscc2 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        tscc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        truemotion2rt : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        truemotion2 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        truemotion1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        truehd : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        tqi : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        tmv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        tiff : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        tiertexseqvideo : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        thp : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        theora : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        tgv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        tgq : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        tdsc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        targa_y216 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        targa : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        tak : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        svq3 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        svq1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        svg : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        srgc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        speex : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        speedhq : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        sp5x : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        sonic : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        sol_dpcm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        snow : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        smc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        siren : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        sipr : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        sgi : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        sdx2_dpcm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        screenpresso : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        scpr : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        sbc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        sanm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        rv40 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        rv30 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        rv20 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        rv10 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        rscc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        rpza : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        roq : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        rl2 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        rasc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        ralf : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        r210 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        r10k : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        qpeg : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        qdmc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        qdm2 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        ptx : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        psd : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        ppm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        png : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pictor : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pgmyuv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pgm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pfm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcx : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_vidc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_u32le : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_u32be : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_u24le : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_u24be : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_u16le : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_u16be : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_s64le : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_s64be : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_s32le_planar : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_s32le : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_s32be : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_s24le_planar : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_s24le : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_s24daud : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_s24be : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_s16le_planar : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_s16le : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_s16be : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_lxf : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_f64le : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_f64be : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_f32le : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_f32be : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_f24le : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_f16le : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_dvd : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pcm_bluray : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pbm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        pam : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        opus : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        nuv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        notchlc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mxpeg : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mwsc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mvha : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mvdv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mvc2 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mvc1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mv30 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mts2 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mszh : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mss2 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mss1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        msrle : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        msmpeg4v3 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        msmpeg4v2 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        msmpeg4v1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mscc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        msa1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mpeg4 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mpeg2video : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mpeg1video : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mp3 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mp2 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mp1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        motionpixels : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mlp : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mjpegb : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mjpeg : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mimic : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        metasound : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mdec : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mad : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mace6 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        mace3 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        m101 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        lscr : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        loco : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        lagarith : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        kmvc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        kgv1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        jv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        jpeg2000 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        interplayvideo : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        interplayacm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        imm5 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        imm4 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        imc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        ilbc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        iff_ilbm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        iac : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        hymt : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        hqx : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        hq_hqa : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        hnm4video : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        hevc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        hcom : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        hca : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        hap : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        h264 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        h263p : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        h263i : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        h263 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        h261 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        gsm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        gif : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        gdv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        g729 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        g723_1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        g2m : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        frwu : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        fraps : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        fmvc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        flv1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        flic : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        flashsv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        flac : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        fits : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        fic : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        ffv1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        exr : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        evrc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        escape130 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        escape124 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        eac3 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        dxv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        dxtory : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        dxa : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        dts : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        dst : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        dss_sp : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        dsicinvideo : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        dsd_msbf_planar : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        dsd_lsbf_planar : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        dpx : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        dfa : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        dds : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        cyuv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        cscd : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        cpia : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        cook : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        comfortnoise : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        cmv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        cllc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        cljr : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        cfhd : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        cdxl : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        cavs : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        c93 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        brender_pix : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        bmv_video : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        bmv_audio : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        bmp : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        bitpacked : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        binkvideo : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        binkaudio_dct : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        bfi : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        bethsoftvid : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        ayuv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        avui : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        avs : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        avrp : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        avrn : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        avc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        av1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        aura2 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        aura : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        atrac9 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        atrac3al : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        atrac3 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        atrac1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        asv2 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        asv1 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        arbc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        aptx : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        apng : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        ape : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        ansi : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        anm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        amv : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        amr_wb : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        amr_nb : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        alac : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        aic : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        agm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_yamaha : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_thp_le : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_thp : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_swf : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_psx : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_ima_ws : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_ima_smjpeg : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_ima_qt : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_ima_ea_sead : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_ima_ea_eacs : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_g726le : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_ea_xas : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_dtk : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_agm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_afc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_adx : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        adpcm_4xm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        acelpkelvin : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        ac3 : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        aasc : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        aac : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        _4xm : (() -> string?)
        .{
          available : (() -> [string])
          .{
            set : ([string]) -> unit,
            comments : string,
            description : string
          },
          set : (string) -> unit,
          comments : string,
          description : string
        },
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    decoders : (() -> [string])
    .{
      set : ([string]) -> unit,
      comments : string,
      description : string
    },
    debug : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  console : 
  {
    colorize : (() -> string)
    .{
      set : (string) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  clock : 
  {
    log_delay : (() -> float)
    .{
      set : (float) -> unit,
      comments : string,
      description : string
    },
    allow_streaming_errors : (() -> bool)
    .{
      set : (bool) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  audio : 
  {
    converter : 
    {
      samplerate : 
      {
        native : 
        {
          quality : (() -> string)
          .{
            set : (string) -> unit,
            comments : string,
            description : string
          },
          comments : string,
          description : string
        },
        libsamplerate : 
        {
          quality : (() -> string)
          .{
            set : (string) -> unit,
            comments : string,
            description : string
          },
          comments : string,
          description : string
        },
        converters : (() -> [string])
        .{
          set : ([string]) -> unit,
          comments : string,
          description : string
        },
        comments : string,
        description : string
      },
      channel_layout : 
      {
        converters : (() -> [string])
        .{
          set : ([string]) -> unit,
          comments : string,
          description : string
        },
        comments : string,
        description : string
      },
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  alsa : 
  {
    periods : (() -> int)
    .{
      set : (int) -> unit,
      comments : string,
      description : string
    },
    buffer_length : (() -> int)
    .{
      set : (int) -> unit,
      comments : string,
      description : string
    },
    alsa_buffer : (() -> int)
    .{
      set : (int) -> unit,
      comments : string,
      description : string
    },
    comments : string,
    description : string
  },
  comments : string,
  description : string
}

Arguments:

snd

Get the second component of a pair.

Type:

(('a * 'b)) -> 'b

Arguments:

• (unlabeled) (of type 'a * 'b)

source.dump

Immediately encode the whole contents of a source into a file.

Type:

(format('a), string, source('b)) -> unit

Arguments:

• (unlabeled) (of type format('a)): Encoding format.
• (unlabeled) (of type string): Name of the file.
• (unlabeled) (of type source('b)): Source to encode

This function is experimental.

source.duration

Estimation of the duration in the current track.

Type:

(source('a)) -> float

Arguments:

• (unlabeled) (of type source('a))

source.elapsed

Elapsed time in the current track.

Type:

(source('a)) -> float

Arguments:

• (unlabeled) (of type source('a))

source.fallible

Indicate if a source may fail, i.e. may not be ready to stream.

Type:

(source('a)) -> bool

Arguments:

• (unlabeled) (of type source('a))

source.id

Get the identifier of a source.

Type:

(source('a)) -> string

Arguments:

• (unlabeled) (of type source('a))

source.init

Simultaneously initialize sources, return the sublist of sources that failed to initialize.

Type:

([source(audio='a, video='b, midi='c)]) ->
[source(audio='a, video='b, midi='c)]

Arguments:

• (unlabeled) (of type [source(audio='a, video='b, midi='c)])

This function is experimental.

source.is_ready

Indicate if a source is ready to stream (we also say that it is available), or currently streaming.

Type:

(source('a)) -> bool

Arguments:

• (unlabeled) (of type source('a))

source.on_metadata

Call a given handler on metadata packets.

Type:

(source('a), (([string * string]) -> unit)) -> unit

Arguments:

• (unlabeled) (of type source('a))
• (unlabeled) (of type ([string * string]) -> unit)

source.on_track

Call a given handler on new tracks.

Type:

(source('a), (([string * string]) -> unit)) -> unit

Arguments:

• (unlabeled) (of type source('a))
• (unlabeled) (of type ([string * string]) -> unit)

source.remaining

Estimation of remaining time in the current track.

Type:

(source('a)) -> float

Arguments:

• (unlabeled) (of type source('a))

source.seek

Seek forward, in seconds. Returns the amount of time effectively seeked.

Type:

(source('a), float) -> float

Arguments:

• (unlabeled) (of type source('a))
• (unlabeled) (of type float)

source.set_name

Set the name of an operator.

Type:

(source('a), string) -> unit

Arguments:

• (unlabeled) (of type source('a))
• (unlabeled) (of type string)

source.shutdown

Deactivate a source.

Type:

(source('a)) -> unit

Arguments:

• (unlabeled) (of type source('a))

source.skip

Skip to the next track.

Type:

(source('a)) -> unit

Arguments:

• (unlabeled) (of type source('a))

source.time

Get a source’s time, based on its assigned clock

Type:

(source('a)) -> float

Arguments:

• (unlabeled) (of type source('a))

thread.mutexify

Protect functions with a mutex in order to avoid concurrent calls. It returns the original value when the argument is not a function.

Type:

('a) -> 'a

Arguments:

• (unlabeled) (of type 'a)

thread.on_error

Register the function to be called when an error of the given kind is raised in a thread. Catches all errors if first argument is null.

Type:

(error?,
 ((backtrace : string, thread_name : string, error) ->
  unit)) -> unit

Arguments:

• (unlabeled) (of type error?)
• (unlabeled) (of type (backtrace : string, thread_name : string, error) -> unit)

thread.run.recurrent

Run a recurrent function in a separate thread.

Type:

(?fast : bool, ?delay : float, (() -> float)) -> unit

Arguments:

• fast (of type bool, which defaults to true): Whether the thread is supposed to return quickly or not. Typically, blocking tasks (e.g. fetching data over the internet) should not be considered to be fast. When set to false its priority will be lowered 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.
• delay (of type float, which defaults to 0.): Delay (in sec.) after which the thread should be launched.
• (unlabeled) (of type () -> float): Function to execute recurrently. The returned value is the delay (in sec.) in which the function should be run again (it won’t be run if the value is strictly negative).

while

A while loop.

Type:

({bool}, (() -> unit)) -> unit

Arguments:

• (unlabeled) (of type {bool}): Condition guarding the loop.
• (unlabeled) (of type () -> unit): Function to execute.

List

_[_]

l[k] returns the first v such that (k,v) is in the list l (or “” if no such v exists).

Type:

(['a * string], 'a) -> string
where 'a is an orderable type

Arguments:

• (unlabeled) (of type ['a * string] where 'a is an orderable type)
• (unlabeled) (of type anything that is an orderable type)

list.add

Add an element at the top of a list.

Type:

('a, ['a]) -> ['a]

Arguments:

• (unlabeled) (of type 'a)
• (unlabeled) (of type ['a])

list.append

Concatenate two lists.

Type:

(['a], ['a]) -> ['a]

Arguments:

• (unlabeled) (of type ['a])
• (unlabeled) (of type ['a])

list.assoc

Associate a value to a key in an association list. This functions raises error.not_found if no default value is specified.

Type:

(?default : 'a?, 'b, ['b * 'a]) -> 'a
where 'b is an orderable type

Arguments:

• default (of type 'a?, which defaults to null): Value returned if the key is not found.
• (unlabeled) (of type anything that is an orderable type)
• (unlabeled) (of type ['b * 'a] where 'b is an orderable type)

list.assoc.filter

Keep only the elements of an association list satisfying a given predicate.

Type:

((('a, 'b) -> bool), ['a * 'b]) -> ['a * 'b]

Arguments:

• (unlabeled) (of type ('a, 'b) -> bool)
• (unlabeled) (of type ['a * 'b])

list.assoc.mem

list.assoc.mem(key,l) returns true if l contains a pair (key,value).

Type:

('a, ['a * 'c]) -> bool where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type): Key to look for
• (unlabeled) (of type ['a * 'c] where 'a is an orderable type): List of pairs (key,value)

list.assoc.remove

Remove the first pair from an associative list.

Type:

('a, ['a * 'c]) -> ['a * 'c]
where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type): Key of pair to be removed.
• (unlabeled) (of type ['a * 'c] where 'a is an orderable type): List of pairs (key,value).

list.assoc.remove.all

Remove all pairs with given key from an associative list.

Type:

('a, ['a * 'c]) -> ['a * 'c]
where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type): Key of pairs to be removed.
• (unlabeled) (of type ['a * 'c] where 'a is an orderable type): List of pairs (key,value).

list.case

Define a function by case analysis, depending on whether a list is empty or not.

Type:

(['a], 'b, (('a, ['a]) -> 'b)) -> 'b

Arguments:

• (unlabeled) (of type ['a]): List to perform case analysis on.
• (unlabeled) (of type 'b): Result when the list is empty.
• (unlabeled) (of type ('a, ['a]) -> 'b): Result when the list is non-empty.

list.cons

Add an element at the top of a list.

Type:

('a, ['a]) -> ['a]

Arguments:

• (unlabeled) (of type 'a)
• (unlabeled) (of type ['a])

list.dcase

“Delayed” version of list.case where the value on empty list is only evaluated if necessary.

Type:

(['a], (() -> 'b), (('a, ['a]) -> 'b)) -> 'b

Arguments:

• (unlabeled) (of type ['a])
• (unlabeled) (of type () -> 'b)
• (unlabeled) (of type ('a, ['a]) -> 'b)

list.exists

Check that a predicate is satisfied for some element in a list.

Type:

((('a) -> bool), ['a]) -> bool

Arguments:

• (unlabeled) (of type ('a) -> bool): Predicate.
• (unlabeled) (of type ['a]): List.

list.filter

Filter a list according to a predicate. The order in which elements are handled is not specified (and is currently implemented from the right).

Type:

(?remove : (('a) -> unit), (('a) -> bool), ['a]) -> ['a]

Arguments:

• remove (of type ('a) -> unit, which defaults to <fun>): Function called on an element when it is removed.
• (unlabeled) (of type ('a) -> bool): Predicate indicating whether an element should be kept or not.
• (unlabeled) (of type ['a]): List to filter.

list.find

First element satisfying a predicate. Raises error.not_found if not element is found and no default value was specified.

Type:

(?default : 'a?, (('a) -> bool), ['a]) -> 'a

Arguments:

• default (of type 'a?, which defaults to null): Returned value when the predicate is not found.
• (unlabeled) (of type ('a) -> bool): Predicate.
• (unlabeled) (of type ['a]): List.

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

Type:

((('a, 'b) -> 'a), 'a, ['b]) -> 'a

Arguments:

• (unlabeled) (of type ('a, 'b) -> 'a): 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.
• (unlabeled) (of type 'a): Initial value x1, to be updated by successive calls of f(x,e).
• (unlabeled) (of type ['b])

list.fold.right

Fold a function on every element of a list. Similar to list.fold but iterates from the right of the list. It is slightly more efficient than list.fold.

Type:

((('a, 'b) -> 'b), 'b, ['a]) -> 'b

Arguments:

• (unlabeled) (of type ('a, 'b) -> 'b): 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.
• (unlabeled) (of type 'b): Initial value x1, to be updated by successive calls of f(x,e).
• (unlabeled) (of type ['a])

list.for_all

Check that a predicate is satisfied for every element in a list.

Type:

((('a) -> bool), ['a]) -> bool

Arguments:

• (unlabeled) (of type ('a) -> bool): Predicate.
• (unlabeled) (of type ['a]): List.

list.hd

Return the head (first element) of a list, or default if the list is empty.

Type:

(?default : 'a?, ['a]) -> 'a

Arguments:

• default (of type 'a?, which defaults to null): Default value if key does not exist.
• (unlabeled) (of type ['a])

list.ind

Define a function by induction on a list. This is slightly more efficient than defining a recursive function. The list is scanned from the right.

Type:

(['a], 'b, (('a, ['a], 'b) -> 'b)) -> 'b

Arguments:

• (unlabeled) (of type ['a]): List to perform induction on.
• (unlabeled) (of type 'b): Result when the list is empty.
• (unlabeled) (of type ('a, ['a], 'b) -> 'b): Result when the list is non-empty, given the current element, the tail and the result of the recursive call on the tail.

list.index

First index where a predicate is satisfied.

Type:

((('a) -> bool), ['a]) -> int

Arguments:

• (unlabeled) (of type ('a) -> bool): Predicate.
• (unlabeled) (of type ['a]): List.

list.indexed

Add indices to every element of a list, so that it can be accessed with the notation l[n].

Type:

(['a]) -> [int * 'a]

Arguments:

• (unlabeled) (of type ['a])

list.init

Initialize a list.

Type:

(int, ((int) -> 'a)) -> ['a]

Arguments:

• (unlabeled) (of type int): Number of elements in the list.
• (unlabeled) (of type (int) -> 'a): Function such that f i is the ith element.

list.insert

Returns a copy of the given list with a new element inserted at a given position. Raises error.not_found if the list has less than index elements.

Type:

(int, 'a, ['a]) -> ['a]

Arguments:

• (unlabeled) (of type int): Index to insert at, starting at 0.
• (unlabeled) (of type 'a): Element to insert
• (unlabeled) (of type ['a]): List to insert into.

list.is_empty

Determining whether a list is empty or not.

Type:

(['a]) -> bool

Arguments:

• (unlabeled) (of type ['a])

list.iter

Call a function on every element of a list.

Type:

((('a) -> unit), ['a]) -> unit

Arguments:

• (unlabeled) (of type ('a) -> unit)
• (unlabeled) (of type ['a])

list.iterator

Create an iterator over the elements of a list.

Type:

(['a?]) -> () -> 'a?

Arguments:

• (unlabeled) (of type ['a?])

list.iteri

Call a function on every element of a list, along with its index

Type:

(((int, 'a) -> unit), ['a]) -> unit

Arguments:

• (unlabeled) (of type (int, 'a) -> unit)
• (unlabeled) (of type ['a])

list.last

Return the last element of a list.

Type:

(?default : 'a?, ['a]) -> 'a

Arguments:

• default (of type 'a?, which defaults to null)
• (unlabeled) (of type ['a])

list.length

Compute the length of a list, i.e., the number of its elements.

Type:

(['a]) -> int

Arguments:

• (unlabeled) (of type ['a])

list.map

Map a function on every element of a list.

Type:

((('a) -> 'b), ['a]) -> ['b]

Arguments:

• (unlabeled) (of type ('a) -> 'b)
• (unlabeled) (of type ['a])

list.mapi

Map a function on every element of a list, along with its index.

Type:

(((int, 'a) -> 'b), ['a]) -> ['b]

Arguments:

• (unlabeled) (of type (int, 'a) -> 'b)
• (unlabeled) (of type ['a])

list.mem

Check whether an element belongs to a list.

Type:

('a, ['a]) -> bool where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type)
• (unlabeled) (of type ['a] where 'a is an orderable type)

list.mem_assoc

Check whether an element belongs to an associative list.

Type:

('a, ['a * 'c]) -> bool where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type)
• (unlabeled) (of type ['a * 'c] where 'a is an orderable type)

list.nth

Get the n-th element of a list (the first element is at position 0), or default if element does not exist.

Type:

(?default : 'a?, ['a], int) -> 'a

Arguments:

• default (of type 'a?, which defaults to null)
• (unlabeled) (of type ['a])
• (unlabeled) (of type int)

list.pick

Pick a random element in a list.

Type:

(?default : 'a?, ['a]) -> 'a

Arguments:

• default (of type 'a?, which defaults to null): Value returned if the list is empty.
• (unlabeled) (of type ['a]): List in which the element should be picked.

list.prefix

Compute the beginning of a list.

Type:

(int, ['a]) -> ['a]

Arguments:

• (unlabeled) (of type int): Number of elements in the returned list.
• (unlabeled) (of type ['a]): List whose prefix should be taken.

list.randomize

Shuffle the content of a list.

Type:

(['a]) -> ['a]

Arguments:

• (unlabeled) (of type ['a])

list.remove

Remove the first occurrence of a value from a list.

Type:

('a, ['a]) -> ['a] where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type)
• (unlabeled) (of type ['a] where 'a is an orderable type)

list.rev

Revert list order.

Type:

(['a]) -> ['a]

Arguments:

• (unlabeled) (of type ['a])

list.shuffle

Create a list with the same elements as another, but in a random order.

Type:

(['a]) -> ['a]

Arguments:

• (unlabeled) (of type ['a]): List of which the elements should be shuffled.

list.sort

Sort a list according to a comparison function.

Type:

((('a, 'a) -> int), ['a]) -> ['a]

Arguments:

• (unlabeled) (of type ('a, 'a) -> int): Comparison function f such that f(x,y)<0 when x<y, f(x,y)=0 when x=y, and f(x,y)>0 when x>y.
• (unlabeled) (of type ['a]): List to sort.

list.tl

Return the list without its first element.

Type:

(['a]) -> ['a]

Arguments:

• (unlabeled) (of type ['a])

null.find

Find the first element of a list for which the image of the function is not null. Raises error.not_found if not element is found and no default value was specified.

Type:

(?default : 'a??, (('b) -> 'a?), ['b]) -> 'a?

Arguments:

• default (of type 'a??, which defaults to null): Returned value when no element is found.
• (unlabeled) (of type ('b) -> 'a?): Function.
• (unlabeled) (of type ['b]): List.

Math

*

Multiplication of numbers.

Type:

('a, 'a) -> 'a where 'a is a number type

Arguments:

• (unlabeled) (of type anything that is a number type)
• (unlabeled) (of type anything that is a number type)

+

Addition of numbers.

Type:

('a, 'a) -> 'a where 'a is a number type

Arguments:

• (unlabeled) (of type anything that is a number type)
• (unlabeled) (of type anything that is a number type)

-

Subtraction of numbers.

Type:

('a, 'a) -> 'a where 'a is a number type

Arguments:

• (unlabeled) (of type anything that is a number type)
• (unlabeled) (of type anything that is a number type)

/

Division of numbers.

Type:

('a, 'a) -> 'a where 'a is a number type

Arguments:

• (unlabeled) (of type anything that is a number type)
• (unlabeled) (of type anything that is a number type)

abs

Absolute value.

Type:

('a) -> 'a where 'a is a number type

Arguments:

• (unlabeled) (of type anything that is a number type)

acos

Arc cosine. The argument must fall within the range [-1.0, 1.0]. Result is in radians and is between 0.0 and pi.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

asin

Arc sine. The argument must fall within the range [-1.0, 1.0]. Result is in radians and is between -pi/2 and pi/2.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

atan

Arc tangent. Result is in radians and is between -pi/2 and pi/2.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

bool_of_float

Convert a float to a bool.

Type:

(float) -> bool

Arguments:

• (unlabeled) (of type float)

bool_of_int

Convert an int to a bool.

Type:

(int) -> bool

Arguments:

• (unlabeled) (of type int)

cos

Cosine. Argument is in radians.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

cosh

Hyperbolic cosine. Argument is in radians.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

dB_of_lin

Convert linear scale into decibels.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

exp

Exponential.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

float

Convert a number to a float.

Type:

('a) -> float where 'a is a number type

Arguments:

• (unlabeled) (of type anything that is a number type)

float_of_int

Convert an int to a float.

Type:

(int) -> float

Arguments:

• (unlabeled) (of type int)

infinity

Float representation of infinity.

Type:

float

Arguments:

int

Convert a number to an integer.

Type:

('a) -> int where 'a is a number type

Arguments:

• (unlabeled) (of type anything that is a number type)

int_of_float

Convert a float to a int.

Type:

(float) -> int

Arguments:

• (unlabeled) (of type float)

lin_of_dB

Convert decibels into linear scale.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

ln

Natural logarithm.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

log10

Base 10 logarithm.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

lsl

Logical shift left.

Type:

(int, int) -> int

Arguments:

• (unlabeled) (of type int): Number to shift.
• (unlabeled) (of type int): Number of bits to shift.

lsr

Logical shift right.

Type:

(int, int) -> int

Arguments:

• (unlabeled) (of type int): Number to shift.
• (unlabeled) (of type int): Number of bits to shift.

max

Compute the maximum of two values.

Type:

('a, 'a) -> 'a where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type)
• (unlabeled) (of type anything that is an orderable type)

max_int

Maximal representable integer.

Type:

int

Arguments:

min

Compute the minimum of two values.

Type:

('a, 'a) -> 'a where 'a is an orderable type

Arguments:

• (unlabeled) (of type anything that is an orderable type)
• (unlabeled) (of type anything that is an orderable type)

min_int

Minimal representable integer.

Type:

int

Arguments:

mkfade

Make a fade function based on a source’s clock.

Type:

(?type : string, ?start : float, ?stop : float,
 ?duration : float, ?on_done : (() -> unit), source('a)) ->
() -> float

Arguments:

• type (of type string, which defaults to "lin"): Fade shape. One of: “sin”, “exp”, “log”, “lin”
• start (of type float, which defaults to 0.): Start value.
• stop (of type float, which defaults to 1.): Stop value.
• duration (of type float, which defaults to 3.): Duration in seconds.
• on_done (of type () -> unit, which defaults to <fun>): Function to execute when the fade is finished
• (unlabeled) (of type source('a))

mod

Remainder of division of numbers.

Type:

('a, 'a) -> 'a where 'a is a number type

Arguments:

• (unlabeled) (of type anything that is a number type)
• (unlabeled) (of type anything that is a number type)

nan

A special floating-point value denoting the result of an undefined operation such as 0.0 /. 0.0. Stands for ‘not a number’. Any floating-point operation with nan as argument returns nan as result. As for floating-point comparisons, ==, <, <=, > and >= return false and != returns true if one or both of their arguments is nan.

Type:

float

Arguments:

pow

Exponentiation of numbers.

Type:

('a, 'a) -> 'a where 'a is a number type

Arguments:

• (unlabeled) (of type anything that is a number type)
• (unlabeled) (of type anything that is a number type)

random.float

Generate a random value between min (included) and max (excluded).

Type:

(?min : float, ?max : float) -> float

Arguments:

• min (of type float, which defaults to 0.)
• max (of type float, which defaults to 1.)

random.int

Generate a random value between min (included) and max (excluded).

Type:

(?min : int, ?max : int) -> int

Arguments:

• min (of type int, which defaults to -536870911)
• max (of type int, which defaults to 536870912)

sin

Sine. Argument is in radians.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

sinh

Hyperbolic sine. Argument is in radians.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

sqrt

Square root.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

tan

Tangent. Argument is in radians.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

tanh

Hyperbolic tangent. Argument is in radians.

Type:

(float) -> float

Arguments:

• (unlabeled) (of type float)

~-

Returns the opposite of its argument.

Type:

('a) -> 'a where 'a is a number type

Arguments:

• (unlabeled) (of type anything that is a number type)

Output

output

Output a stream using the default operator. The input source does not need to be infallible, blank will just be played during failures.

Type:

(?id : string?, ?fallible : bool,
 ?on_start : (() -> unit), ?on_stop : (() -> unit),
 ?start : bool, source(audio=pcm(?A), video=none,
 midi=?B)) -> unit

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• fallible (of type bool, which defaults to true): Allow the child source to fail, in which case the output will be (temporarily) stopped.
• on_start (of type () -> unit, which defaults to <fun>): Callback executed when outputting starts.
• on_stop (of type () -> unit, which defaults to <fun>): Callback executed when outputting stops.
• start (of type bool, which defaults to true): 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.
• (unlabeled) (of type source(audio=pcm(?A), video=none, midi=?B)): Source to play.

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_started (of type () -> bool): true if the output or source is started.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• start (of type () -> unit): Ask the source or output to start.
• stop (of type () -> unit): Ask the source or output to stop.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

output.audio_video

Output a stream with audio and video using the default operator. The input source does not need to be infallible, blank will just be played during failures.

Type:

(?id : string?, ?fallible : bool,
 ?on_start : (() -> unit), ?on_stop : (() -> unit),
 ?start : bool, source(audio=pcm(?A), video=yuva420p('a),
 midi=?B)) -> unit

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• fallible (of type bool, which defaults to true): Allow the child source to fail, in which case the output will be (temporarily) stopped.
• on_start (of type () -> unit, which defaults to <fun>): Callback executed when outputting starts.
• on_stop (of type () -> unit, which defaults to <fun>): Callback executed when outputting stops.
• start (of type bool, which defaults to true): 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.
• (unlabeled) (of type source(audio=pcm(?A), video=yuva420p('a), midi=?B)): Source to play.

output.video

Output a video stream using the default operator. The input source does not need to be infallible, blank will just be played during failures.

Type:

(?id : string?, ?fallible : bool,
 ?on_start : (() -> unit), ?on_stop : (() -> unit),
 ?start : bool, source(audio='a, video=yuva420p('b),
 midi='c)) -> unit

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• fallible (of type bool, which defaults to true): Allow the child source to fail, in which case the output will be (temporarily) stopped.
• on_start (of type () -> unit, which defaults to <fun>): Callback executed when outputting starts.
• on_stop (of type () -> unit, which defaults to <fun>): Callback executed when outputting stops.
• start (of type bool, which defaults to true): 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.
• (unlabeled) (of type source(audio='a, video=yuva420p('b), midi='c)): Source to play.

Source / Audio Processing

add

Mix sources, with optional normalization. Only relay metadata from the first source that is effectively summed.

Type:

(?id : string?, ?normalize : {bool}, ?power : {bool},
 ?weights : [{float}],
 [source(audio=internal('a), video=internal('b),
  midi=internal('c))]) -> source(audio=internal('a),
video=internal('b), midi=internal('c))

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• normalize (of type {bool}, which defaults to true): Divide by the sum of weights of ready sources (or by the number of ready sources if weights are not specified).
• power (of type {bool}, which defaults to false): Perform constant-power normalization.
• weights (of type [{float}], which defaults to []): Relative weight of the sources in the sum. The empty list stands for the homogeneous distribution. These are used as amplification coefficients if we are not normalizing.
• (unlabeled) (of type [source(audio=internal('a), video=internal('b), midi=internal('c))])

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

amplify

Multiply the amplitude of the signal.

Type:

(?id : string?, ?override : string?, {float},
 source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• override (of type string?, which defaults to "liq_amplify"): 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).
• (unlabeled) (of type {float}): Multiplicative factor.
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

audio.map

Map a function to all audio samples. This is SLOW!

Type:

(?id : string?, ((float) -> float), source(audio='a,
 video='b, midi='c)) -> source(audio='a, video='b,
midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type (float) -> float)
• (unlabeled) (of type source(audio='a, video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

This function is experimental.

clip

Clip samples, i.e. ensure that all values are between -1 and 1: values lower than -1 become -1 and values higher than 1 become 1.

Type:

(?id : string?, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

comb

Comb filter.

Type:

(?id : string?, ?delay : float, ?feedback : {float},
 source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• delay (of type float, which defaults to 0.001): Delay in seconds.
• feedback (of type {float}, which defaults to -6.): Feedback coefficient in dB.
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

compand

Compand the signal.

Type:

(?id : string?, ?mu : float, source(audio=pcm('a),
 video='b, midi='c)) -> source(audio=pcm('a), video='b,
midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• mu (of type float, which defaults to 1.)
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

compress

Compress the signal.

Type:

(?id : string?, ?attack : {float}, ?gain : {float},
 ?knee : {float}, ?lookahead : {float},
 ?pre_gain : {float}, ?ratio : {float},
 ?release : {float}, ?threshold : {float},
 ?track_sensitive : bool, ?wet : {float},
 ?window : {float}, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('a), video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• attack (of type {float}, which defaults to 50.): Attack time (ms).
• gain (of type {float}, which defaults to 0.): Post-amplification (dB).
• knee (of type {float}, which defaults to 1.): Knee width (dB).
• lookahead (of type {float}, which defaults to 0.): Lookahead (ms).
• pre_gain (of type {float}, which defaults to 0.): Pre-amplification (dB).
• ratio (of type {float}, which defaults to 2.): Gain reduction ratio (reduction is ratio:1).
• release (of type {float}, which defaults to 400.): Release time (ms).
• threshold (of type {float}, which defaults to -10.): Threshold level (dB).
• track_sensitive (of type bool, which defaults to false): Reset on every track.
• wet (of type {float}, which defaults to 1.): How much of input sound to output (between 0 and 1, 0 means only original sound, 1 means only compressed sound).
• window (of type {float}, which defaults to 0.): RMS window length (second). 0. means peak mode.
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• gain (of type () -> float): Gain (dB).
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• rms (of type () -> float): RMS or peak power (linear).
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

compress.exponential

Exponential compressor.

Type:

(?id : string?, ?mu : float, source(audio=pcm('a),
 video='b, midi='c)) -> source(audio=pcm('a), video='b,
midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• mu (of type float, which defaults to 2.): Exponential compression factor, typically greater than 1.
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

compress.old

Compress the signal.

Type:

(?id : string?, ?attack : {float}, ?gain : {float},
 ?knee : {float}, ?ratio : {float}, ?release : {float},
 ?threshold : {float}, ?window : float,
 source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• attack (of type {float}, which defaults to 100.): Attack time (ms).
• gain (of type {float}, which defaults to 0.): Additional gain (dB).
• knee (of type {float}, which defaults to 1.): Knee radius (dB).
• ratio (of type {float}, which defaults to 2.): Gain reduction ratio (n:1).
• release (of type {float}, which defaults to 400.): Release time (ms).
• threshold (of type {float}, which defaults to -10.): Threshold level (dB).
• window (of type float, which defaults to 0.1): Window for computing RMS (in sec).
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

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.

Type:

(?id : string?, ?active : bool, ?conservative : bool,
 ?duration : {float}, ?minimum : float,
 ?override_duration : string, ?width : float,
 ((
   {
     metadata : [string * string],
     db_level : float,
     source : source(audio=pcm('a),
     video='b,
     midi='c)
   }, 
   {
     metadata : [string * string],
     db_level : float,
     source : source(audio=pcm('a),
     video='b,
     midi='c)
   }) -> source(audio=pcm('a), video='b, midi='c)),
 source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• active (of type bool, which defaults to false): 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.
• conservative (of type bool, which defaults to true): Do not trust remaining time estimations, always buffering data in advance. This avoids being tricked by skips, either manual or caused by blank.skip().
• duration (of type {float}, which defaults to 5.): Duration (in seconds) of buffered data from each track that is used to compute the transition between tracks.
• minimum (of type float, which defaults to -1.): 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 a negative default, transitions always occur.
• override_duration (of type string, which defaults to "liq_cross_duration"): Metadata field which, if present and containing a float, overrides the ‘duration’ parameter for current track.
• width (of type float, which defaults to 2.): Width of the power computation window.
• (unlabeled) (of type ( { metadata : [string * string], db_level : float, source : source(audio=pcm('a), video='b, midi='c) }, { metadata : [string * string], db_level : float, source : source(audio=pcm('a), video='b, midi='c) }) -> source(audio=pcm('a), video='b, midi='c)): Transition function, composing from the end of a track and the next track. The sources corresponding to the two tracks are decorated with fields indicating the power of the signal before and after the transition (power), and the metadata (metadata).
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

delay_line

Delay the audio signal by a given amount of time.

Type:

(?id : string?, {float}, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('a), video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• (unlabeled) (of type {float}): Duration of the delay in seconds.
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

dtmf.detect

Detect DTMF tones.

Type:

(?id : string?, ?bands : int, ?debug : {bool},
 ?duration : {float}, ?smoothing : {float},
 ?threshold : {float}, source(audio=pcm('a), video='b,
 midi='c), ((string) -> unit)) -> source(audio=pcm('a),
video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• bands (of type int, which defaults to 1024): Number of frequency bands.
• debug (of type {bool}, which defaults to false): Show internal values on standard output in order to fine-tune parameters: band number, band frequency, detected intensity and smoothed intensity.
• duration (of type {float}, which defaults to 0.05): Duration for detecting a tone.
• smoothing (of type {float}, which defaults to 0.01): Smoothing time (in seconds) for band indensity (the higher, the less sensitive we are to local variations, but the more time we take to detect a band).
• threshold (of type {float}, which defaults to 50.): Threshold for detecting a band.
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c)): Source on which DTMF tones should be detected.
• (unlabeled) (of type (string) -> unit): Function called with detected key as argument.

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

echo

Add echo.

Type:

(?id : string?, ?delay : {float}, ?feedback : {float},
 ?ping_pong : bool, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('a), video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• delay (of type {float}, which defaults to 0.5): Delay in seconds.
• feedback (of type {float}, which defaults to -6.): Feedback coefficient in dB (negative).
• ping_pong (of type bool, which defaults to false): Use ping-pong delay.
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

ffmpeg.filter.audio.output

Return an audio source from a filter’s output

Type:

(?id : string?, ?buffer : float, ?pass_metadata : bool,
 ffmpeg.filter.graph, ffmpeg.filter.audio) ->
source(audio=ffmpeg.audio.raw('a), video=none, midi=none)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• buffer (of type float, which defaults to 0.1): Duration of the pre-buffered data.
• pass_metadata (of type bool, which defaults to true): Pass ffmpeg stream metadata to liquidsoap
• (unlabeled) (of type ffmpeg.filter.graph)
• (unlabeled) (of type ffmpeg.filter.audio)

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter

Perform several kinds of filtering on the signal. Only frequencies below the sampling rate / 4 (generally 10 kHz) are handled well for the freq parameter.

Type:

(?id : string?, freq : {float}, mode : string,
 ?q : {float}, ?wetness : {float}, source(audio=pcm('a),
 video='b, midi='c)) -> source(audio=pcm('a), video='b,
midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• freq (of type {float}): Characteristic frequency of the filter.
• mode (of type string): 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).
• q (of type {float}, which defaults to 1.)
• wetness (of type {float}, which defaults to 1.): How much of the original signal should be added (1. means only filtered and 0. means only original signal).
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter.fir

Low-pass FIR filter.

Type:

(?id : string?, beta : float, ?coeffs : int,
 frequency : float, source(audio=pcm('a), video='b,
 midi='c)) -> source(audio=pcm('a), video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• beta (of type float): Beta should range between 0 and 1.
• coeffs (of type int, which defaults to 255): Number of coefficients
• frequency (of type float): Corner frequency in Hz (frequency at which the response is 0.5, that is -6 dB).
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter.iir.butterworth.bandpass

IIR filter

Type:

(?id : string?, frequency1 : float, frequency2 : float,
 ?order : int, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• frequency1 (of type float): First corner frequency
• frequency2 (of type float): Second corner frequency
• order (of type int, which defaults to 4): Filter order
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter.iir.butterworth.bandstop

IIR filter

Type:

(?id : string?, frequency1 : float, frequency2 : float,
 ?order : int, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• frequency1 (of type float): First corner frequency
• frequency2 (of type float): Second corner frequency
• order (of type int, which defaults to 4): Filter order
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter.iir.butterworth.high

IIR filter

Type:

(?id : string?, frequency : float, ?order : int,
 source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• frequency (of type float): Corner frequency
• order (of type int, which defaults to 4): Filter order
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter.iir.butterworth.low

IIR filter

Type:

(?id : string?, frequency : float, ?order : int,
 source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• frequency (of type float): Corner frequency
• order (of type int, which defaults to 4): Filter order
• (unlabeled) (of type source(audio=pcm('a), video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter.iir.eq.allpass

All-pass biquad filter.

Type:

(?id : string?, ?bandwidth : {float},
 frequency : {float}, source(audio='a, video='b,
 midi='c)) -> source(audio='a, video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• bandwidth (of type {float}, which defaults to 0.333333333333): Bandwidth (in octaves)
• frequency (of type {float}): Center frequency
• (unlabeled) (of type source(audio='a, video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter.iir.eq.bandpass

Band-pass biquad filter.

Type:

(?id : string?, frequency : {float}, ?q : {float},
 source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• frequency (of type {float}): Center frequency
• q (of type {float}, which defaults to 1.): Q
• (unlabeled) (of type source(audio='a, video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter.iir.eq.high

High-pass biquad filter.

Type:

(?id : string?, frequency : {float}, ?q : {float},
 source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• frequency (of type {float}): Corner frequency
• q (of type {float}, which defaults to 1.): Q
• (unlabeled) (of type source(audio='a, video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter.iir.eq.highshelf

High shelf biquad filter.

Type:

(?id : string?, frequency : {float}, ?slope : {float},
 source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• frequency (of type {float}): Center frequency
• slope (of type {float}, which defaults to 1.): Shelf slope (in dB/octave)
• (unlabeled) (of type source(audio='a, video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter.iir.eq.low

Low-pass biquad filter.

Type:

(?id : string?, frequency : {float}, ?q : {float},
 source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• frequency (of type {float}): Corner frequency
• q (of type {float}, which defaults to 1.): Q
• (unlabeled) (of type source(audio='a, video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter.iir.eq.lowshelf

Low shelf biquad filter.

Type:

(?id : string?, frequency : {float}, ?slope : {float},
 source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• frequency (of type {float}): Corner frequency
• slope (of type {float}, which defaults to 1.): Shelf slope (dB/octave)
• (unlabeled) (of type source(audio='a, video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter.iir.eq.notch

Band-pass biquad filter.

Type:

(?id : string?, frequency : {float}, ?q : {float},
 source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• frequency (of type {float}): Center frequency
• q (of type {float}, which defaults to 1.): Q
• (unlabeled) (of type source(audio='a, video='b, midi='c))

Methods:

• duration (of type () -> float): Estimation of the duration of the current track.
• elapsed (of type () -> float): Elapsed time in the current track.
• fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• log (of type {level : (() -> int?).{set : ((int) -> unit)}}): Get or set the source’s log level, from 1 to 5.
• on_leave (of type ((() -> unit)) -> unit): Register a function to be called when source is not used anymore by another source.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controling its own real-time loop.
• shutdown (of type () -> unit): Deactivate a source.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source’s time, based on its assigned clock.

filter.iir.eq.peak

Peak EQ biquad filter.

Type:

(?id : string?, frequency : {float}, ?gain : {float},
 ?q : {float}, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)

Arguments:

• id (of type string?, which defaults to null): Force the value of the source ID.
• frequency (of type {float}): Center frequency
• gain (of type {float}, which defaults to 1.): Gain (in dB)
• q (of type {float}, which defaults to 1.): Q
• (unlabeled) (of type source(audio='a, video='b, midi='c))