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 typeArguments:
(unlabeled)(of typeanything that is an orderable type)(unlabeled)(of typeanything that is an orderable type)
<
Comparison of comparable values.
Type:
('a, 'a) -> bool where 'a is an orderable typeArguments:
(unlabeled)(of typeanything that is an orderable type)(unlabeled)(of typeanything that is an orderable type)
<=
Comparison of comparable values.
Type:
('a, 'a) -> bool where 'a is an orderable typeArguments:
(unlabeled)(of typeanything that is an orderable type)(unlabeled)(of typeanything that is an orderable type)
==
Comparison of comparable values.
Type:
('a, 'a) -> bool where 'a is an orderable typeArguments:
(unlabeled)(of typeanything that is an orderable type)(unlabeled)(of typeanything that is an orderable type)
>
Comparison of comparable values.
Type:
('a, 'a) -> bool where 'a is an orderable typeArguments:
(unlabeled)(of typeanything that is an orderable type)(unlabeled)(of typeanything that is an orderable type)
>=
Comparison of comparable values.
Type:
('a, 'a) -> bool where 'a is an orderable typeArguments:
(unlabeled)(of typeanything that is an orderable type)(unlabeled)(of typeanything that is an orderable type)
and
Return the conjunction of its arguments
Type:
({bool}, {bool}) -> boolArguments:
(unlabeled)(of type{bool})(unlabeled)(of type{bool})
not
Returns the negation of its argument.
Type:
(bool) -> boolArguments:
(unlabeled)(of typebool)
or
Return the disjunction of its arguments
Type:
({bool}, {bool}) -> boolArguments:
(unlabeled)(of type{bool})(unlabeled)(of type{bool})
random.bool
Generate a random boolean.
Type:
() -> boolArguments:
Control
ignore
Convert anything to unit, preventing warnings.
Type:
('a) -> unitArguments:
(unlabeled)(of type'a)
thread.run
Run a function in a separate thread.
Type:
(?fast : bool, ?delay : float, ?every : {float}?,
(() -> unit)) -> unitArguments:
fast(of typebool, which defaults totrue): 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 tofalseits 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 typefloat, which defaults to0.): Delay (in seconds) after which the thread should be launched.every(of type{float}?, which defaults tonull): How often (in seconds) the thread should be run. If negative ornull, run once.(unlabeled)(of type() -> unit): Function to execute.
File
file.contents
Read the whole contents of a file.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring)
file.digest
Return an MD5 digest for the given file.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring)
file.download
Download file using a regular http.get request. Returns
true on success.
Type:
(filename : string, ?timeout : float, string) -> boolArguments:
filename(of typestring): Downloaded filename.timeout(of typefloat, which defaults to5.): Timeout in seconds(unlabeled)(of typestring)
file.exists
Returns true if the file or directory exists.
Type:
(string) -> boolArguments:
(unlabeled)(of typestring)
file.extension
Returns a file’s extension.
Type:
(?dir_sep : string, ?leading_dot : bool, string) ->
stringArguments:
dir_sep(of typestring, which defaults to"/"): Directory separator.leading_dot(of typebool, which defaults totrue): Return extension with a leading dot, e.g..foo.(unlabeled)(of typestring)
file.getter
Getter to the contents of a file.
Type:
(string) -> () -> stringArguments:
(unlabeled)(of typestring): Name of the file from which the contents should be taken.
file.getter.float
Float getter from a file.
Type:
(?default : float, string) -> {float}Arguments:
default(of typefloat, which defaults to0.): Default value when the file contains invalid data.(unlabeled)(of typestring): Name of the file from which the contents should be taken.
file.is_directory
Returns true if the file exists and is a directory.
Type:
(string) -> boolArguments:
(unlabeled)(of typestring)
file.iterator
Iterate over the contents of a file.
Type:
(string) -> () -> string?Arguments:
(unlabeled)(of typestring)
file.lines
Get the list of lines of a file.
Type:
(string) -> [string]Arguments:
(unlabeled)(of typestring)
file.lines.iterator
Iterate over the lines of a file.
Type:
(string) -> () -> string?Arguments:
(unlabeled)(of typestring)
file.ls
List all the files in a directory.
Type:
(?absolute : bool, ?recursive : bool, ?pattern : string?,
string) -> [string]Arguments:
absolute(of typebool, which defaults tofalse): Whether to return absolute paths.recursive(of typebool, which defaults tofalse): Whether to look recursively in subdirectories.pattern(of typestring?, which defaults tonull): Pattern that the filenames should match (e.g."*.mp3").(unlabeled)(of typestring): Directory to look in.
file.metadata
Read metadata from a file.
Type:
(string) -> [string * string]Arguments:
(unlabeled)(of typestring): 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 typestring): 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 typestring): File from which the metadata should be read.
file.metadata.id3
Read metadata from a file using the id3 decoder.
Type:
(string) -> [string * string]Arguments:
(unlabeled)(of typestring): File from which the metadata should be read.
file.metadata.id3v1
Read metadata from a file using the id3v1 decoder.
Type:
(string) -> [string * string]Arguments:
(unlabeled)(of typestring): 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 typestring): File from which the metadata should be read.
file.metadata.imagemd
Read metadata from a file using the imagemd decoder.
Type:
(string) -> [string * string]Arguments:
(unlabeled)(of typestring): 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 typestring): 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 typestring): 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 typestring): File from which the metadata should be read.
file.metadata.videomd
Read metadata from a file using the videomd decoder.
Type:
(string) -> [string * string]Arguments:
(unlabeled)(of typestring): File from which the metadata should be read.
file.mime
Get the MIME type of a file, according to libmagic.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring)
file.mime_default
Alias of file.mime (because it is available)
Type:
(string) -> stringArguments:
(unlabeled)(of typestring)
file.mkdir
Create a directory.
Type:
(?perms : int, string) -> unitArguments:
perms(of typeint, which defaults to493): Default file rights if created (default is0o755).(unlabeled)(of typestring)
file.open
Open a file.
Type:
(?write : bool, ?create : bool?, ?append : bool,
?non_blocking : bool, ?perms : int, string) -> socketArguments:
write(of typebool, which defaults tofalse): Open file for writingcreate(of typebool?, which defaults tonull): Create if nonexistent. Default:falsein read-only mode,truewhen writing.append(of typebool, which defaults tofalse): Append data if file exists.non_blocking(of typebool, which defaults tofalse): Open in non-blocking mode.perms(of typeint, which defaults to420): Default file rights if created. Default:0o644(unlabeled)(of typestring)
Methods:
close(of type() -> unit): Close the socket.read(of type() -> string): Read data from a socket. Reading is done when the function returns an empty srring"".write(of type(string) -> unit): Write data to a socket
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) -> () -> stringArguments:
(unlabeled)(of typestring)
file.remove
Remove a file.
Type:
(string) -> unitArguments:
(unlabeled)(of typestring)
file.rmdir
Remove a directory and its content.
Type:
(string) -> unitArguments:
(unlabeled)(of typestring)
file.size
File size in bytes.
Type:
(string) -> intArguments:
(unlabeled)(of typestring)
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) -> stringArguments:
(unlabeled)(of typestring): File prefix(unlabeled)(of typestring): 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) -> stringArguments:
(unlabeled)(of typestring): Directory prefix(unlabeled)(of typestring): Directory suffix
file.watch
Call a function when a file is modified. Returns unwatch function in
unwatch method.
Type:
(string, (() -> unit)) -> unitArguments:
(unlabeled)(of typestring): 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 typestring)
file.write
Write data to a file.
Type:
(data : {string?}, ?perms : int, ?append : bool, string) ->
unitArguments:
data(of type{string?}): Data to write. If passing a callback() -> string?, the callback must returnnullor""when it has finished sending all its data.perms(of typeint, which defaults to420): Default file rights if created. Default:0o644.append(of typebool, which defaults tofalse): Append data if file exists.(unlabeled)(of typestring): Path to write to
file.write.stream
Stream data to a file. Returns a callback to write to the file.
Execute with null or "" to signify the end of
the writing operation.
Type:
(?perms : int, ?append : bool, string) ->
(string?) -> unitArguments:
perms(of typeint, which defaults to420): Default file rights if created. Default:0o644.append(of typebool, which defaults tofalse): Append data if file exists.(unlabeled)(of typestring): Path to write to
get_mime
Generic mime test. First try to use file.mime if it exist. Otherwise try to get the value using the file binary. Returns “” (empty string) if no value can be found.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring): The file to test
path.basename
Get the base name of a path.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring)
path.concat
Concatenate two paths, using the appropriate directory separator.
Type:
(string, string) -> stringArguments:
(unlabeled)(of typestring)(unlabeled)(of typestring)
path.dirname
Get the directory name of a path.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring)
path.home.unrelate
Expand path that start with ‘~’ with the current home directory.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring)
path.remove_extension
Remove the file extension from a path.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring)
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) -> stringArguments:
(unlabeled)(of typestring): APIC data.
Methods:
description(of typestring): Descriptionmime(of typestring): Mime typepicture_type(of typeint): 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.audioArguments:
pass_metadata(of typebool, which defaults totrue): Pass liquidsoap’s metadata to this stream(unlabeled)(of typeffmpeg.filter.graph)(unlabeled)(of typesource(audio=ffmpeg.audio.raw('a), video=none, midi=none))
ffmpeg.filter.create
Configure and launch a filter graph
Type:
(((ffmpeg.filter.graph) -> 'a)) -> 'aArguments:
(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.videoArguments:
pass_metadata(of typebool, which defaults tofalse): Pass liquidsoap’s metadata to this stream(unlabeled)(of typeffmpeg.filter.graph)(unlabeled)(of typesource(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 typestring?, which defaults tonull): Force the value of the source ID.start(of typebool, which defaults totrue): Automatically start outputting whenever possible. Iftrue, 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 typebool, which defaults tofalse): 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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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]) -> unitArguments:
user(of typestring)password(of typestring)host(of typestring, which defaults to"post.audioscrobbler.com"): Host for audioscrobbling submissions.port(of typeint, which defaults to80): Port for audioscrobbling submissions.length(of typebool, which defaults tofalse): 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]) -> unitArguments:
source(of typestring, 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 typestring)password(of typestring)host(of typestring, which defaults to"post.audioscrobbler.com"): Host for audioscrobbling submissions.port(of typeint, which defaults to80): Port for audioscrobbling submissions.length(of typebool, which defaults tofalse): 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 typestring, which defaults to"compress"): Id of the source. Variable names are prefixed with this.bands(of typeint, which defaults to5): Number of bands.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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) -> unitArguments:
port(of typeint, which defaults to8000): Port for incoming harbor (http) connections.path(of typestring, which defaults to"/"): Base path.browse(of typebool, which defaults tofalse): 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 typestring): 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) -> unitArguments:
port(of typeint, which defaults to8000): Port for incoming harbor (https) connections.path(of typestring, which defaults to"/"): Base path.browse(of typebool, which defaults tofalse): 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 typestring): Local path to be served.
http.delete
Perform a full Http DELETE request.
Type:
(?headers : [string * string], ?http_version : string?,
?redirect : bool, ?timeout_ms : int?, string) -> unitArguments:
headers(of type[string * string], which defaults to[]): Additional headers.http_version(of typestring?, which defaults tonull): Http request version.redirect(of typebool, which defaults totrue): Perform redirections if needed.timeout_ms(of typeint?, which defaults to10000): Timeout for network operations in milliseconds.(unlabeled)(of typestring): Requested URL, e.g. “http://www.google.com/”.
Methods:
headers(of type[string * string]): HTTP headers.protocol_version(of typestring): Version of the HTTP protocol.status_code(of typeint): Status code.status_message(of typestring): Status message.
http.delete.stream
Perform a full Http DELETE request.
Type:
(?headers : [string * string], ?http_version : string?,
?redirect : bool, ?timeout_ms : int?, string,
on_body_data : ((string?) -> unit)) -> unitArguments:
headers(of type[string * string], which defaults to[]): Additional headers.http_version(of typestring?, which defaults tonull): Http request version.redirect(of typebool, which defaults totrue): Perform redirections if needed.timeout_ms(of typeint?, which defaults to10000): Timeout for network operations in milliseconds.(unlabeled)(of typestring): Requested URL, e.g. “http://www.google.com/”.on_body_data(of type(string?) -> unit): function called when receiving response body data.nullor""means that all the data has been passed.
Methods:
headers(of type[string * string]): HTTP headers.protocol_version(of typestring): Version of the HTTP protocol.status_code(of typeint): Status code.status_message(of typestring): Status message.
http.get
Perform a full Http GET request.
Type:
(?headers : [string * string], ?http_version : string?,
?redirect : bool, ?timeout_ms : int?, string) -> stringArguments:
headers(of type[string * string], which defaults to[]): Additional headers.http_version(of typestring?, which defaults tonull): Http request version.redirect(of typebool, which defaults totrue): Perform redirections if needed.timeout_ms(of typeint?, which defaults to10000): Timeout for network operations in milliseconds.(unlabeled)(of typestring): Requested URL, e.g. “http://www.google.com/”.
Methods:
headers(of type[string * string]): HTTP headers.protocol_version(of typestring): Version of the HTTP protocol.status_code(of typeint): Status code.status_message(of typestring): Status message.
http.get.stream
Perform a full Http GET request.
Type:
(?headers : [string * string], ?http_version : string?,
?redirect : bool, ?timeout_ms : int?, string,
on_body_data : ((string?) -> unit)) -> unitArguments:
headers(of type[string * string], which defaults to[]): Additional headers.http_version(of typestring?, which defaults tonull): Http request version.redirect(of typebool, which defaults totrue): Perform redirections if needed.timeout_ms(of typeint?, which defaults to10000): Timeout for network operations in milliseconds.(unlabeled)(of typestring): Requested URL, e.g. “http://www.google.com/”.on_body_data(of type(string?) -> unit): function called when receiving response body data.nullor""means that all the data has been passed.
Methods:
headers(of type[string * string]): HTTP headers.protocol_version(of typestring): Version of the HTTP protocol.status_code(of typeint): Status code.status_message(of typestring): Status message.
http.head
Perform a full Http HEAD request.
Type:
(?headers : [string * string], ?http_version : string?,
?redirect : bool, ?timeout_ms : int?, string) -> unitArguments:
headers(of type[string * string], which defaults to[]): Additional headers.http_version(of typestring?, which defaults tonull): Http request version.redirect(of typebool, which defaults totrue): Perform redirections if needed.timeout_ms(of typeint?, which defaults to10000): Timeout for network operations in milliseconds.(unlabeled)(of typestring): Requested URL, e.g. “http://www.google.com/”.
Methods:
headers(of type[string * string]): HTTP headers.protocol_version(of typestring): Version of the HTTP protocol.status_code(of typeint): Status code.status_message(of typestring): Status message.
http.head.stream
Perform a full Http HEAD request.
Type:
(?headers : [string * string], ?http_version : string?,
?redirect : bool, ?timeout_ms : int?, string,
on_body_data : ((string?) -> unit)) -> unitArguments:
headers(of type[string * string], which defaults to[]): Additional headers.http_version(of typestring?, which defaults tonull): Http request version.redirect(of typebool, which defaults totrue): Perform redirections if needed.timeout_ms(of typeint?, which defaults to10000): Timeout for network operations in milliseconds.(unlabeled)(of typestring): Requested URL, e.g. “http://www.google.com/”.on_body_data(of type(string?) -> unit): function called when receiving response body data.nullor""means that all the data has been passed.
Methods:
headers(of type[string * string]): HTTP headers.protocol_version(of typestring): Version of the HTTP protocol.status_code(of typeint): Status code.status_message(of typestring): Status message.
http.multipart_form_data
Prepare a list of data to be sent as multipart form data
Type:
(?boundary : string?,
[
{
attributes : [string * string],
contents : {string},
headers : [string * string],
name : string
}]) -> unitArguments:
boundary(of typestring?, which defaults tonull): Specify boundary to use for multipart/form-data.(unlabeled)(of type[ { attributes : [string * string], contents : {string}, headers : [string * string], name : string }]): data to insert
Methods:
boundary(of typestring)contents(of type{string})
http.post
Perform a full Http POST request`.
Type:
(?data : {string}, ?headers : [string * string],
?http_version : string?, ?redirect : bool,
?timeout_ms : int?, string) -> stringArguments:
data(of type{string}, which defaults to""): POST data. Use astringgetter to stream data and return""when all data has been passed.headers(of type[string * string], which defaults to[]): Additional headers.http_version(of typestring?, which defaults tonull): Http request version.redirect(of typebool, which defaults totrue): Perform redirections if needed.timeout_ms(of typeint?, which defaults to10000): Timeout for network operations in milliseconds.(unlabeled)(of typestring): Requested URL, e.g. “http://www.google.com/”.
Methods:
headers(of type[string * string]): HTTP headers.protocol_version(of typestring): Version of the HTTP protocol.status_code(of typeint): Status code.status_message(of typestring): Status message.
http.post.file
Send a file via POST request encoded in multipart/form-data. The
contents can either be directly specified (with the
contents argument) or taken from a file (with the
file argument).
Type:
(?name : string, ?content_type : string?,
?headers : [string * string], ?boundary : string?,
?filename : string?, ?file : string?,
?contents : {string}?, ?timeout : int?,
?redirect : bool, string) -> stringArguments:
name(of typestring, which defaults to"file"): Name of the field fieldcontent_type(of typestring?, which defaults tonull): Content-type (mime) for the file.headers(of type[string * string], which defaults to[]): Additional headers.boundary(of typestring?, which defaults tonull): Specify boundary to use for multipart/form-data.filename(of typestring?, which defaults tonull): File name sent in the request.file(of typestring?, which defaults tonull): File whose contents is to be sent in the request.contents(of type{string}?, which defaults tonull): Contents of the file sent in the request.timeout(of typeint?, which defaults tonull): Timeout in ms.redirect(of typebool, which defaults totrue): Follow reidrections.(unlabeled)(of typestring): URL to post to.
Methods:
headers(of type[string * string]): HTTP headers.protocol_version(of typestring): Version of the HTTP protocol.status_code(of typeint): Status code.status_message(of typestring): Status message.
http.post.stream
Perform a full Http POST request`.
Type:
(?data : {string}, ?headers : [string * string],
?http_version : string?, ?redirect : bool,
?timeout_ms : int?, string,
on_body_data : ((string?) -> unit)) -> unitArguments:
data(of type{string}, which defaults to""): POST data. Use astringgetter to stream data and return""when all data has been passed.headers(of type[string * string], which defaults to[]): Additional headers.http_version(of typestring?, which defaults tonull): Http request version.redirect(of typebool, which defaults totrue): Perform redirections if needed.timeout_ms(of typeint?, which defaults to10000): Timeout for network operations in milliseconds.(unlabeled)(of typestring): Requested URL, e.g. “http://www.google.com/”.on_body_data(of type(string?) -> unit): function called when receiving response body data.nullor""means that all the data has been passed.
Methods:
headers(of type[string * string]): HTTP headers.protocol_version(of typestring): Version of the HTTP protocol.status_code(of typeint): Status code.status_message(of typestring): Status message.
http.put
Perform a full Http PUT request.
Type:
(?data : {string}, ?headers : [string * string],
?http_version : string?, ?redirect : bool,
?timeout_ms : int?, string) -> stringArguments:
data(of type{string}, which defaults to""): POST data. Use astringgetter to stream data and return""when all data has been passed.headers(of type[string * string], which defaults to[]): Additional headers.http_version(of typestring?, which defaults tonull): Http request version.redirect(of typebool, which defaults totrue): Perform redirections if needed.timeout_ms(of typeint?, which defaults to10000): Timeout for network operations in milliseconds.(unlabeled)(of typestring): Requested URL, e.g. “http://www.google.com/”.
Methods:
headers(of type[string * string]): HTTP headers.protocol_version(of typestring): Version of the HTTP protocol.status_code(of typeint): Status code.status_message(of typestring): Status message.
http.put.file
Send a file via PUT request encoded in multipart/form-data. The
contents can either be directly specified (with the
contents argument) or taken from a file (with the
file argument).
Type:
(?name : string, ?content_type : string?,
?headers : [string * string], ?boundary : string?,
?filename : string?, ?file : string?,
?contents : {string}?, ?timeout : int?,
?redirect : bool, string) -> stringArguments:
name(of typestring, which defaults to"file"): Name of the field fieldcontent_type(of typestring?, which defaults tonull): Content-type (mime) for the file.headers(of type[string * string], which defaults to[]): Additional headers.boundary(of typestring?, which defaults tonull): Specify boundary to use for multipart/form-data.filename(of typestring?, which defaults tonull): File name sent in the request.file(of typestring?, which defaults tonull): File whose contents is to be sent in the request.contents(of type{string}?, which defaults tonull): Contents of the file sent in the request.timeout(of typeint?, which defaults tonull): Timeout in ms.redirect(of typebool, which defaults totrue): Follow reidrections.(unlabeled)(of typestring): URL to put to.
Methods:
headers(of type[string * string]): HTTP headers.protocol_version(of typestring): Version of the HTTP protocol.status_code(of typeint): Status code.status_message(of typestring): Status message.
http.put.stream
Perform a full Http PUT request.
Type:
(?data : {string}, ?headers : [string * string],
?http_version : string?, ?redirect : bool,
?timeout_ms : int?, string,
on_body_data : ((string?) -> unit)) -> unitArguments:
data(of type{string}, which defaults to""): POST data. Use astringgetter to stream data and return""when all data has been passed.headers(of type[string * string], which defaults to[]): Additional headers.http_version(of typestring?, which defaults tonull): Http request version.redirect(of typebool, which defaults totrue): Perform redirections if needed.timeout_ms(of typeint?, which defaults to10000): Timeout for network operations in milliseconds.(unlabeled)(of typestring): Requested URL, e.g. “http://www.google.com/”.on_body_data(of type(string?) -> unit): function called when receiving response body data.nullor""means that all the data has been passed.
Methods:
headers(of type[string * string]): HTTP headers.protocol_version(of typestring): Version of the HTTP protocol.status_code(of typeint): Status code.status_message(of typestring): Status message.
http.response
Create a HTTP response string.
Type:
(?protocol : string, ?code : int,
?headers : [string * string], ?content_type : string,
?data : string) -> () -> stringArguments:
protocol(of typestring, which defaults to"HTTP/1.1"): HTTP protocol used.code(of typeint, which defaults to200): Response code.headers(of type[string * string], which defaults to[]): Response headers.content_type(of typestring, which defaults to""): Content type for the data.data(of typestring, 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)) -> () -> stringArguments:
protocol(of typestring, which defaults to"HTTP/1.1"): HTTP protocol used.code(of typeint, which defaults to200): Response code.headers(of type[string * string], which defaults to[]): Response headers.content_type(of typestring, 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]) -> unitArguments:
host(of typestring, which defaults to"localhost")port(of typeint, which defaults to8000)user(of typestring, which defaults to"source")password(of typestring, which defaults to"hackme")mount(of typestring, which defaults to""): Source mount point. Mandatory when streaming to icecast.icy_id(of typeint, which defaults to1): Shoutcast source ID. Only supported by Shoutcast v2.protocol(of typestring, which defaults to"http"): Protocol to use. One of: “icy”, “http” or “https”encoding(of typestring?, which defaults tonull): Encoding used to send metadata, default (UTF-8) if null.headers(of type[string * string], which defaults to[("User-Agent", "Liquidsoap/2.1.3 (Unix; OCaml 4.14.0)")]): Additional headers.(unlabeled)(of type[string * string])
interactive.bool
Read a boolean from an interactive input.
Type:
(?description : string, ?osc : string, string, bool) ->
() -> boolArguments:
description(of typestring, which defaults to""): Description of the variable.osc(of typestring, which defaults to""): OSC address.(unlabeled)(of typestring): Name of the variable.(unlabeled)(of typebool): Initial value.
Methods:
remove(of type() -> unit)set(of type('A) -> unit)
interactive.float
Read a float from an interactive input.
Type:
(?min : float, ?max : float, ?step : float,
?description : string, ?unit : string, ?osc : string,
string, 'a) -> () -> 'aArguments:
min(of typefloat, which defaults to-inf): Minimal value.max(of typefloat, which defaults toinf): Maximal value.step(of typefloat, which defaults to0.1): Typical variation of the value.description(of typestring, which defaults to""): Description of the variable.unit(of typestring, which defaults to""): Unit for the variable.osc(of typestring, which defaults to""): OSC address.(unlabeled)(of typestring): Name of the variable.(unlabeled)(of type'a): Initial value.
Methods:
remove(of type() -> unit)set(of type('A) -> unit)
interactive.harbor
Expose interactive variables through habor http server.
Type:
(?port : int, ?uri : string) -> unitArguments:
port(of typeint, which defaults to8000): Port of the server.uri(of typestring, which defaults to"/interactive"): URI of the server.
interactive.int
Read an integer from an interactive input.
Type:
(?description : string, ?osc : string, string, 'a) ->
() -> 'aArguments:
description(of typestring, which defaults to""): Description of the variable.osc(of typestring, which defaults to""): OSC address.(unlabeled)(of typestring): Name of the variable.(unlabeled)(of type'a): Initial value.
Methods:
remove(of type() -> unit)set(of type('A) -> unit)
interactive.string
Read a string from an interactive input.
Type:
(?description : string, ?osc : string, string, 'a) ->
() -> 'aArguments:
description(of typestring, which defaults to""): Description of the variable.osc(of typestring, which defaults to""): OSC address.(unlabeled)(of typestring): Name of the variable.(unlabeled)(of type'a): Initial value.
Methods:
remove(of type() -> unit)set(of type('A) -> unit)
metadata.getter
Create a getter from a metadata: this is a string, whose value can be changed with a metadata.
Type:
(string, 'a, 'c
.{on_metadata : (((['a * string]) -> unit)) -> 'b}) ->
() -> string where 'a is an orderable typeArguments:
(unlabeled)(of typestring): Initial value.(unlabeled)(of typeanything that is an orderable type): Metadata on which the value should be updated.(unlabeled)(of type'c.{on_metadata : (((['a * string]) -> unit)) -> 'b} where 'a is an orderable type): 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, 'a, 'c
.{on_metadata : (((['a * string]) -> unit)) -> 'b}) ->
() -> float where 'a is an orderable typeArguments:
(unlabeled)(of typefloat): Initial value.(unlabeled)(of typeanything that is an orderable type): Metadata on which the value should be updated.(unlabeled)(of type'c.{on_metadata : (((['a * string]) -> unit)) -> 'b} where 'a is an orderable type): Source containing the metadata.
osc.bool
Read from an OSC path.
Type:
(string, bool) -> () -> boolArguments:
(unlabeled)(of typestring): OSC path.(unlabeled)(of typebool): Initial value.
osc.float
Read from an OSC path.
Type:
(string, float) -> () -> floatArguments:
(unlabeled)(of typestring): OSC path.(unlabeled)(of typefloat): Initial value.
osc.float_pair
Read from an OSC path.
Type:
(string, (float * float)) -> () -> float * floatArguments:
(unlabeled)(of typestring): OSC path.(unlabeled)(of typefloat * float): Initial value.
osc.int
Read from an OSC path.
Type:
(string, int) -> () -> intArguments:
(unlabeled)(of typestring): OSC path.(unlabeled)(of typeint): Initial value.
osc.int_pair
Read from an OSC path.
Type:
(string, (int * int)) -> () -> int * intArguments:
(unlabeled)(of typestring): OSC path.(unlabeled)(of typeint * int): Initial value.
osc.on_bool
Register a callback on OSC messages.
Type:
(string, ((bool) -> unit)) -> unitArguments:
(unlabeled)(of typestring): OSC path.(unlabeled)(of type(bool) -> unit): Callback function.
osc.on_float
Register a callback on OSC messages.
Type:
(string, ((float) -> unit)) -> unitArguments:
(unlabeled)(of typestring): OSC path.(unlabeled)(of type(float) -> unit): Callback function.
osc.on_float_pair
Register a callback on OSC messages.
Type:
(string, (((float * float)) -> unit)) -> unitArguments:
(unlabeled)(of typestring): OSC path.(unlabeled)(of type((float * float)) -> unit): Callback function.
osc.on_int
Register a callback on OSC messages.
Type:
(string, ((int) -> unit)) -> unitArguments:
(unlabeled)(of typestring): OSC path.(unlabeled)(of type(int) -> unit): Callback function.
osc.on_int_pair
Register a callback on OSC messages.
Type:
(string, (((int * int)) -> unit)) -> unitArguments:
(unlabeled)(of typestring): OSC path.(unlabeled)(of type((int * int)) -> unit): Callback function.
osc.on_string
Register a callback on OSC messages.
Type:
(string, ((string) -> unit)) -> unitArguments:
(unlabeled)(of typestring): OSC path.(unlabeled)(of type(string) -> unit): Callback function.
osc.on_string_pair
Register a callback on OSC messages.
Type:
(string, (((string * string)) -> unit)) -> unitArguments:
(unlabeled)(of typestring): 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) -> unitArguments:
host(of typestring): OSC client address.port(of typeint): OSC client port.(unlabeled)(of typestring): OSC path.(unlabeled)(of typebool): Value to send.
osc.send_float
Send a value to an OSC client.
Type:
(host : string, port : int, string, float) -> unitArguments:
host(of typestring): OSC client address.port(of typeint): OSC client port.(unlabeled)(of typestring): OSC path.(unlabeled)(of typefloat): Value to send.
osc.send_float_pair
Send a value to an OSC client.
Type:
(host : string, port : int, string, (float * float)) ->
unitArguments:
host(of typestring): OSC client address.port(of typeint): OSC client port.(unlabeled)(of typestring): OSC path.(unlabeled)(of typefloat * float): Value to send.
osc.send_int
Send a value to an OSC client.
Type:
(host : string, port : int, string, int) -> unitArguments:
host(of typestring): OSC client address.port(of typeint): OSC client port.(unlabeled)(of typestring): OSC path.(unlabeled)(of typeint): Value to send.
osc.send_int_pair
Send a value to an OSC client.
Type:
(host : string, port : int, string, (int * int)) -> unitArguments:
host(of typestring): OSC client address.port(of typeint): OSC client port.(unlabeled)(of typestring): OSC path.(unlabeled)(of typeint * int): Value to send.
osc.send_string
Send a value to an OSC client.
Type:
(host : string, port : int, string, string) -> unitArguments:
host(of typestring): OSC client address.port(of typeint): OSC client port.(unlabeled)(of typestring): OSC path.(unlabeled)(of typestring): Value to send.
osc.send_string_pair
Send a value to an OSC client.
Type:
(host : string, port : int, string, (string * string)) ->
unitArguments:
host(of typestring): OSC client address.port(of typeint): OSC client port.(unlabeled)(of typestring): OSC path.(unlabeled)(of typestring * string): Value to send.
osc.string
Read from an OSC path.
Type:
(string, string) -> () -> stringArguments:
(unlabeled)(of typestring): OSC path.(unlabeled)(of typestring): Initial value.
osc.string_pair
Read from an OSC path.
Type:
(string, (string * string)) -> () -> string * stringArguments:
(unlabeled)(of typestring): OSC path.(unlabeled)(of typestring * string): Initial value.
print
Print on standard output.
Type:
(?newline : bool, 'a) -> unitArguments:
newline(of typebool, which defaults totrue): 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) -> unitArguments:
help(of typestring): Help of the metricnamespace(of typestring, which defaults to""): namespace of the metricsubsystem(of typestring, which defaults to""): subsystem of the metriclabels(of type[string]): labels for the metric(unlabeled)(of typestring): Name of the metric
prometheus.gauge
Register a prometheus gauge
Type:
(help : string, ?namespace : string, ?subsystem : string,
labels : [string], string) ->
(label_values : [string]) -> (float) -> unitArguments:
help(of typestring): Help of the metricnamespace(of typestring, which defaults to""): namespace of the metricsubsystem(of typestring, which defaults to""): subsystem of the metriclabels(of type[string]): labels for the metric(unlabeled)(of typestring): Name of the metric
prometheus.summary
Register a prometheus summary
Type:
(help : string, ?namespace : string, ?subsystem : string,
labels : [string], string) ->
(label_values : [string]) -> (float) -> unitArguments:
help(of typestring): Help of the metricnamespace(of typestring, which defaults to""): namespace of the metricsubsystem(of typestring, which defaults to""): subsystem of the metriclabels(of type[string]): labels for the metric(unlabeled)(of typestring): Name of the metric
server.broadcast
Restart all server clients waiting on the given condition.
Type:
(('a * ('b * (() -> 'c)))) -> 'cArguments:
(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)) -> unitArguments:
namespace(of typestring?, which defaults tonull): Used to group multiple commands for the same functionality. If specified, the command will be namednamespace.command.description(of typestring, which defaults to"No documentation available."): A description of your command.usage(of typestring?, which defaults tonull): Description of how the command should be used.(unlabeled)(of typestring): 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.signal
Restart one server client waiting on the given condition.
Type:
(('a * ((() -> 'b) * 'c))) -> 'bArguments:
(unlabeled)(of type'a * ((() -> 'b) * 'c)): condition
server.telnet
Enable telnet server.
Type:
(?port : int) -> unitArguments:
port(of typeint, which defaults to1234): Port on which we should listen.
Interactive
interactive.load
Load the value of interactive variables from a file.
Type:
(string) -> unitArguments:
(unlabeled)(of typestring): 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) -> unitArguments:
(unlabeled)(of typestring): Name of the file.
interactive.save
Save the value of all interactive variables in a file.
Type:
(string) -> unitArguments:
(unlabeled)(of typestring): 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) -> unitArguments:
name(of typestring): Format/decoder’s name.description(of typestring): 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 typeint, which defaults to1): Decoder prioritytest(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 typestring): Process to start.
add_metadata_resolver
Register an external file metadata decoder.
Type:
(string, ((string) -> [string * string])) -> unitArguments:
(unlabeled)(of typestring): 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)) -> unitArguments:
name(of typestring): Format/decoder’s name.description(of typestring): 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 typeint, which defaults to1): Decoder prioritymimes(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 typefloat, which defaults to5.)(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])) -> unitArguments:
temporary(of typebool, which defaults tofalse): if true, file is removed when it is finished.static(of typebool, which defaults tofalse): if true, then requests can be resolved once and for all. Typically, static protocols can be used to create infallible sources.syntax(of typestring, which defaults to"Undocumented"): URI syntax.doc(of typestring, which defaults to"Undocumented"): Protocol documentation.(unlabeled)(of typestring): 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) -> unitArguments:
(unlabeled)(of typebool): Condition which should be satisfied.
audio.channels
Channels for audio.
Type:
() -> intArguments:
audio.samplerate
Samplerate for audio.
Type:
() -> intArguments:
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 typestring, 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 typestring?, which defaults tonull)(unlabeled)(of typesource('a))
clock.assign_new
Create a new clock and assign it to a list of sources.
Type:
(?id : string?, ?sync : string, [source('a)]) -> unitArguments:
id(of typestring?, which defaults tonull): Identifier for the new clock. The default empty string means that the identifier of the first source will be used.sync(of typestring, 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) -> unitArguments:
delay(of typefloat, which defaults to0.): 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 typefloat, which defaults to1.): Polling interval.(unlabeled)(of typestring): 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)]) -> unitArguments:
(unlabeled)(of type[source('a)])
configure.bindir
Liquidsoap’s Internal script directory.
Type:
stringArguments:
configure.camomile_dir
Liquidsoap’s camomile files directory.
Type:
stringArguments:
configure.default_font
Liquidsoap’s default font file.
Type:
stringArguments:
configure.libdir
Liquidsoap’s library directory.
Type:
stringArguments:
configure.logdir
Liquidsoap’s logging directory.
Type:
stringArguments:
configure.rundir
Liquidsoap’s PID file directory.
Type:
stringArguments:
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:
() -> unitArguments:
enable_external_ffmpeg_decoder
Enable ffmpeg decoder.
Type:
() -> unitArguments:
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:
() -> unitArguments:
enable_external_mpc_decoder
Enable external Musepack decoder.
Type:
() -> unitArguments:
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) -> unitArguments:
delay(of typefloat, which defaults to-1.): Maximum delay for extracting metadata.extract_replaygain(of typestring, which defaults to"/usr/share/liquidsoap/2.1.3/bin/extract-replaygain"): The extraction program.
encoder.content_type
Return the content-type (mime) of an encoder, if known.
Type:
(format('a)) -> stringArguments:
(unlabeled)(of typeformat('a))
encoder.extension
Return the file extension of an encoder, if known.
Type:
(format('a)) -> stringArguments:
(unlabeled)(of typeformat('a))
error.on_error
Register a callback to monitor errors raised during the execution of the program. The callback is allow to re-raise a different error if needed.
Type:
(((error
.{
kind : string,
message : string,
positions : [string]
}) -> unit)) -> unitArguments:
(unlabeled)(of type(error .{kind : string, message : string, positions : [string] }) -> unit)
error.raise
Raise an error.
Type:
(error
.{kind : string, message : string, positions : [string]
}, ?string) -> 'aArguments:
(unlabeled)(of typeerror .{kind : string, message : string, positions : [string]}): Error kind.(unlabeled)(of typestring, which defaults to""): Description of the error.
error.register
Register an error of the given kind
Type:
(string) -> errorArguments:
(unlabeled)(of typestring): Kind of the error
Methods:
kind(of typestring): Error kind.message(of typestring): Error message.positions(of type[string]): Error positions.
failwith
Major failure.
Type:
(string) -> 'aArguments:
(unlabeled)(of typestring): Explanation about the failure.
frame.duration
Duration of a frame.
Type:
() -> floatArguments:
fst
Get the first component of a pair.
Type:
(('a * 'b)) -> 'aArguments:
(unlabeled)(of type'a * 'b)
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) -> 'b), (((() -> 'a)) -> 'b)) -> 'bArguments:
(unlabeled)(of type{'a}): Getter to inspect.(unlabeled)(of type('a) -> 'b)(unlabeled)(of type((() -> 'a)) -> 'b)
getter.changes
Detect whether the value of the getter changes.
Type:
({'a}) -> () -> bool where 'a is an orderable typeArguments:
(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}) -> () -> 'aArguments:
(unlabeled)(of type{'a})
getter.get
Get the value of a getter.
Type:
({'a}) -> 'aArguments:
(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}) -> boolArguments:
(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 typeArguments:
(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.merge
Give the latest value among two getters.
Type:
({'a}, {'a}) -> () -> 'a where 'a is an orderable typeArguments:
(unlabeled)(of type{'a} where 'a is an orderable type)(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 typeArguments:
(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})) ->
unitArguments:
port(of typeint, which defaults to8000): Port to server.method(of typestring, which defaults to"GET"): Accepted method (“GET” / “POST” / “PUT” / “DELETE” / “HEAD” / “OPTIONS”).(unlabeled)(of typestring): 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) -> unitArguments:
port(of typeint, which defaults to8000): Port to server.method(of typestring, which defaults to"GET"): Method served.(unlabeled)(of typestring): 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})) ->
unitArguments:
port(of typeint, which defaults to8000): Port to server.method(of typestring, which defaults to"GET"): Accepted method (“GET” / “POST” / “PUT” / “DELETE” / “HEAD” / “OPTIONS”).(unlabeled)(of typestring): 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) -> unitArguments:
port(of typeint, which defaults to8000): Port to server.method(of typestring, which defaults to"GET"): Method served.(unlabeled)(of typestring): URI served.
liquidsoap.chroot.make
Export all the files required to install liquidsoap in a root folder. Usefull for packaging and docker images
Type:
(string) -> unitArguments:
(unlabeled)(of typestring)
liquidsoap.executable
Path to the Liquidsoap executable.
Type:
stringArguments:
liquidsoap.version
Liquidsoap version string.
Type:
stringArguments:
liquidsoap.version.at_least
Ensure that Liquidsoap version is greater or equal to given one.
Type:
(string) -> boolArguments:
(unlabeled)(of typestring): Minimal version.
log
Log a message.
Type:
(?label : string, ?level : int, string) -> unitArguments:
label(of typestring, which defaults to"lang")level(of typeint, which defaults to3)(unlabeled)(of typestring)
log.critical
Log a critical message
Type:
(?label : string, string) -> unitArguments:
label(of typestring, which defaults to"lang")(unlabeled)(of typestring)
log.debug
Log a debug message
Type:
(?label : string, string) -> unitArguments:
label(of typestring, which defaults to"lang")(unlabeled)(of typestring)
log.file
Get and set the file logging
Type:
() -> boolArguments:
log.important
Log an important message
Type:
(?label : string, string) -> unitArguments:
label(of typestring, which defaults to"lang")(unlabeled)(of typestring)
log.info
Log a normal message
Type:
(?label : string, string) -> unitArguments:
label(of typestring, which defaults to"lang")(unlabeled)(of typestring)
log.level
Get and set the log level.
Type:
() -> intArguments:
log.severe
Log a severe message
Type:
(?label : string, string) -> unitArguments:
label(of typestring, which defaults to"lang")(unlabeled)(of typestring)
log.stdout
Get and set logging to stdout
Type:
() -> boolArguments:
null
Create a nullable value.
Type:
(?'a?) -> 'a?Arguments:
(unlabeled)(of type'a?, which defaults tonull): Value to make nullable.
null.case
Return a result dending on whether a value is nothing or not.
Type:
('a?, (() -> 'b), (('a) -> 'b)) -> 'bArguments:
(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)) -> 'aArguments:
(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?) -> boolArguments:
(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?) -> 'aArguments:
default(of type'a?, which defaults tonull): Returned value when the value isnull.(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 typestring?, which defaults tonull)mime_type(of typestring?, which defaults tonull): Default MIME type for the playlist.nullmeans automatic detection.timeout(of typefloat, which defaults to20.): Timeout for resolving the playlist(unlabeled)(of typestring): Path to the playlist
playlist.id
Default id assignment for playlists
Type:
(default : string, string) -> stringArguments:
default(of typestring): Default name pattern when no useful name can be extracted fromuri(unlabeled)(of typestring): 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 typestring, which defaults to""): Default path for files.mime(of typestring?, which defaults tonull): Mime type for the playlist(unlabeled)(of typestring)
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])) -> unitArguments:
format(of typestring): Playlist format. If possible, a mime-type.strict(of typebool): 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)) -> () -> boolArguments:
init(of typebool, which defaults tofalse): Detect at beginning.(unlabeled)(of type() -> bool): Predicate.
predicate.changes
Detect when a predicate changes.
Type:
((() -> 'a)) -> () -> bool where 'a is an orderable typeArguments:
(unlabeled)(of type() -> 'a where 'a is an orderable type): Predicate.
predicate.first
First occurrence of a predicate.
Type:
((() -> bool)) -> () -> boolArguments:
(unlabeled)(of type() -> bool): Predicate.
predicate.once
Become true once every time a predicate is true.
Type:
((() -> bool)) -> () -> boolArguments:
(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:
() -> () -> boolArguments:
Methods:
signal(of type() -> unit): Send a signal.
process_uri
Create a process: uri, replacing : with
$(colon)
Type:
(extname : 'a, ?uri : string, string) -> stringArguments:
extname(of type'a): Output file extension (with no leading ‘.’)uri(of typestring, which defaults to""): Input uri(unlabeled)(of typestring): Command line to execute
profiler.disable
Record profiling statistics.
Type:
() -> unitArguments:
profiler.enable
Record profiling statistics.
Type:
() -> unitArguments:
profiler.run
Time a function with the profiler.
Type:
(string, (() -> 'a)) -> 'aArguments:
(unlabeled)(of typestring): Name of the profiled function.(unlabeled)(of type() -> 'a): Function to profile.
profiler.stats.string
Profiling statistics.
Type:
() -> stringArguments:
prometheus.latency
Monitor a source’s internal latencies on Prometheus
Type:
(?window : float, ?prefix : string, labels : [string]) ->
(label_values : [string], source('a)) -> unitArguments:
window(of typefloat, which defaults to5.): Window over which mean and peak metrics are reported.prefix(of typestring, which defaults to"liquidsoap_"): Prefix for the metric’s namelabels(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)) -> 'aArguments:
(unlabeled)(of typeref('a))
ref.getter
Create a getter from a reference.
Type:
(ref('a)) -> () -> 'aArguments:
(unlabeled)(of typeref('a))
Methods:
set(of type('A) -> unit)
ref.incr
Increment a reference to an integer.
Type:
(ref(int)) -> unitArguments:
(unlabeled)(of typeref(int))
ref.set
Set the value of a reference.
Type:
(ref('a), 'a) -> unitArguments:
(unlabeled)(of typeref('a))(unlabeled)(of type'a)
request.create
Create a request from an URI.
Type:
(?indicators : [string], ?persistent : bool,
?temporary : bool, string) -> requestArguments:
indicators(of type[string], which defaults to[])persistent(of typebool, which defaults tofalse): Indicate that the request is persistent, i.e. that it may be used again once it has been played.temporary(of typebool, which defaults tofalse): Indicate that the request is a temporary file: it will be destroyed after being played.(unlabeled)(of typestring)
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) -> unitArguments:
force(of typebool, which defaults tofalse): Destroy the request even if it is persistent.(unlabeled)(of typerequest)
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) -> floatArguments:
(unlabeled)(of typestring)
request.filename
Return a valid local filename if the request is ready, and the empty string otherwise.
Type:
(request) -> stringArguments:
(unlabeled)(of typerequest)
request.id
Identifier of a request.
Type:
(request) -> intArguments:
(unlabeled)(of typerequest)
request.log
Get log data associated to a request.
Type:
(request) -> stringArguments:
(unlabeled)(of typerequest)
request.metadata
Get the metadata associated to a request.
Type:
(request) -> [string * string]Arguments:
(unlabeled)(of typerequest)
request.read_metadata
Force reading the metadata of a request.
Type:
(request) -> unitArguments:
(unlabeled)(of typerequest)
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) ->
boolArguments:
content_type(of typesource('a)?, which defaults tonull): If specified, the request will be decoded with the same content type as the given source.timeout(of typefloat, which defaults to30.): Limit in seconds to the duration of the resolving.(unlabeled)(of typerequest)
request.resolved
Check if a request is resolved, i.e. is associated to a valid local file.
Type:
(request) -> boolArguments:
(unlabeled)(of typerequest)
request.status
Current status of a request. Can be idle, resolving, ready, playing or destroyed.
Type:
(request) -> stringArguments:
(unlabeled)(of typerequest)
request.uri
Initial URI of a request.
Type:
(request) -> stringArguments:
(unlabeled)(of typerequest)
runtime.gc.full_major
Trigger full major garbage collection.
Type:
() -> unitArguments:
runtime.gc.get
Return the current values of the GC parameters
Type:
() -> unitArguments:
Methods:
allocation_policy(of typeint)custom_major_ratio(of typeint)custom_minor_max_size(of typeint)custom_minor_ratio(of typeint)major_heap_increment(of typeint)max_overhead(of typeint)minor_heap_size(of typeint)space_overhead(of typeint)stack_limit(of typeint)verbose(of typeint)window_size(of typeint)
runtime.gc.print_stat
Print the current values of the memory management counters in human-readable form.
Type:
() -> unitArguments:
runtime.gc.quick_stat
Same as stat except that live_words,
live_blocks, free_words,
free_blocks, largest_free, and
fragments are set to 0. This function is much
faster than gc.stat because it does not need to go through
the heap.
Type:
() -> unitArguments:
Methods:
compactions(of typeint)fragments(of typeint)free_blocks(of typeint)free_words(of typeint)heap_chunks(of typeint)heap_words(of typeint)largest_free(of typeint)live_blocks(of typeint)live_words(of typeint)major_collections(of typeint)major_words(of typefloat)minor_collections(of typeint)minor_words(of typefloat)promoted_words(of typefloat)stack_size(of typeint)top_heap_words(of typeint)
runtime.gc.set
Set the GC parameters.
Type:
(
{
allocation_policy : int,
custom_major_ratio : int,
custom_minor_max_size : int,
custom_minor_ratio : int,
major_heap_increment : int,
max_overhead : int,
minor_heap_size : int,
space_overhead : int,
stack_limit : int,
verbose : int,
window_size : int
}) -> unitArguments:
(unlabeled)(of type{ allocation_policy : int, custom_major_ratio : int, custom_minor_max_size : int, custom_minor_ratio : int, major_heap_increment : int, max_overhead : int, minor_heap_size : int, space_overhead : int, stack_limit : int, verbose : int, window_size : int })
runtime.gc.stat
Return the current values of the memory management counters. This function examines every heap block to get the statistics.
Type:
() -> unitArguments:
Methods:
compactions(of typeint)fragments(of typeint)free_blocks(of typeint)free_words(of typeint)heap_chunks(of typeint)heap_words(of typeint)largest_free(of typeint)live_blocks(of typeint)live_words(of typeint)major_collections(of typeint)major_words(of typefloat)minor_collections(of typeint)minor_words(of typefloat)promoted_words(of typefloat)stack_size(of typeint)top_heap_words(of typeint)
runtime.mem_usage.prettify_bytes
Returns a human-redable description of an amount of bytes.
Type:
(?float_printer : ((float) -> string)?, ?signed : bool?,
?bits : bool?, ?binary : bool?, int) -> stringArguments:
float_printer(of type((float) -> string)?, which defaults tonull)signed(of typebool?, which defaults tonull)bits(of typebool?, which defaults tonull)binary(of typebool?, which defaults tonull)(unlabeled)(of typeint)
runtime.memory
Returns information about the system and process’ memory usage.
Requires mem_usage for a full report.
Type:
() -> unitArguments:
Methods:
pretty(of type{ process_managed_memory : string, process_physical_memory : string, process_virtual_memory : string, total_physical_memory : string, total_used_physical_memory : string, total_used_virtual_memory : string, total_virtual_memory : string })process_managed_memory(of typeint)process_physical_memory(of typeint)process_virtual_memory(of typeint)total_physical_memory(of typeint)total_used_physical_memory(of typeint)total_used_virtual_memory(of typeint)total_virtual_memory(of typeint)
runtime.sys.word_size
Size of one word on the machine currently executing the program, in
bits. Either 32 or 64.
Type:
intArguments:
seconds_of_main
Convert a number of main ticks in seconds.
Type:
(int) -> floatArguments:
(unlabeled)(of typeint)
server.execute
Execute a liquidsoap server command.
Type:
(string, ?string) -> [string]Arguments:
(unlabeled)(of typestring): Command to execute.(unlabeled)(of typestring, which defaults to""): Argument for the command.
settings
All settings.
Type:
{
alsa :
{
alsa_buffer : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
buffer_length : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
comments : string,
description : string,
periods : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
}
},
audio :
{
comments : string,
converter :
{
channel_layout :
{
comments : string,
converters : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
description : string
},
comments : string,
description : string,
samplerate :
{
comments : string,
converters : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
description : string,
libsamplerate :
{
comments : string,
description : string,
quality : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
}
},
native :
{
comments : string,
description : string,
quality : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
}
}
}
},
description : string
},
clock :
{
allow_streaming_errors : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
comments : string,
description : string,
log_delay : (() -> float)
.{
comments : string,
description : string,
set : (float) -> unit
}
},
comments : string,
console :
{
colorize : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
comments : string,
description : string
},
decoder :
{
comments : string,
debug : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
decoders : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
description : string,
ffmpeg :
{
codecs :
{
_4xm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
aac : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
aasc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
ac3 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
acelpkelvin : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_4xm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_adx : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_afc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_agm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_dtk : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_ea_xas : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_g726le : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_ima_ea_eacs : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_ima_ea_sead : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_ima_qt : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_ima_smjpeg : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_ima_ws : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_psx : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_swf : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_thp : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_thp_le : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
adpcm_yamaha : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
agm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
aic : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
alac : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
amr_nb : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
amr_wb : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
amv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
anm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
ansi : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
ape : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
apng : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
aptx : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
arbc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
asv1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
asv2 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
atrac1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
atrac3 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
atrac3al : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
atrac9 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
aura : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
aura2 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
av1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
avc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
avrn : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
avrp : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
avs : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
avui : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
ayuv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
bethsoftvid : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
bfi : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
binkaudio_dct : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
binkvideo : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
bitpacked : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
bmp : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
bmv_audio : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
bmv_video : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
brender_pix : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
c93 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
cavs : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
cdxl : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
cfhd : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
cljr : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
cllc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
cmv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
comfortnoise : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
comments : string,
cook : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
cpia : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
cscd : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
cyuv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
dds : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
description : string,
dfa : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
dpx : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
dsd_lsbf_planar : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
dsd_msbf_planar : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
dsicinvideo : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
dss_sp : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
dst : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
dts : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
dxa : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
dxtory : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
dxv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
eac3 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
escape124 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
escape130 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
evrc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
exr : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
ffv1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
fic : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
fits : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
flac : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
flashsv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
flic : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
flv1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
fmvc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
fraps : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
frwu : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
g2m : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
g723_1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
g729 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
gdv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
gif : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
gsm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
h261 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
h263 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
h263i : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
h263p : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
h264 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
hap : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
hca : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
hcom : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
hevc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
hnm4video : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
hq_hqa : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
hqx : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
hymt : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
iac : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
iff_ilbm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
ilbc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
imc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
imm4 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
imm5 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
interplayacm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
interplayvideo : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
jpeg2000 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
jv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
kgv1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
kmvc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
lagarith : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
loco : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
lscr : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
m101 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mace3 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mace6 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mad : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mdec : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
metasound : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mimic : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mjpeg : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mjpegb : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mlp : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
motionpixels : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mp1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mp2 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mp3 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mpeg1video : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mpeg2video : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mpeg4 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
msa1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mscc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
msmpeg4v1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
msmpeg4v2 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
msmpeg4v3 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
msrle : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mss1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mss2 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mszh : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mts2 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mv30 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mvc1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mvc2 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mvdv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mvha : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mwsc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
mxpeg : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
notchlc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
nuv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
opus : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pam : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pbm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_bluray : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_dvd : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_f16le : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_f24le : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_f32be : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_f32le : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_f64be : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_f64le : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_lxf : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_s16be : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_s16le : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_s16le_planar : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_s24be : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_s24daud : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_s24le : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_s24le_planar : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_s32be : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_s32le : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_s32le_planar : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_s64be : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_s64le : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_u16be : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_u16le : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_u24be : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_u24le : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_u32be : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_u32le : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcm_vidc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pcx : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pfm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pgm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pgmyuv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
pictor : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
png : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
ppm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
psd : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
ptx : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
qdm2 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
qdmc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
qpeg : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
r10k : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
r210 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
ralf : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
rasc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
rl2 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
roq : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
rpza : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
rscc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
rv10 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
rv20 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
rv30 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
rv40 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
sanm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
sbc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
scpr : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
screenpresso : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
sdx2_dpcm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
sgi : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
sipr : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
siren : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
smc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
snow : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
sol_dpcm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
sonic : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
sp5x : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
speedhq : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
speex : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
srgc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
svg : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
svq1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
svq3 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
tak : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
targa : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
targa_y216 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
tdsc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
tgq : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
tgv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
theora : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
thp : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
tiertexseqvideo : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
tiff : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
tmv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
tqi : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
truehd : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
truemotion1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
truemotion2 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
truemotion2rt : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
tscc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
tscc2 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
tta : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
txd : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
ulti : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
v210 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
v210x : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
v308 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
v408 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
v410 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vb : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vble : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vc1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vc1image : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vcr1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vixl : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vmdaudio : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vmdvideo : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vmnc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vorbis : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vp3 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vp4 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vp5 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vp6 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vp6a : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vp6f : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vp7 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vp8 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
vp9 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
wavesynth : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
wavpack : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
wcmv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
webp : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
westwood_snd1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
wmalossless : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
wmavoice : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
wmv1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
wmv2 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
wmv3 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
wnv1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
ws_vqa : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
xan_wc3 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
xan_wc4 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
xbm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
xma1 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
xma2 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
xpm : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
xwd : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
y41p : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
ylc : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
yop : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
yuv4 : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
zlib : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
},
zmbv : (() -> string?)
.{
available : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
set : (string) -> unit
}
},
comments : string,
description : string
},
file_extensions :
{
aac : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
aiff : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
ffmpeg : (() -> [string])
.{
comments : string,
description : string,
images : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
set : ([string]) -> unit
},
flac : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
id3 : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
image_metadata : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
mad : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
mp3 : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
mp4 : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
ogg : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
srt : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
taglib : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
video_metadata : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
wav : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
}
},
id3 :
{comments : string, description : string
},
image_file_decoders : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
image_metadata :
{comments : string, description : string
},
mime_types :
{
aac : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
aiff : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
basic : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
ffmpeg : (() -> [string])
.{
comments : string,
description : string,
images : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
set : ([string]) -> unit
},
flac : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
id3 : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
image_metadata : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
mad : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
mp3 : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
mp4 : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
ogg : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
srt : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
taglib : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
video_metadata : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
wav : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
}
},
priorities :
{
aac : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
aiff : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
basic : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
comments : string,
description : string,
ffmpeg : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
flac : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
mad : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
mp4 : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
ogg : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
srt : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
wav : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
}
},
taglib :
{comments : string, description : string
},
video_metadata :
{comments : string, description : string
}
},
description : string,
encoder :
{
comments : string,
description : string,
metadata :
{
comments : string,
description : string,
export : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
}
}
},
ffmpeg :
{
comments : string,
content :
{
comments : string,
copy :
{
comments : string,
description : string,
relaxed_compatibility_check : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
}
},
description : string
},
description : string,
log :
{
comments : string,
description : string,
level : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
verbosity : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
}
},
scaling_algorithm : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
}
},
frame :
{
audio :
{
channels : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
comments : string,
description : string,
samplerate : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
size : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
}
},
comments : string,
description : string,
duration : (() -> float)
.{
comments : string,
description : string,
set : (float) -> unit
},
midi :
{
channels : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
comments : string,
description : string
},
video :
{
comments : string,
default : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
description : string,
framerate : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
height : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
width : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
}
}
},
harbor :
{
bind_addrs : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
comments : string,
description : string,
icy_formats : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
max_connections : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
reverse_dns : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
ssl :
{
certificate : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
comments : string,
description : string,
password : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
private_key : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
read_timeout : (() -> float)
.{
comments : string,
description : string,
set : (float) -> unit
},
write_timeout : (() -> float)
.{
comments : string,
description : string,
set : (float) -> unit
}
},
timeout : (() -> float)
.{
comments : string,
description : string,
set : (float) -> unit
},
verbose : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
}
},
init :
{
allow_root : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
catch_exn : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
comments : string,
daemon : (() -> bool)
.{
change_user : (() -> bool)
.{
comments : string,
description : string,
group : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
set : (bool) -> unit,
user : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
}
},
comments : string,
description : string,
pidfile : (() -> bool)
.{
comments : string,
description : string,
path : (() -> string?)
.{
comments : string,
description : string,
set : (string) -> unit
},
perms : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (bool) -> unit
},
set : (bool) -> unit
},
description : string,
force_start : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
trace : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
}
},
lang :
{
comments : string,
debug : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
debug_errors : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
description : string
},
log :
{
comments : string,
description : string,
file : (() -> bool)
.{
append : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
comments : string,
description : string,
path : (() -> string?)
.{
comments : string,
description : string,
set : (string) -> unit
},
perms : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (bool) -> unit
},
level : (() -> int)
.{
annotate : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
audio : (() -> int?)
.{
comments : string,
converter : (() -> int?)
.{
comments : string,
description : string,
libsamplerate : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
description : string,
set : (int) -> unit
},
audioscrobbler : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
avi : (() -> int?)
.{
comments : string,
description : string,
encoder : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
camomile : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
clock : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
comments : string,
console : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
decoder : (() -> int?)
.{
aac : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
camlimages : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
comments : string,
description : string,
external : (() -> int?)
.{
comments : string,
description : string,
oblivious : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
ffmpeg : (() -> int?)
.{
comments : string,
description : string,
image : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
internal : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
flac : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
id3 : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
image : (() -> int?)
.{
comments : string,
description : string,
metadata : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
mad : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
midi : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
mp4 : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
ogg : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
ppm : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
raw : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
sdlimage : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit,
srt : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
taglib : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
video : (() -> int?)
.{
comments : string,
description : string,
metadata : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
wav_aiff : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
}
},
deprecated : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
description : string,
dssi_synthesizer : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
dynamic : (() -> int?)
.{
comments : string,
description : string,
loader : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
ffmpeg : (() -> int?)
.{
comments : string,
copy : (() -> int?)
.{
comments : string,
description : string,
encoder : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
decoder : (() -> int?)
.{
comments : string,
copy : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
description : string,
set : (int) -> unit
},
description : string,
encoder : (() -> int?)
.{
comments : string,
description : string,
internal : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
filter : (() -> int?)
.{
bitstream : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
comments : string,
description : string,
set : (int) -> unit
},
internal : (() -> int?)
.{
comments : string,
decoder : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
file_watcher : (() -> int?)
.{
comments : string,
description : string,
native : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
frame : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
frei0r : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
harbor : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
hls : (() -> int?)
.{
comments : string,
description : string,
output : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
icy : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit,
update_metadata : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
}
},
image : (() -> int?)
.{
comments : string,
decoder : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
description : string,
set : (int) -> unit
},
input : (() -> int?)
.{
comments : string,
description : string,
external : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit,
video : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
}
},
http : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
jack : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
ladspa_extension : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
lang : (() -> int?)
.{
comments : string,
description : string,
json : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
langfile : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
lastfm : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit,
submit : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
}
},
lifecycle : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
lo : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
metadata : (() -> int?)
.{
comments : string,
description : string,
flac : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
mp4 : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
oggmuxer : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
playlist : (() -> int?)
.{
basic : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
comments : string,
description : string,
set : (int) -> unit,
xml : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
}
},
playlist_parser : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
process : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
prometheus : (() -> int?)
.{
comments : string,
description : string,
server : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
request : (() -> int?)
.{
comments : string,
description : string,
dynamic : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
sandbox : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
server : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit,
single : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
source : (() -> int?)
.{
comments : string,
description : string,
dump : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
},
srt : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
threads : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
video : (() -> int?)
.{
add_text : (() -> int?)
.{
camlimages : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
comments : string,
description : string,
set : (int) -> unit
},
comments : string,
converter : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
description : string,
set : (int) -> unit,
text : (() -> int?)
.{
comments : string,
description : string,
native : (() -> int?)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (int) -> unit
}
}
},
stdout : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
unix_timestamps : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
}
},
mpd :
{
comments : string,
debug : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
description : string,
host : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
path : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
port : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
randomize : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
}
},
osc :
{
comments : string,
description : string,
port : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
}
},
playlists :
{
comments : string,
cue_in_metadata : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
cue_out_metadata : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
description : string,
mime_types :
{
comments : string,
description : string,
xml : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
}
}
},
prometheus :
{
comments : string,
description : string,
server : (() -> bool)
.{
comments : string,
description : string,
port : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (bool) -> unit
}
},
request :
{
comments : string,
description : string,
leak_warning : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
metadata_decoders : (() -> [string])
.{
comments : string,
description : string,
duration : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
override : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
set : ([string]) -> unit
}
},
root :
{
comments : string,
description : string,
max_latency : (() -> float)
.{
comments : string,
description : string,
set : (float) -> unit
}
},
sandbox : (() -> bool)
.{
binary : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
comments : string,
description : string,
network : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
ro : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
rw : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
set : (bool) -> unit,
setenv : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
},
shell : (() -> bool)
.{
comments : string,
description : string,
path : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
set : (bool) -> unit
},
unsetenv : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
}
},
scheduler :
{
comments : string,
description : string,
fast_queues : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
generic_queues : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
log : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
non_blocking_queues : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
}
},
server :
{
comments : string,
description : string,
log :
{
comments : string,
description : string,
level : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
}
},
socket : (() -> bool)
.{
comments : string,
description : string,
path : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
permissions : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (bool) -> unit
},
telnet : (() -> bool)
.{
bind_addr : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
comments : string,
description : string,
port : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
revdns : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
set : (bool) -> unit
},
timeout : (() -> float)
.{
comments : string,
description : string,
set : (float) -> unit
}
},
srt :
{
comments : string,
description : string,
enforced_encryption : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
},
log : (() -> bool)
.{
comments : string,
description : string,
level : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
},
set : (bool) -> unit,
verbosity : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
}
},
poll :
{
comments : string,
description : string,
timeout : (() -> int)
.{
comments : string,
description : string,
set : (int) -> unit
}
}
},
tag :
{
comments : string,
description : string,
encodings : (() -> [string])
.{
comments : string,
description : string,
set : ([string]) -> unit
}
},
video :
{
comments : string,
converter :
{
comments : string,
description : string,
preferred : (() -> string)
.{
comments : string,
description : string,
set : (string) -> unit
},
proportional_scale : (() -> bool)
.{
comments : string,
description : string,
set : (bool) -> unit
}
},
description : string
}
}Arguments:
snd
Get the second component of a pair.
Type:
(('a * 'b)) -> 'bArguments:
(unlabeled)(of type'a * 'b)
source.dump
Immediately encode the whole contents of a source into a file.
Type:
(format('a), string, source('b)) -> unitArguments:
(unlabeled)(of typeformat('a)): Encoding format.(unlabeled)(of typestring): Name of the file.(unlabeled)(of typesource('b)): Source to encode
This function is experimental.
source.duration
Estimation of the duration in the current track.
Type:
(source('a)) -> floatArguments:
(unlabeled)(of typesource('a))
source.elapsed
Elapsed time in the current track.
Type:
(source('a)) -> floatArguments:
(unlabeled)(of typesource('a))
source.fallible
Indicate if a source may fail, i.e. may not be ready to stream.
Type:
(source('a)) -> boolArguments:
(unlabeled)(of typesource('a))
source.id
Get the identifier of a source.
Type:
(source('a)) -> stringArguments:
(unlabeled)(of typesource('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)) -> boolArguments:
(unlabeled)(of typesource('a))
source.remaining
Estimation of remaining time in the current track.
Type:
(source('a)) -> floatArguments:
(unlabeled)(of typesource('a))
source.seek
Seek forward, in seconds. Returns the amount of time effectively seeked.
Type:
(source('a), float) -> floatArguments:
(unlabeled)(of typesource('a))(unlabeled)(of typefloat)
source.set_name
Set the name of an operator.
Type:
(source('a), string) -> unitArguments:
(unlabeled)(of typesource('a))(unlabeled)(of typestring)
source.skip
Skip to the next track.
Type:
(source('a)) -> unitArguments:
(unlabeled)(of typesource('a))
source.time
Get a source’s time, based on its assigned clock
Type:
(source('a)) -> floatArguments:
(unlabeled)(of typesource('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
.{kind : string, message : string, positions : [string]
}?,
((backtrace : string, error
.{
kind : string,
message : string,
positions : [string]
}) -> unit)) -> unitArguments:
(unlabeled)(of typeerror .{kind : string, message : string, positions : [string]}?)(unlabeled)(of type(backtrace : string, error .{kind : string, message : string, positions : [string] }) -> unit)
thread.run.recurrent
Run a recurrent function in a separate thread.
Type:
(?fast : bool, ?delay : float, (() -> float)) -> unitArguments:
fast(of typebool, which defaults totrue): 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 tofalseits 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 typefloat, which defaults to0.): 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).
time.make
Convert a date and time in the local timezone into a time, in seconds, since 00:00:00 GMT, Jan. 1, 1970.
Type:
(
{
day : int,
dst : bool?,
hour : int,
min : int,
month : int,
sec : int,
year : int
}) -> floatArguments:
(unlabeled)(of type{ day : int, dst : bool?, hour : int, min : int, month : int, sec : int, year : int })
time.predicate
Parse a string as a time predicate
Type:
(string) -> () -> boolArguments:
(unlabeled)(of typestring)
time.zone
Returns a description of the time zone set for the running process.
Type:
() -> stringArguments:
Methods:
daylight(of typestring): Daylight Savings Timeutc_diff(of typeint): Difference in seconds between the current timezone and UTC.
time.zone.set
Set the current time zone. This is equivalent to setting the
TZ environment variable.
Type:
(string) -> unitArguments:
(unlabeled)(of typestring)
while
A while loop.
Type:
({bool}, (() -> unit)) -> unitArguments:
(unlabeled)(of type{bool}): Condition guarding the loop.(unlabeled)(of type() -> unit): Function to execute.
List
_::_
Add an element at the top of a list.
Type:
('a, ['a]) -> ['a]Arguments:
(unlabeled)(of type'a)(unlabeled)(of type['a])
_[_]
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 typeArguments:
(unlabeled)(of type['a * string] where 'a is an orderable type)(unlabeled)(of typeanything 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 typeArguments:
default(of type'a?, which defaults tonull): Value returned if the key is not found.(unlabeled)(of typeanything 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 * 'b]) -> bool where 'a is an orderable typeArguments:
(unlabeled)(of typeanything that is an orderable type): Key to look for(unlabeled)(of type['a * 'b] 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 * 'b]) -> ['a * 'b]
where 'a is an orderable typeArguments:
(unlabeled)(of typeanything that is an orderable type): Key of pair to be removed.(unlabeled)(of type['a * 'b] 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 * 'b]) -> ['a * 'b]
where 'a is an orderable typeArguments:
(unlabeled)(of typeanything that is an orderable type): Key of pairs to be removed.(unlabeled)(of type['a * 'b] 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)) -> 'bArguments:
(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)) -> 'bArguments:
(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]) -> boolArguments:
(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]) -> 'aArguments:
default(of type'a?, which defaults tonull): 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]) -> 'aArguments:
(unlabeled)(of type('a, 'b) -> 'a): Functionffor whichf(x,e)which will be called on every elementewith the current value ofx, returning the new value ofx.(unlabeled)(of type'a): Initial value x1, to be updated by successive calls off(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]) -> 'bArguments:
(unlabeled)(of type('a, 'b) -> 'b): Functionffor whichf(x,e)which will be called on every elementewith the current value ofx, returning the new value ofx.(unlabeled)(of type'b): Initial value x1, to be updated by successive calls off(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]) -> boolArguments:
(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]) -> 'aArguments:
default(of type'a?, which defaults tonull): 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)) -> 'bArguments:
(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]) -> intArguments:
(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 typeint): Number of elements in the list.(unlabeled)(of type(int) -> 'a): Function such thatf iis theith 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 typeint): Index to insert at, starting at0.(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]) -> boolArguments:
(unlabeled)(of type['a])
list.iter
Call a function on every element of a list.
Type:
((('a) -> unit), ['a]) -> unitArguments:
(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]) -> unitArguments:
(unlabeled)(of type(int, 'a) -> unit)(unlabeled)(of type['a])
list.last
Return the last element of a list.
Type:
(?default : 'a?, ['a]) -> 'aArguments:
default(of type'a?, which defaults tonull)(unlabeled)(of type['a])
list.length
Compute the length of a list, i.e., the number of its elements.
Type:
(['a]) -> intArguments:
(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.map.right
Map a function on every element of a list, starting from the right. This function is tail-recursive.
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 typeArguments:
(unlabeled)(of typeanything that is an orderable type)(unlabeled)(of type['a] 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) -> 'aArguments:
default(of type'a?, which defaults tonull)(unlabeled)(of type['a])(unlabeled)(of typeint)
list.pick
Pick a random element in a list.
Type:
(?default : 'a?, ['a]) -> 'aArguments:
default(of type'a?, which defaults tonull): 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 typeint): 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 typeArguments:
(unlabeled)(of typeanything 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 tonull): Returned value when no element is found.(unlabeled)(of type('b) -> 'a?): Function.(unlabeled)(of type['b]): List.
List.
list.make
Create a list with given length, filled with given element.
Type:
(int, 'a) -> ['a]Arguments:
(unlabeled)(of typeint): Number of elements in the list.(unlabeled)(of type'a): Element to fill the list with.
Math
*
Multiplication of numbers.
Type:
('a, 'a) -> 'a where 'a is a number typeArguments:
(unlabeled)(of typeanything that is a number type)(unlabeled)(of typeanything that is a number type)
+
Addition of numbers.
Type:
('a, 'a) -> 'a where 'a is a number typeArguments:
(unlabeled)(of typeanything that is a number type)(unlabeled)(of typeanything that is a number type)
-
Subtraction of numbers.
Type:
('a, 'a) -> 'a where 'a is a number typeArguments:
(unlabeled)(of typeanything that is a number type)(unlabeled)(of typeanything that is a number type)
/
Division of numbers.
Type:
('a, 'a) -> 'a where 'a is a number typeArguments:
(unlabeled)(of typeanything that is a number type)(unlabeled)(of typeanything that is a number type)
abs
Absolute value.
Type:
('a) -> 'a where 'a is a number typeArguments:
(unlabeled)(of typeanything 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) -> floatArguments:
(unlabeled)(of typefloat)
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) -> floatArguments:
(unlabeled)(of typefloat)
atan
Arc tangent. Result is in radians and is between -pi/2 and pi/2.
Type:
(float) -> floatArguments:
(unlabeled)(of typefloat)
bool_of_float
Convert a float to a bool.
Type:
(float) -> boolArguments:
(unlabeled)(of typefloat)
bool_of_int
Convert an int to a bool.
Type:
(int) -> boolArguments:
(unlabeled)(of typeint)
cos
Cosine. Argument is in radians.
Type:
(float) -> floatArguments:
(unlabeled)(of typefloat)
cosh
Hyperbolic cosine. Argument is in radians.
Type:
(float) -> floatArguments:
(unlabeled)(of typefloat)
dB_of_lin
Convert linear scale into decibels.
Type:
(float) -> floatArguments:
(unlabeled)(of typefloat)
exp
Exponential.
Type:
(float) -> floatArguments:
(unlabeled)(of typefloat)
float
Convert a number to a float.
Type:
('a) -> float where 'a is a number typeArguments:
(unlabeled)(of typeanything that is a number type)
float_of_int
Convert an int to a float.
Type:
(int) -> floatArguments:
(unlabeled)(of typeint)
infinity
Float representation of infinity.
Type:
floatArguments:
int
Convert a number to an integer.
Type:
('a) -> int where 'a is a number typeArguments:
(unlabeled)(of typeanything that is a number type)
int_of_float
Convert a float to a int.
Type:
(float) -> intArguments:
(unlabeled)(of typefloat)
lin_of_dB
Convert decibels into linear scale.
Type:
(float) -> floatArguments:
(unlabeled)(of typefloat)
ln
Natural logarithm.
Type:
(float) -> floatArguments:
(unlabeled)(of typefloat)
log10
Base 10 logarithm.
Type:
(float) -> floatArguments:
(unlabeled)(of typefloat)
lsl
Logical shift left.
Type:
(int, int) -> intArguments:
(unlabeled)(of typeint): Number to shift.(unlabeled)(of typeint): Number of bits to shift.
lsr
Logical shift right.
Type:
(int, int) -> intArguments:
(unlabeled)(of typeint): Number to shift.(unlabeled)(of typeint): Number of bits to shift.
max
Compute the maximum of two values.
Type:
('a, 'a) -> 'a where 'a is an orderable typeArguments:
(unlabeled)(of typeanything that is an orderable type)(unlabeled)(of typeanything that is an orderable type)
max_int
Maximal representable integer.
Type:
intArguments:
min
Compute the minimum of two values.
Type:
('a, 'a) -> 'a where 'a is an orderable typeArguments:
(unlabeled)(of typeanything that is an orderable type)(unlabeled)(of typeanything that is an orderable type)
min_int
Minimal representable integer.
Type:
intArguments:
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)) ->
() -> floatArguments:
type(of typestring, which defaults to"lin"): Fade shape. One of: “sin”, “exp”, “log”, “lin”start(of typefloat, which defaults to0.): Start value.stop(of typefloat, which defaults to1.): Stop value.duration(of typefloat, which defaults to3.): Duration in seconds.on_done(of type() -> unit, which defaults to<fun>): Function to execute when the fade is finished(unlabeled)(of typesource('a))
mod
Remainder of division of numbers.
Type:
('a, 'a) -> 'a where 'a is a number typeArguments:
(unlabeled)(of typeanything that is a number type)(unlabeled)(of typeanything 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:
floatArguments:
pow
Exponentiation of numbers.
Type:
('a, 'a) -> 'a where 'a is a number typeArguments:
(unlabeled)(of typeanything that is a number type)(unlabeled)(of typeanything that is a number type)
random.float
Generate a random value between min (included) and
max (excluded).
Type:
(?min : float, ?max : float) -> floatArguments:
min(of typefloat, which defaults to0.)max(of typefloat, which defaults to1.)
random.int
Generate a random value between min (included) and
max (excluded).
Type:
(?min : int, ?max : int) -> intArguments:
min(of typeint, which defaults to-536870911)max(of typeint, which defaults to536870912)
sin
Sine. Argument is in radians.
Type:
(float) -> floatArguments:
(unlabeled)(of typefloat)
sinh
Hyperbolic sine. Argument is in radians.
Type:
(float) -> floatArguments:
(unlabeled)(of typefloat)
sqrt
Square root.
Type:
(float) -> floatArguments:
(unlabeled)(of typefloat)
tan
Tangent. Argument is in radians.
Type:
(float) -> floatArguments:
(unlabeled)(of typefloat)
tanh
Hyperbolic tangent. Argument is in radians.
Type:
(float) -> floatArguments:
(unlabeled)(of typefloat)
~-
Returns the opposite of its argument.
Type:
('a) -> 'a where 'a is a number typeArguments:
(unlabeled)(of typeanything 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='b, midi='c)) ->
unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fallible(of typebool, which defaults totrue): 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 typebool, which defaults totrue): Automatically start outputting whenever possible. Iftrue, 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 typesource(audio=pcm('a), video='b, midi='c)): 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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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=canvas('b),
midi='c)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fallible(of typebool, which defaults totrue): 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 typebool, which defaults totrue): Automatically start outputting whenever possible. Iftrue, 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 typesource(audio=pcm('a), video=canvas('b), midi='c)): Source to play.
output.file.dash.ffmpeg
Output an MPEG-DASH playlist using ffmpeg
Type:
(?id : string?, ?flush : bool, ?fallible : bool,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?reopen_delay : float, ?reopen_on_metadata : bool,
?reopen_when : (() -> bool), ?start : bool,
?playlist : string, directory : 'a,
source(audio=pcm(stereo), video=canvas, midi=none)) ->
unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.flush(of typebool, which defaults tofalse): Perform a flush after each write.fallible(of typebool, which defaults tofalse): 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.reopen_delay(of typefloat, which defaults to120.): Prevent re-opening within that delay, in seconds.reopen_on_metadata(of typebool, which defaults tofalse): Re-open on every new metadata information.reopen_when(of type() -> bool, which defaults to{false}): When should the output be re-opened.start(of typebool, which defaults totrue): 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.playlist(of typestring, which defaults to"stream.mpd"): Playlist namedirectory(of type'a): Directory to write to(unlabeled)(of typesource(audio=pcm(stereo), video=canvas, midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.reopen(of type() -> unit): Reopen the pipe.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): Shutdown the output or 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.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=canvas('b),
midi='c)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fallible(of typebool, which defaults totrue): 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 typebool, which defaults totrue): Automatically start outputting whenever possible. Iftrue, 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 typesource(audio='a, video=canvas('b), midi='c)): Source to play.
output.youtube.live.hls
Stream to youtube using HLS.
Type:
(?id : string?, ?fallible : bool,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?stream_info : (string *
{
bandwidth : int,
codecs : string,
extname : string,
video_size : (int * int)?
})?,
?segment_duration : float, ?segments : int,
?segments_overhead : int, ?start : bool, ?url : string,
key : string, encoder : format('a), source('a)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fallible(of typebool, which defaults tofalse): 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.stream_info(of type(string * { bandwidth : int, codecs : string, extname : string, video_size : (int * int)? })?, which defaults tonull): Informations about the stream (seeoutput.file.hlsfor details).segment_duration(of typefloat, which defaults to2.): Segment duration (in seconds).segments(of typeint, which defaults to4): Number of segments per playlist.segments_overhead(of typeint, which defaults to4): Number of segments to keep after they have been featured in the live playlist.start(of typebool, which defaults totrue): 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.url(of typestring, which defaults to"https://a.upload.youtube.com/http_upload_hls"): HLS URL to stream tokey(of typestring): Your secret youtube keyencoder(of typeformat('a)): Encoder to use (most likely a%ffmpegencoder)(unlabeled)(of typesource('a))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.youtube.live.rtmp
Stream to youtube using RTMP.
Type:
(?id : string?, ?fallible : bool,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?start : bool, ?url : string, key : string,
encoder : format('a), source('a)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fallible(of typebool, which defaults tofalse): 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 typebool, which defaults totrue): 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.url(of typestring, which defaults to"rtmp://a.rtmp.youtube.com/live2"): RTMP URL to stream tokey(of typestring): Your secret youtube keyencoder(of typeformat('a)): Encoder to use (most likely a%ffmpegencoder)(unlabeled)(of typesource('a))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.
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 typestring?, which defaults tonull): Force the value of the source ID.normalize(of type{bool}, which defaults totrue): 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 tofalse): 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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.override(of typestring?, 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 suffixdB(e.g.-8.2 dB, but the spaces do not matter).(unlabeled)(of type{float}): Multiplicative factor.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of type(float) -> float)(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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.
nan values become 0.
Type:
(?id : string?, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.delay(of typefloat, which defaults to0.001): Delay in seconds.feedback(of type{float}, which defaults to-6.): Feedback coefficient in dB.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.mu(of typefloat, which defaults to1.)(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.attack(of type{float}, which defaults to50.): Attack time (ms).gain(of type{float}, which defaults to0.): Post-amplification (dB).knee(of type{float}, which defaults to1.): Knee width (dB).lookahead(of type{float}, which defaults to0.): Lookahead (ms).pre_gain(of type{float}, which defaults to0.): Pre-amplification (dB).ratio(of type{float}, which defaults to2.): Gain reduction ratio (reduction is ratio:1).release(of type{float}, which defaults to400.): Release time (ms).threshold(of type{float}, which defaults to-10.): Threshold level (dB).track_sensitive(of typebool, which defaults tofalse): Reset on every track.wet(of type{float}, which defaults to1.): 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 to0.): RMS window length (second).0.means peak mode.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.mu(of typefloat, which defaults to2.): Exponential compression factor, typically greater than 1.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.attack(of type{float}, which defaults to100.): Attack time (ms).gain(of type{float}, which defaults to0.): Additional gain (dB).knee(of type{float}, which defaults to1.): Knee radius (dB).ratio(of type{float}, which defaults to2.): Gain reduction ratio (n:1).release(of type{float}, which defaults to400.): Release time (ms).threshold(of type{float}, which defaults to-10.): Threshold level (dB).window(of typefloat, which defaults to0.1): Window for computing RMS (in sec).(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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,
((
{
db_level : float,
metadata : [string * string],
source : source(audio=pcm('a),
video='b,
midi='c)
},
{
db_level : float,
metadata : [string * string],
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 typestring?, which defaults tonull): Force the value of the source ID.active(of typebool, which defaults tofalse): 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 typebool, which defaults totrue): 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 to5.): Duration (in seconds) of buffered data from each track that is used to compute the transition between tracks.minimum(of typefloat, 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 typestring, which defaults to"liq_cross_duration"): Metadata field which, if present and containing a float, overrides the ‘duration’ parameter for current track.width(of typefloat, which defaults to2.): Width of the power computation window.(unlabeled)(of type( { db_level : float, metadata : [string * string], source : source(audio=pcm('a), video='b, midi='c) }, { db_level : float, metadata : [string * string], 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 typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of type{float}): Duration of the delay in seconds.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.bands(of typeint, which defaults to1024): Number of frequency bands.debug(of type{bool}, which defaults tofalse): 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 to0.05): Duration for detecting a tone.smoothing(of type{float}, which defaults to0.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 to50.): Threshold for detecting a band.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.delay(of type{float}, which defaults to0.5): Delay in seconds.feedback(of type{float}, which defaults to-6.): Feedback coefficient in dB (negative).ping_pong(of typebool, which defaults tofalse): Use ping-pong delay.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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?, ?pass_metadata : bool,
ffmpeg.filter.graph, ffmpeg.filter.audio) ->
source(audio=ffmpeg.audio.raw('a), video=none, midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.pass_metadata(of typebool, which defaults totrue): Pass ffmpeg stream metadata to liquidsoap(unlabeled)(of typeffmpeg.filter.graph)(unlabeled)(of typeffmpeg.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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.freq(of type{float}): Characteristic frequency of the filter.mode(of typestring): 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 to1.)wetness(of type{float}, which defaults to1.): How much of the original signal should be added (1. means only filtered and 0. means only original signal).(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.beta(of typefloat): Beta should range between 0 and 1.coeffs(of typeint, which defaults to255): Number of coefficientsfrequency(of typefloat): Corner frequency in Hz (frequency at which the response is 0.5, that is -6 dB).(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.frequency1(of typefloat): First corner frequencyfrequency2(of typefloat): Second corner frequencyorder(of typeint, which defaults to4): Filter order(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.frequency1(of typefloat): First corner frequencyfrequency2(of typefloat): Second corner frequencyorder(of typeint, which defaults to4): Filter order(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.frequency(of typefloat): Corner frequencyorder(of typeint, which defaults to4): Filter order(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.frequency(of typefloat): Corner frequencyorder(of typeint, which defaults to4): Filter order(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.bandwidth(of type{float}, which defaults to0.333333333333): Bandwidth (in octaves)frequency(of type{float}): Center frequency(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.frequency(of type{float}): Center frequencyq(of type{float}, which defaults to1.): Q(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.frequency(of type{float}): Corner frequencyq(of type{float}, which defaults to1.): Q(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.frequency(of type{float}): Center frequencyslope(of type{float}, which defaults to1.): Shelf slope (in dB/octave)(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.frequency(of type{float}): Corner frequencyq(of type{float}, which defaults to1.): Q(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.frequency(of type{float}): Corner frequencyslope(of type{float}, which defaults to1.): Shelf slope (dB/octave)(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.frequency(of type{float}): Center frequencyq(of type{float}, which defaults to1.): Q(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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 typestring?, which defaults tonull): Force the value of the source ID.frequency(of type{float}): Center frequencygain(of type{float}, which defaults to1.): Gain (in dB)q(of type{float}, which defaults to1.): Q(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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.resonator.allpass
IIR filter
Type:
(?id : string?, frequency : float, ?q : float,
source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.frequency(of typefloat): Corner frequencyq(of typefloat, which defaults to60.): Quality factor(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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.resonator.bandpass
IIR filter
Type:
(?id : string?, frequency : float, ?q : float,
source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.frequency(of typefloat): Corner frequencyq(of typefloat, which defaults to60.): Quality factor(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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.resonator.bandstop
IIR filter
Type:
(?id : string?, frequency : float, ?q : float,
source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.frequency(of typefloat): Corner frequencyq(of typefloat, which defaults to60.): Quality factor(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
filter.rc
First-order filter (RC filter).
Type:
(?id : string?, frequency : {float}, mode : string,
?wetness : {float}, source(audio=pcm('a), video='b,
midi='c)) -> source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.frequency(of type{float}): Cutoff frequency.mode(of typestring): Available modes are ‘low’ (for low-pass filter), ‘high’ (for high-pass filter).wetness(of type{float}, which defaults to1.): How much of the original signal should be added (1. means only filtered and 0. means only original signal).(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
flanger
Flanger effect.
Type:
(?id : string?, ?delay : float, ?feedback : {float},
?freq : {float}, ?phase : {float}, source(audio=pcm('a),
video='b, midi='c)) -> source(audio=pcm('a), video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.delay(of typefloat, which defaults to0.001): Delay in seconds.feedback(of type{float}, which defaults to0.): Feedback coefficient in dB.freq(of type{float}, which defaults to0.5): Frequency in Hz.phase(of type{float}, which defaults to1.): Phase difference between channels in radians.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
gate
Reduce the volume when the stream is silent (typically in order to avoid low intensity noise).
Type:
(?id : string?, ?attack : {float}, ?hold : {float},
?range : {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 typestring?, which defaults tonull): Force the value of the source ID.attack(of type{float}, which defaults to10.): Time to fully open the gate (ms).hold(of type{float}, which defaults to1000.): Minimum amount of time the gate stays open (ms).range(of type{float}, which defaults to-30.): Difference between closed and open level (dB).release(of type{float}, which defaults to2000.): Time to fully close the gate (ms).threshold(of type{float}, which defaults to-30.): Threshold at which the gate will open (dB).window(of type{float}, which defaults to1.): Duration for computing peak (ms).(unlabeled)(of typesource(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 typebool): Indicate if a source may fail, i.e. may not be ready to stream.gate(of type() -> float): Position of the gate (0. means closed, 1. means open).id(of type() -> string): Identifier of the source.is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
normalize.old
Normalize the signal. Dynamic normalization of the signal is
sometimes the only option, and can make a listening experience much
nicer. However, its dynamic aspect implies some limitations which can go
as far as creating saturation in some extreme cases. If possible,
consider using some track-based normalization techniques such as those
based on replay gain. See the documentation for more details. This is
the implementation provided in Liquidsoap < 2.0. A new, better and
more customizable one is now given in normalize.
Type:
(?id : string?, ?gain_max : {float}, ?gain_min : {float},
?k_down : {float}, ?k_up : {float}, ?target : {float},
?threshold : {float}, ?track_sensitive : bool,
?window : float, source(audio=pcm('a), video='b,
midi='c)) -> source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.gain_max(of type{float}, which defaults to6.): Maximal gain value (dB).gain_min(of type{float}, which defaults to-6.): Minimal gain value (dB).k_down(of type{float}, which defaults to0.1): Coefficient when the power must go down (between 0 and 1, slowest to fastest).k_up(of type{float}, which defaults to0.005): Coefficient when the power must go up (between 0 and 1, slowest to fastest).target(of type{float}, which defaults to-13.): Desired RMS (dB).threshold(of type{float}, which defaults to-40.): Minimal RMS for activaing gain control (dB).track_sensitive(of typebool, which defaults totrue): Reset values on every track.window(of typefloat, which defaults to0.1): Duration of the window used to compute the current RMS power (second).(unlabeled)(of typesource(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 typebool): Indicate if a source may fail, i.e. may not be ready to stream.gain(of type() -> float): Current amplification coefficient.id(of type() -> string): Identifier of the source.is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Current RMS.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
peak
Get current peak volume of the source. Returns the source with a
method peak to compute the current peak volume of the
source, with 0.0 <= peak volume <= 1.0.
Type:
(?id : string?, ?duration : {float},
source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of type{float}, which defaults to0.5): Duration of the window (in seconds). A value <= 0, means that computation should not be performed.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.peak(of type() -> float): Current value for the peak volume.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
peak.stereo
Get current peak volume of the source. Returns the source with a
method peak to compute the current peak volume of the
source, with 0.0 <= peak volume <= 1.0.
Type:
(?id : string?, ?duration : {float},
source(audio=pcm(stereo), video='a, midi='b)) ->
source(audio=pcm(stereo), video='a, midi='b)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of type{float}, which defaults to0.5): Duration of the window (in seconds). A value <= 0, means that computation should not be performed.(unlabeled)(of typesource(audio=pcm(stereo), video='a, midi='b))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.peak(of type() -> float * float): Current value for the peak volume.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
pipe
Process audio signal through a given process stdin/stdout.
Type:
(?id : string?, ?buffer : float, ?data_length : int?,
?log_overfull : bool, ?max : float, process : string,
?replay_delay : float?, ?restart : bool,
?restart_on_error : bool, source(audio=pcm('a),
video='b, midi='c)) -> source(audio=pcm('a), video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.buffer(of typefloat, which defaults to1.): Duration of the pre-buffered data.data_length(of typeint?, which defaults tonull): Length passed in the WAV data chunk. Data is streamed so no the consuming program should process it as it comes. Some program operate better when this value is set to0, some other when it is set to the maximum length allowed by the WAV specs. Use any negative value to set to maximum length.log_overfull(of typebool, which defaults totrue): Log when the source’s buffer is overfull.max(of typefloat, which defaults to10.): Maximum duration of the buffered data.process(of typestring): Process used to pipe data to.replay_delay(of typefloat?, which defaults tonull): Replay track marks and metadata from the input source on the output after a given delay. Ifnull(default) close and flush the process on each track and metadata to get an exact timing. This parameter is typically used when integrating withstereotool.restart(of typebool, which defaults totrue): Restart process when exited.restart_on_error(of typebool, which defaults totrue): Restart process when exited with error.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
rms
Get current RMS volume of the source. Returns the source with a
method rms to compute the current RMS volume of the source,
with 0.0 <= RMS volume <= 1.0.
Type:
(?id : string?, ?duration : {float},
source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of type{float}, which defaults to0.5): Duration of the window (in seconds). A value <= 0, means that computation should not be performed.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Current value for the RMS volume.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
rms.stereo
Get current RMS volume of the source. Returns the source with a
method rms to compute the current RMS volume of the source,
with 0.0 <= RMS volume <= 1.0.
Type:
(?id : string?, ?duration : {float},
source(audio=pcm(stereo), video='a, midi='b)) ->
source(audio=pcm(stereo), video='a, midi='b)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of type{float}, which defaults to0.5): Duration of the window (in seconds). A value <= 0, means that computation should not be performed.(unlabeled)(of typesource(audio=pcm(stereo), video='a, midi='b))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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 * float): Current value for the RMS volume.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
sine.detect
Detect sine waves.
Type:
(?id : string?, ?bands : int, ?debug : {bool},
?duration : {float}, ?smoothing : {float},
?threshold : {float}, [float], source(audio=pcm('a),
video='b, midi='c), ((float) -> unit)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.bands(of typeint, which defaults to1024): Number of frequency bands.debug(of type{bool}, which defaults tofalse): 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 to0.5): Duration for detecting a tone.smoothing(of type{float}, which defaults to0.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 to50.): Threshold for detecting a band.(unlabeled)(of type[float]): List of frequencies to detect.(unlabeled)(of typesource(audio=pcm('a), video='b, midi='c)): Source on which sines should be detected.(unlabeled)(of type(float) -> unit): Function called with detected frequency 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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
soundtouch
Change the rate, the tempo or the pitch of the sound.
Type:
(?id : string?, ?pitch : {float}, ?rate : {float},
?tempo : {float}, source(audio=pcm('a), video='b,
midi='c)) -> source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.pitch(of type{float}, which defaults to1.)rate(of type{float}, which defaults to1.)tempo(of type{float}, which defaults to1.)(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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.
stereo.ms.decode
Decode mid+side stereo (M/S) to left+right stereo.
Type:
(?id : string?, ?width : float, source(audio=pcm(stereo),
video='a, midi='b)) -> source(audio=pcm(stereo),
video='a, midi='b)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.width(of typefloat, which defaults to1.): Width of the stereo field.(unlabeled)(of typesource(audio=pcm(stereo), video='a, midi='b))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
stereo.ms.encode
Encode left+right stereo to mid+side stereo (M/S).
Type:
(?id : string?, source(audio=pcm(stereo), video='a,
midi='b)) -> source(audio=pcm(stereo), video='a,
midi='b)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(audio=pcm(stereo), video='a, midi='b))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
stereo.pan
Pan a stereo sound.
Type:
(?id : string?, ?field : {float}, ?pan : {float},
source(audio=pcm(stereo), video='a, midi='b)) ->
source(audio=pcm(stereo), video='a, midi='b)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.field(of type{float}, which defaults to90.): Field width in degrees (between 0 and 90).pan(of type{float}, which defaults to0.): Pan ranges between -1 and 1.(unlabeled)(of typesource(audio=pcm(stereo), video='a, midi='b))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
stereo.width
Spacializer which allows controlling the width of the signal.
Type:
(?id : string?, ?{float}, source(audio=pcm(stereo),
video='a, midi='b)) -> source(audio=pcm(stereo),
video='a, midi='b)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of type{float}, which defaults to0.): Width of the signal (-1: mono, 0.: original, 1.: wide stereo).(unlabeled)(of typesource(audio=pcm(stereo), video='a, midi='b))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
stretch
Slow down or accelerate an audio stream by stretching (sounds lower) or squeezing it (sounds higher).
Type:
(?id : string?, ratio : {float}, source(audio=pcm('a),
video='b, midi='c)) -> source(audio=pcm('a), video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.ratio(of type{float}): A value higher than 1 means slowing down.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
Source / Conversion
audio_to_stereo
Convert any pcm audio source into a stereo source.
Type:
(?id : string?, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm(stereo), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
drop_audio
Drop all audio content of a stream.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio=none, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
drop_midi
Drop all midi content of a stream.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
drop_video
Drop all video content of a stream.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video=none, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
ffmpeg.decode.audio
Convert a source’s content
Type:
(?id : string?, source(audio=ffmpeg.audio.copy('a),
video=none, midi=none)) -> source(audio=pcm('b),
video=none, midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(audio=ffmpeg.audio.copy('a), video=none, midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
ffmpeg.decode.audio_video
Convert a source’s content
Type:
(?id : string?, source(audio=ffmpeg.audio.copy('a),
video=ffmpeg.video.copy('b), midi=none)) ->
source(audio=pcm('c), video=canvas('d), midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(audio=ffmpeg.audio.copy('a), video=ffmpeg.video.copy('b), midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
ffmpeg.decode.video
Convert a source’s content
Type:
(?id : string?, source(audio=none,
video=ffmpeg.video.copy('a), midi=none)) ->
source(audio=none, video=canvas('b), midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(audio=none, video=ffmpeg.video.copy('a), midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
ffmpeg.encode.audio
Convert a source’s content
Type:
(?id : string?, format(audio=pcm('a), video=none,
midi=none), source(audio=pcm('a), video=none,
midi=none)) -> source(audio=ffmpeg.audio.copy('b),
video=none, midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typeformat(audio=pcm('a), video=none, midi=none)): Encoding format.(unlabeled)(of typesource(audio=pcm('a), video=none, midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
ffmpeg.encode.audio_video
Convert a source’s content
Type:
(?id : string?, format(audio=pcm('a), video=canvas('b),
midi=none), source(audio=pcm('a), video=canvas('b),
midi=none)) -> source(audio=ffmpeg.audio.copy('c),
video=ffmpeg.video.copy('d), midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typeformat(audio=pcm('a), video=canvas('b), midi=none)): Encoding format.(unlabeled)(of typesource(audio=pcm('a), video=canvas('b), midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
ffmpeg.encode.video
Convert a source’s content
Type:
(?id : string?, format(audio=none, video=canvas('a),
midi=none), source(audio=none, video=canvas('a),
midi=none)) -> source(audio=none,
video=ffmpeg.video.copy('b), midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typeformat(audio=none, video=canvas('a), midi=none)): Encoding format.(unlabeled)(of typesource(audio=none, video=canvas('a), midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
ffmpeg.raw.decode.audio
Convert a source’s content
Type:
(?id : string?, source(audio=ffmpeg.audio.raw('a),
video=none, midi=none)) -> source(audio=pcm('b),
video=none, midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(audio=ffmpeg.audio.raw('a), video=none, midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
ffmpeg.raw.decode.audio_video
Convert a source’s content
Type:
(?id : string?, source(audio=ffmpeg.audio.raw('a),
video=ffmpeg.video.raw('b), midi=none)) ->
source(audio=pcm('c), video=canvas('d), midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(audio=ffmpeg.audio.raw('a), video=ffmpeg.video.raw('b), midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
ffmpeg.raw.decode.video
Convert a source’s content
Type:
(?id : string?, source(audio=none,
video=ffmpeg.video.raw('a), midi=none)) ->
source(audio=none, video=canvas('b), midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(audio=none, video=ffmpeg.video.raw('a), midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
ffmpeg.raw.encode.audio
Convert a source’s content
Type:
(?id : string?, format(audio=ffmpeg.audio.raw('a),
video=none, midi=none), source(audio=pcm('b),
video=none, midi=none)) ->
source(audio=ffmpeg.audio.raw('a), video=none, midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typeformat(audio=ffmpeg.audio.raw('a), video=none, midi=none)): Encoding format.(unlabeled)(of typesource(audio=pcm('b), video=none, midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
ffmpeg.raw.encode.audio_video
Convert a source’s content
Type:
(?id : string?, format(audio=ffmpeg.audio.raw('a),
video=ffmpeg.video.raw('b), midi=none),
source(audio=pcm('c), video=canvas('d), midi=none)) ->
source(audio=ffmpeg.audio.raw('a),
video=ffmpeg.video.raw('b), midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typeformat(audio=ffmpeg.audio.raw('a), video=ffmpeg.video.raw('b), midi=none)): Encoding format.(unlabeled)(of typesource(audio=pcm('c), video=canvas('d), midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
ffmpeg.raw.encode.video
Convert a source’s content
Type:
(?id : string?, format(audio=none,
video=ffmpeg.video.raw('a), midi=none),
source(audio=none, video=canvas('b), midi=none)) ->
source(audio=none, video=ffmpeg.video.raw('a), midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typeformat(audio=none, video=ffmpeg.video.raw('a), midi=none)): Encoding format.(unlabeled)(of typesource(audio=none, video=canvas('b), midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
mean
Produce mono audio by taking the mean of all audio channels.
Type:
(?id : string?, ?normalize : bool, source(audio=pcm('a),
video='b, midi='c)) -> source(audio=pcm(mono), video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.normalize(of typebool, which defaults totrue): Divide the output volume by the number of channels.(unlabeled)(of typesource(audio=pcm('a), video='b, midi='c)): Source whose mean should be computed.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
mux_audio
Mux an audio stream into an audio-free stream. Track marks and metadata are taken from both sources.
Type:
(?id : string?, audio : source(audio='a, video=none,
midi=none), source(audio=none, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.audio(of typesource(audio='a, video=none, midi=none))(unlabeled)(of typesource(audio=none, 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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
mux_video
Add video channels to a stream. Track marks and metadata are taken from both sources.
Type:
(?id : string?, video : source(audio=none, video='a,
midi=none), source(audio='b, video=none, midi='c)) ->
source(audio='b, video='a, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.video(of typesource(audio=none, video='a, midi=none))(unlabeled)(of typesource(audio='b, video=none, 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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
swap
Swap two channels of a stereo source.
Type:
(?id : string?, source(audio=pcm(stereo), video='a,
midi='b)) -> source(audio=pcm(stereo), video='a,
midi='b)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(audio=pcm(stereo), video='a, midi='b))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
Source / Conversions
stereo.left
Extract the left channel of a stereo source
Type:
(source(audio=pcm(stereo), video='a, midi='b)) ->
source(audio=pcm(mono), video='a, midi='b)Arguments:
(unlabeled)(of typesource(audio=pcm(stereo), video='a, midi='b)): Source to extract from
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
stereo.right
Extract the right channel of a stereo source
Type:
(source(audio=pcm(stereo), video='a, midi='b)) ->
source(audio=pcm(mono), video='a, midi='b)Arguments:
(unlabeled)(of typesource(audio=pcm(stereo), video='a, midi='b)): Source to extract from
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
Source / FFmpeg Filter
Source / Input
blank
Produce silence and blank images.
Type:
(?id : string?, ?duration : float) ->
source(audio=internal('a), video=internal('b),
midi=internal('c))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of typefloat, which defaults to-1.): Duration of blank tracks in seconds, Negative value means forever.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
input.alsa
Stream from an ALSA input device.
Type:
(?id : string?, ?bufferize : bool, ?clock_safe : bool,
?device : string, ?fallible : bool,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?start : bool) -> source(audio=pcm('a), video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.bufferize(of typebool, which defaults totrue): Bufferize inputclock_safe(of typebool, which defaults totrue): Force the use of a dedicated clockdevice(of typestring, which defaults to"default"): Alsa device to usefallible(of typebool, which defaults tofalse): Allow the source to fail. If set tofalse,startmust betrueandstopmethod raises an error.on_start(of type() -> unit, which defaults to<fun>): Callback executed when input starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when input stops.start(of typebool, which defaults totrue): Start input as soon as it is available.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.
input.external.avi
Stream data from an external application.
Type:
(?id : string?, ?buffer : float, ?log_overfull : bool,
?max : float, ?restart : bool, ?restart_on_error : bool,
string) -> source(audio=pcm('a), video=canvas('b),
midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.buffer(of typefloat, which defaults to1.): Duration of the pre-buffered data.log_overfull(of typebool, which defaults totrue): Log when the source’s buffer is overfull.max(of typefloat, which defaults to10.): Maximum duration of the buffered data.restart(of typebool, which defaults totrue): Restart process when exited.restart_on_error(of typebool, which defaults tofalse): Restart process when exited with error.(unlabeled)(of typestring): Command to execute.
Methods:
buffer_length(of type() -> float * float * float): Length of the buffer (in seconds).duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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.
input.external.rawaudio
Stream raw PCM data (interleaved signed 16 bits little endian integers) from an external application.
Type:
(?id : string?, ?buffer : float, ?channels : int,
?log_overfull : bool, ?max : float, ?restart : bool,
?restart_on_error : bool, ?samplerate : int, string) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.buffer(of typefloat, which defaults to2.): Duration of the pre-buffered data.channels(of typeint, which defaults to2): Number of channels.log_overfull(of typebool, which defaults totrue): Log when the source’s buffer is overfull.max(of typefloat, which defaults to10.): Maximum duration of the buffered data.restart(of typebool, which defaults totrue): Restart process when exited.restart_on_error(of typebool, which defaults tofalse): Restart process when exited with error.samplerate(of typeint, which defaults to44100): Samplerate.(unlabeled)(of typestring): Command to execute.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
input.external.rawvideo
Stream data from an external application.
Type:
(?id : string?, ?buffer : float, ?log_overfull : bool,
?max : float, ?restart : bool, ?restart_on_error : bool,
string) -> source(audio='a, video=canvas('b), midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.buffer(of typefloat, which defaults to1.): Duration of the pre-buffered data.log_overfull(of typebool, which defaults totrue): Log when the source’s buffer is overfull.max(of typefloat, which defaults to10.): Maximum duration of the buffered data.restart(of typebool, which defaults totrue): Restart process when exited.restart_on_error(of typebool, which defaults tofalse): Restart process when exited with error.(unlabeled)(of typestring): Command to execute.
Methods:
buffer_length(of type() -> float * float * float): Length of the buffer (in seconds).duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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.
input.external.wav
Stream WAV data from an external application.
Type:
(?id : string?, ?buffer : float, ?log_overfull : bool,
?max : float, ?restart : bool, ?restart_on_error : bool,
string) -> source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.buffer(of typefloat, which defaults to2.): Duration of the pre-buffered data.log_overfull(of typebool, which defaults totrue): Log when the source’s buffer is overfull.max(of typefloat, which defaults to10.): Maximum duration of the buffered data.restart(of typebool, which defaults totrue): Restart process when exited.restart_on_error(of typebool, which defaults tofalse): Restart process when exited with error.(unlabeled)(of typestring): Command to execute.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
input.ffmpeg
Create a stream using ffmpeg
Type:
(?id : string?, ?clock_safe : bool, ?debug : bool,
?float_args : [string * float], ?format : string?,
?int_args : [string * int], ?log_overfull : bool,
?max_buffer : float, ?new_track_on_metadata : bool,
?on_connect : (() -> unit),
?on_disconnect : (() -> unit), ?on_start : (() -> unit),
?on_stop : (() -> unit), ?poll_delay : float,
?self_sync : bool, ?start : bool,
?string_args : [string * string], {string}) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.clock_safe(of typebool, which defaults tofalse): Force the use of a dedicated clockdebug(of typebool, which defaults tofalse): Run in debugging mode, not catching some exceptions.float_args(of type[string * float], which defaults to[])format(of typestring?, which defaults tonull): Force a specific input format. Autodetected when passed a null argumentint_args(of type[string * int], which defaults to[])log_overfull(of typebool, which defaults totrue): Log when the source’s buffer is overfull.max_buffer(of typefloat, which defaults to5.): Maximum uration of buffered datanew_track_on_metadata(of typebool, which defaults totrue): Treat new metadata as new track.on_connect(of type() -> unit, which defaults to<fun>): Function to execute when a source is connected.on_disconnect(of type() -> unit, which defaults to<fun>): Function to excecute when a source is disconnectedon_start(of type() -> unit, which defaults to<fun>): Callback executed when input starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when input stops.poll_delay(of typefloat, which defaults to2.): Polling delay when trying to connect to the stream.self_sync(of typebool, which defaults tofalse): Should the source control its own timing? Set totrueif you are having synchronization issues. Should befalsefor most typical cases.start(of typebool, which defaults totrue): Start input as soon as it is available.string_args(of type[string * string], which defaults to[])(unlabeled)(of type{string}): URL to decode.
Methods:
buffer_length(of type() -> float): Get the buffer’s length in seconds.duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.set_url(of type({string}) -> unit): Set the source’s url.shutdown(of type() -> unit): Shutdown the output or source.skip(of type() -> unit): Skip to the next track.start(of type() -> unit): Ask the source or output to start.status(of type() -> string): Return the current status of the source, either “stopped” (the source isn’t trying to relay the HTTP stream), “polling” (attempting to connect to the HTTP stream) or “connected” (connected to , buffering or playing back the stream). 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.url(of type() -> string): Return the source’s current url.
input.harbor
Create a source that receives a http/icecast stream and forwards it as a stream.
Type:
(?id : string?,
?auth : ((
{
address : string,
password : string,
user : string
}) -> bool)?,
?buffer : float, ?debug : bool, ?dumpfile : string?,
?icy : bool, ?icy_metadata_charset : string?,
?log_overfull : bool, ?logfile : string?, ?max : float,
?metadata_charset : string?,
?on_connect : (([string * string]) -> unit),
?on_disconnect : (() -> unit), ?password : string,
?port : int, ?replay_metadata : bool, ?timeout : float,
?user : string, string) -> source('a)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.auth(of type(({address : string, password : string, user : string}) -> bool)?, which defaults tonull): Authentication function. Receives a record with:user,passwordandaddress(client network address) and returnstrueif the user should be granted access for this login. Override any other method if used.buffer(of typefloat, which defaults to12.): Duration of the pre-buffered data. Default value is set to make it possible to usecrossfadetransitions withinput.harbor. You might be able to reduce it but, in this case, make sure to not use the operator withcrossfadeor make sure that it has enough buffered data for it.debug(of typebool, which defaults tofalse): Run in debugging mode by not catching some exceptions.dumpfile(of typestring?, which defaults tonull): Dump stream to file, for debugging purpose. Disabled if null.icy(of typebool, which defaults tofalse): Enable ICY (shoutcast) protocol.icy_metadata_charset(of typestring?, which defaults tonull): ICY (shoutcast) metadata charset. Guessed if null. Default for shoutcast is ISO-8859-1. Set to that value if all your clients send metadata using this charset and automatic detection is not working for you.log_overfull(of typebool, which defaults totrue): Log when the source’s buffer is overfull.logfile(of typestring?, which defaults tonull): Log buffer status to file, for debugging purpose. Disabled if null.max(of typefloat, which defaults to20.): Maximum duration of the buffered data.metadata_charset(of typestring?, which defaults tonull): Metadata charset for non-ICY (shoutcast) source protocols. Guessed if null.on_connect(of type([string * string]) -> unit, which defaults to<fun>): Function to execute when a source is connected. Its receives the list of headers, of the form: (on_disconnect(of type() -> unit, which defaults to<fun>): Functions to execute when a source is disconnectedpassword(of typestring, which defaults to"hackme"): Source password.port(of typeint, which defaults to8005): Port used to connect to the source.replay_metadata(of typebool, which defaults tofalse): Replay last known metadata when switching back to this source. This helps when source has dropped due to temporary connection issues.timeout(of typefloat, which defaults to30.): Timeout for source connectionn.user(of typestring, which defaults to"source"): Source user.(unlabeled)(of typestring): Mountpoint to look for.
Methods:
buffer_length(of type() -> float): Length of the buffer (in seconds).connected_client(of type() -> string?): Returns the address of the client currently connected, if there is one.disconnect(of type() -> unit): Disconnect the client currently connected to the harbor. Does nothing if no client is connected.duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.status(of type() -> string): Current status of the input.stop(of type() -> unit): Stop the input.time(of type() -> float): Get a source’s time, based on its assigned clock.
input.harbor.ssl
Retrieves the given https stream from the harbor.
Type:
(?id : string?,
?auth : ((
{
address : string,
password : string,
user : string
}) -> bool)?,
?buffer : float, ?debug : bool, ?dumpfile : string?,
?icy : bool, ?icy_metadata_charset : string?,
?log_overfull : bool, ?logfile : string?, ?max : float,
?metadata_charset : string?,
?on_connect : (([string * string]) -> unit),
?on_disconnect : (() -> unit), ?password : string,
?port : int, ?replay_metadata : bool, ?timeout : float,
?user : string, string) -> source('a)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.auth(of type(({address : string, password : string, user : string}) -> bool)?, which defaults tonull): Authentication function. Receives a record with:user,passwordandaddress(client network address) and returnstrueif the user should be granted access for this login. Override any other method if used.buffer(of typefloat, which defaults to12.): Duration of the pre-buffered data. Default value is set to make it possible to usecrossfadetransitions withinput.harbor. You might be able to reduce it but, in this case, make sure to not use the operator withcrossfadeor make sure that it has enough buffered data for it.debug(of typebool, which defaults tofalse): Run in debugging mode by not catching some exceptions.dumpfile(of typestring?, which defaults tonull): Dump stream to file, for debugging purpose. Disabled if null.icy(of typebool, which defaults tofalse): Enable ICY (shoutcast) protocol.icy_metadata_charset(of typestring?, which defaults tonull): ICY (shoutcast) metadata charset. Guessed if null. Default for shoutcast is ISO-8859-1. Set to that value if all your clients send metadata using this charset and automatic detection is not working for you.log_overfull(of typebool, which defaults totrue): Log when the source’s buffer is overfull.logfile(of typestring?, which defaults tonull): Log buffer status to file, for debugging purpose. Disabled if null.max(of typefloat, which defaults to20.): Maximum duration of the buffered data.metadata_charset(of typestring?, which defaults tonull): Metadata charset for non-ICY (shoutcast) source protocols. Guessed if null.on_connect(of type([string * string]) -> unit, which defaults to<fun>): Function to execute when a source is connected. Its receives the list of headers, of the form: (on_disconnect(of type() -> unit, which defaults to<fun>): Functions to execute when a source is disconnectedpassword(of typestring, which defaults to"hackme"): Source password.port(of typeint, which defaults to8005): Port used to connect to the source.replay_metadata(of typebool, which defaults tofalse): Replay last known metadata when switching back to this source. This helps when source has dropped due to temporary connection issues.timeout(of typefloat, which defaults to30.): Timeout for source connectionn.user(of typestring, which defaults to"source"): Source user.(unlabeled)(of typestring): Mountpoint to look for.
Methods:
buffer_length(of type() -> float): Length of the buffer (in seconds).connected_client(of type() -> string?): Returns the address of the client currently connected, if there is one.disconnect(of type() -> unit): Disconnect the client currently connected to the harbor. Does nothing if no client is connected.duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.status(of type() -> string): Current status of the input.stop(of type() -> unit): Stop the input.time(of type() -> float): Get a source’s time, based on its assigned clock.
input.hls
Play an HLS stream.
Type:
(?id : string?, {string}) -> source(audio='a, video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of type{string}): Playlist URI.
Methods:
buffer_length(of type() -> float): Get the buffer’s length in seconds.duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.set_url(of type({string}) -> unit): Set the source’s url.shutdown(of type() -> unit): Shutdown the output or source.skip(of type() -> unit): Skip to the next track.start(of type() -> unit): Ask the source or output to start.status(of type() -> string): Return the current status of the source, either “stopped” (the source isn’t trying to relay the HTTP stream), “polling” (attempting to connect to the HTTP stream) or “connected” (connected to , buffering or playing back the stream). 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.url(of type() -> string): Return the source’s current url.
input.hls.native
Play an HLS stream.
Type:
(?id : string?, ?reload : float, string) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.reload(of typefloat, which defaults to10.): How often (in seconds) the playlist should be reloaded.(unlabeled)(of typestring): Playlist URI.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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.
input.http
Create a http stream using ffmpeg
Type:
(?id : string?, ?clock_safe : bool, ?debug : bool,
?float_args : [string * float], ?format : string?,
?int_args : [string * int], ?log_overfull : bool,
?max_buffer : float, ?new_track_on_metadata : bool,
?on_connect : (([string * string]) -> unit),
?on_disconnect : (() -> unit), ?on_start : (() -> unit),
?on_stop : (() -> unit), ?poll_delay : float,
?self_sync : bool, ?start : bool,
?string_args : [string * string], ?timeout : float,
?user_agent : string, {string}) -> source(audio='a,
video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.clock_safe(of typebool, which defaults tofalse): Force the use of a dedicated clockdebug(of typebool, which defaults tofalse): Run in debugging mode, not catching some exceptions.float_args(of type[string * float], which defaults to[])format(of typestring?, which defaults tonull): Force a specific input format. Autodetected when passed a null argumentint_args(of type[string * int], which defaults to[])log_overfull(of typebool, which defaults totrue): Log when the source’s buffer is overfull.max_buffer(of typefloat, which defaults to5.): Maximum uration of buffered datanew_track_on_metadata(of typebool, which defaults totrue): Treat new metadata as new track.on_connect(of type([string * string]) -> unit, which defaults to<fun>): Function to execute when a source is connected. Its receives the list of ICY-specific headers, if available.on_disconnect(of type() -> unit, which defaults to<fun>): Function to excecute when a source is disconnectedon_start(of type() -> unit, which defaults to<fun>): Callback executed when input starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when input stops.poll_delay(of typefloat, which defaults to2.): Polling delay when trying to connect to the stream.self_sync(of typebool, which defaults tofalse): Should the source control its own timing? Set totrueif you are having synchronization issues. Should befalsefor most typical cases.start(of typebool, which defaults totrue): Start input as soon as it is available.string_args(of type[string * string], which defaults to[])timeout(of typefloat, which defaults to10.): Timeout for source connection.user_agent(of typestring, which defaults to"Liquidsoap/2.1.3 (Unix; OCaml 4.14.0)"): User agent.(unlabeled)(of type{string}): URL to decode.
Methods:
buffer_length(of type() -> float): Get the buffer’s length in seconds.duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.set_url(of type({string}) -> unit): Set the source’s url.shutdown(of type() -> unit): Shutdown the output or source.skip(of type() -> unit): Skip to the next track.start(of type() -> unit): Ask the source or output to start.status(of type() -> string): Return the current status of the source, either “stopped” (the source isn’t trying to relay the HTTP stream), “polling” (attempting to connect to the HTTP stream) or “connected” (connected to , buffering or playing back the stream). 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.url(of type() -> string): Return the source’s current url.
input.jack
Get stream from jack.
Type:
(?id : string?, ?buffer_size : int, ?clock_safe : bool,
?fallible : bool, ?on_start : (() -> unit),
?on_stop : (() -> unit), ?server : string,
?start : bool) -> source(audio=pcm('a), video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.buffer_size(of typeint, which defaults to2): Set buffer size, in frames. Must be >= 1.clock_safe(of typebool, which defaults totrue): Force the use of a dedicated clockfallible(of typebool, which defaults tofalse): Allow the source to fail. If set tofalse,startmust betrueandstopmethod raises an error.on_start(of type() -> unit, which defaults to<fun>): Callback executed when input starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when input stops.server(of typestring, which defaults to""): Jack server to connect to.start(of typebool, which defaults totrue): Start input as soon as it is available.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.
input.keyboard.sdl
Play notes from the keyboard.
Type:
(?id : string?, ?velocity : float) -> source(audio='a,
video='b, midi=midi('c))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.velocity(of typefloat, which defaults to0.8): Velocity of notes.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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.
input.oss
Stream from an OSS input device.
Type:
(?id : string?, ?clock_safe : bool, ?device : string,
?fallible : bool, ?on_start : (() -> unit),
?on_stop : (() -> unit), ?start : bool) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.clock_safe(of typebool, which defaults totrue): Force the use of a dedicated clockdevice(of typestring, which defaults to"/dev/dsp"): OSS device to use.fallible(of typebool, which defaults tofalse): Allow the source to fail. If set tofalse,startmust betrueandstopmethod raises an error.on_start(of type() -> unit, which defaults to<fun>): Callback executed when input starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when input stops.start(of typebool, which defaults totrue): Start input as soon as it is available.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.
input.portaudio
Stream from a portaudio input device.
Type:
(?id : string?, ?buflen : int, ?clock_safe : bool,
?device_id : int?, ?fallible : bool, ?latency : float?,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?start : bool) -> source(audio=pcm('a), video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.buflen(of typeint, which defaults to256): Length of a buffer in samples.clock_safe(of typebool, which defaults totrue): Force the use of a dedicated clockdevice_id(of typeint?, which defaults tonull): Device ID. Uses default device ifnull.fallible(of typebool, which defaults tofalse): Allow the source to fail. If set tofalse,startmust betrueandstopmethod raises an error.latency(of typefloat?, which defaults tonull): Device latency. Only used when specifying device ID.on_start(of type() -> unit, which defaults to<fun>): Callback executed when input starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when input stops.start(of typebool, which defaults totrue): Start input as soon as it is available.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.
input.pulseaudio
Stream from a portaudio input device.
Type:
(?id : string?, ?client : string, ?clock_safe : bool,
?clock_safe : bool, ?device : string, ?fallible : bool,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?start : bool) -> source(audio=pcm('a), video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.client(of typestring, which defaults to"liquidsoap")clock_safe(of typebool, which defaults totrue): Force the use of a dedicated clockclock_safe(of typebool, which defaults totrue): Force the use of the dedicated Pulseaudio clock.device(of typestring, which defaults to""): Device to use. Uses default if set to ““.fallible(of typebool, which defaults tofalse): Allow the source to fail. If set tofalse,startmust betrueandstopmethod raises an error.on_start(of type() -> unit, which defaults to<fun>): Callback executed when input starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when input stops.start(of typebool, which defaults totrue): Start input as soon as it is available.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.
input.rtmp
Read an RTMP stream.
Type:
(?id : string?, ?max_buffer : float, ?listen : bool,
{string}) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull)max_buffer(of typefloat, which defaults to5.): Maximum data buffer in secondslisten(of typebool, which defaults totrue): Act as a RTMP server and wait for incoming connection(unlabeled)(of type{string}): URL to read RTMP from, in the formrtmp://IP:PORT/ENDPOINT
Methods:
buffer_length(of type() -> float): Get the buffer’s length in seconds.duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.set_url(of type({string}) -> unit): Set the source’s url.shutdown(of type() -> unit): Shutdown the output or source.skip(of type() -> unit): Skip to the next track.start(of type() -> unit): Ask the source or output to start.status(of type() -> string): Return the current status of the source, either “stopped” (the source isn’t trying to relay the HTTP stream), “polling” (attempting to connect to the HTTP stream) or “connected” (connected to , buffering or playing back the stream). 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.url(of type() -> string): Return the source’s current url.
input.srt
Receive a SRT stream from a distant agent.
Type:
(?id : string?, ?bind_address : string,
?clock_safe : bool, ?connection_timeout : int?,
?content_type : string, ?dump : string, ?host : string,
?log_overfull : bool, ?max : float, ?messageapi : bool,
?mode : string, ?on_connect : (() -> unit),
?on_disconnect : (() -> unit), ?on_start : (() -> unit),
?on_stop : (() -> unit), ?payload_size : int,
?port : int, ?read_timeout : int?, ?start : bool,
?stats_interval : int, ?stats_interval : int?,
?write_timeout : int?) -> source(audio='a, video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.bind_address(of typestring, which defaults to"0.0.0.0"): Address to bind on the local machine. Used only in listener modeclock_safe(of typebool, which defaults totrue): Force the use of a dedicated clockconnection_timeout(of typeint?, which defaults tonull): Timeout, in milliseconds, after which initial connection operations are aborted if no data was received, indefinite ifnull.content_type(of typestring, which defaults to"application/ffmpeg"): Content-Type (mime type) used to find a decoder for the input stream.dump(of typestring, which defaults to""): Dump received data to the given file for debugging. Unused is empty.host(of typestring, which defaults to"localhost"): Address to connect to. Used only in caller mode.log_overfull(of typebool, which defaults totrue): Log when the source’s buffer is overfull.max(of typefloat, which defaults to10.): Maximum duration of the buffered data.messageapi(of typebool, which defaults totrue): Use message apimode(of typestring, which defaults to"listener"): Mode to operate on. One of:"listener"(waits for connection to come in) or"caller"(initiate connection to a remote server)on_connect(of type() -> unit, which defaults to<fun>): Function to execute when connected.on_disconnect(of type() -> unit, which defaults to<fun>): Function to execute when disconnectedon_start(of type() -> unit, which defaults to<fun>): Callback executed when input starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when input stops.payload_size(of typeint, which defaults to1316): Payload size.port(of typeint, which defaults to8000): Port to bind on the local machine (listener mode) or to connect to (caller mode). The termportas used in SRT is occasionally identical to the termUDP port. However SRT offers more flexibility than UDP because it manages ports as its own resources. For example, one port may be shared between various services.read_timeout(of typeint?, which defaults to1000): Timeout, in milliseconds, after which read operations are aborted if no data was received, indefinite ifnull.start(of typebool, which defaults totrue): Start input as soon as it is available.stats_interval(of typeint, which defaults to100): Interval used to collect statisticsstats_interval(of typeint?, which defaults tonull): Interval used to collect internal stats in millisecondswrite_timeout(of typeint?, which defaults to1000): Timeout, in milliseconds, after which write operations are aborted if no data was received, indefinite ifnull.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or source.skip(of type() -> unit): Skip to the next track.start(of type() -> unit): Ask the source or output to start.stats(of type() -> { byteAvailRcvBuf : int, byteAvailSndBuf : int, byteMSS : int, byteRcvBuf : int, byteRcvDrop : int, byteRcvDropTotal : int, byteRcvUndecrypt : int, byteRcvUndecryptTotal : int, byteRecv : int, byteRecvTotal : int, byteRetrans : int, byteRetransTotal : int, byteSent : int, byteSentTotal : int, byteSndBuf : int, byteSndDrop : int, byteSndDropTotal : int, mbpsBandwidth : float, mbpsMaxBW : float, mbpsRecvRate : float, mbpsSendRate : float, msRTT : float, msRcvBuf : int, msRcvTsbPdDelay : int, msSndBuf : int, msSndTsbPdDelay : int, msTimeStamp : int, pktCongestionWindow : int, pktFlightSize : int, pktFlowWindow : int, pktRcvAvgBelatedTime : float, pktRcvBelated : int, pktRcvBuf : int, pktRcvDrop : int, pktRcvDropTotal : int, pktRcvFilterExtra : int, pktRcvFilterExtraTotal : int, pktRcvFilterLoss : int, pktRcvFilterLossTotal : int, pktRcvFilterSupply : int, pktRcvFilterSupplyTotal : int, pktRcvLoss : int, pktRcvLossTotal : int, pktRcvRetrans : int, pktRcvUndecrypt : int, pktRcvUndecryptTotal : int, pktRecv : int, pktRecvACK : int, pktRecvACKTotal : int, pktRecvNAK : int, pktRecvNAKTotal : int, pktRecvTotal : int, pktReorderDistance : int, pktRetrans : int, pktRetransTotal : int, pktSent : int, pktSentACK : int, pktSentACKTotal : int, pktSentNAK : int, pktSentNAKTotal : int, pktSentTotal : int, pktSndBuf : int, pktSndDrop : int, pktSndDropTotal : int, pktSndFilterExtra : int, pktSndFilterExtraTotal : int, pktSndLoss : int, pktSndLossTotal : int, usPktSndPeriod : float, usSndDuration : int, usSndDurationTotal : int}): Statistics.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.
input.v4l2
Stream from a video4linux2 input device, such as a webcam.
Type:
(?id : string?, ?max_buffer : float, ?device : string) ->
source(audio=none, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.max_buffer(of typefloat, which defaults to0.5): Maximum data buffer in secondsdevice(of typestring, which defaults to"/dev/video0"): V4L2 device to use.
native.request.dynamic
Play request dynamically created by a given function.
Type:
(?id : string?, ?available : {bool}, ?prefetch : int,
?retry_delay : {float}, ?timeout : float,
(() -> request?)) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.available(of type{bool}, which defaults totrue): Whether some new requests are available (when set to false, it stops after current playing request).prefetch(of typeint, which defaults to1): How many requests should be queued in advance.retry_delay(of type{float}, which defaults to0.1): Retry after a given time (in seconds) when callback returnsnull.timeout(of typefloat, which defaults to20.): Timeout (in sec.) for a single download.(unlabeled)(of type() -> request?)
Methods:
add(of type(request) -> bool)current(of type() -> request?)duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): Indicate if a source may fail, i.e. may not be ready to stream.fetch(of type() -> bool)id(of type() -> string): Identifier of the source.is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.queue(of type() -> [request])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.set(of type(source(audio='A, video='B, midi='C)) -> unit): Set the source.set_queue(of type([request]) -> unit)skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
noise
Generate audio white noise.
Type:
(?id : string?, ?duration : float?) ->
source(audio=internal('a), video=internal('b),
midi=internal('c))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of typefloat?, which defaults tonull): Duration in seconds (nullmeans infinite).
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
playlist
Read a playlist or a directory and play all files.
Type:
(?id : string?, ?check_next : ((request) -> bool)?,
?prefetch : int, ?loop : bool, ?mime_type : string?,
?mode : string, ?native : bool,
?on_reload : ((string) -> unit), ?prefix : string,
?reload : int, ?reload_mode : string, ?timeout : float,
string) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.check_next(of type((request) -> bool)?, which defaults tonull): Function used to filter next tracks. A candidate track is only validated if the function returns true on it. The function is called before resolution, hence metadata will only be available for requests corresponding to local files. This is typically used to avoid repetitions, but be careful: if the function rejects all attempts, the playlist will enter into a consuming loop and stop playing anything.prefetch(of typeint, which defaults to1): How many requests should be queued in advance.loop(of typebool, which defaults totrue): Loop on the playlist.mime_type(of typestring?, which defaults tonull): Default MIME type for the playlist.nullmeans automatic detection.mode(of typestring, which defaults to"randomize"): Play the files in the playlist either in the order (“normal” mode), or shuffle the playlist each time it is loaded, and play it in this order for a whole round (“randomize” mode), or pick a random file in the playlist each time (“random” mode).native(of typebool, which defaults tofalse): Use native implementation.on_reload(of type(string) -> unit, which defaults to<fun>): Callback called after playlist has reloaded.prefix(of typestring, which defaults to""): Add a constant prefix to all requests. Useful for passing extra information using annotate, or for resolution through a particular protocol, such as replaygain.reload(of typeint, which defaults to0): Amount of time (in seconds or rounds), when applicable, before which the playlist is reloaded; 0 means never.reload_mode(of typestring, which defaults to"seconds"): Unit of the reload parameter, either “never” (never reload the playlist), “rounds”, “seconds” or “watch” (reload the file whenever it is changed).timeout(of typefloat, which defaults to20.): Timeout (in sec.) for a single download.(unlabeled)(of typestring): Playlist URI.
Methods:
add(of type(request) -> bool): Add a request to the queue. Requests are resolved before being added. Returnstrueif the request was successfully added.current(of type() -> request?): Get the request currently being played.duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): Indicate if a source may fail, i.e. may not be ready to stream.fetch(of type() -> bool): Try feeding the queue with a new request. Returnstrueif successful. This method can take long to return and should usually be run in a separate thread.id(of type() -> string): Identifier of the source.is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.length(of type() -> int): Length of the of the playlist (the number of songs it contains).log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.queue(of type() -> [request]): Get the requests currently in the queue.reload(of type(?empty_queue : bool, ?uri : string?) -> unit): Reload the playlist.remaining(of type() -> float): Estimation of remaining time in the current track.remaining_files(of type() -> [string]): Songs remaining to be played.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.set_queue(of type([request]) -> unit): Set the queue of requests. Requests are resolved before being added to the queue. You are responsible for destroying the requests currently in the queue.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
playlist.list
Play a list of files.
Type:
(?id : string?, ?check_next : ((request) -> bool)?,
?prefetch : int, ?loop : bool, ?mode : string,
?native : bool, ?on_loop : (() -> unit),
?on_done : (() -> unit), ?max_fail : int,
?on_fail : (() -> [string])?, ?timeout : float,
[string]) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.check_next(of type((request) -> bool)?, which defaults tonull): Function used to filter next tracks. A candidate track is only validated if the function returns true on it. The function is called before resolution, hence metadata will only be available for requests corresponding to local files. This is typically used to avoid repetitions, but be careful: if the function rejects all attempts, the playlist will enter into a consuming loop and stop playing anything.prefetch(of typeint, which defaults to1): How many requests should be queued in advance.loop(of typebool, which defaults totrue): Loop on the playlist.mode(of typestring, which defaults to"normal"): Play the files in the playlist either in the order (“normal” mode), or shuffle the playlist each time it is loaded, and play it in this order for a whole round (“randomize” mode), or pick a random file in the playlist each time (“random” mode).native(of typebool, which defaults tofalse): Use native implementation.on_loop(of type() -> unit, which defaults to<fun>): Function executed when the playlist is about to loop.on_done(of type() -> unit, which defaults to<fun>): Function executed when the playlist is finished.max_fail(of typeint, which defaults to10): When this number of requests fail to resolve, the whole playlists is considered as failed andon_failis called.on_fail(of type(() -> [string])?, which defaults tonull): Function executed when too many requests failed and returning the contents of a fixed playlist.timeout(of typefloat, which defaults to20.): Timeout (in sec.) for a single download.(unlabeled)(of type[string]): Playlist.
Methods:
add(of type(request) -> bool): Add a request to the queue. Requests are resolved before being added. Returnstrueif the request was successfully added.current(of type() -> request?): Get the request currently being played.duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): Indicate if a source may fail, i.e. may not be ready to stream.fetch(of type() -> bool): Try feeding the queue with a new request. Returnstrueif successful. This method can take long to return and should usually be run in a separate thread.id(of type() -> string): Identifier of the source.is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.queue(of type() -> [request]): Get the requests currently in the queue.reload(of type(?empty_queue : bool, [string]) -> unit): Reload the playlist with given list of songs.remaining(of type() -> float): Estimation of remaining time in the current track.remaining_files(of type() -> [string]): Songs remaining to be played.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.set_queue(of type([request]) -> unit): Set the queue of requests. Requests are resolved before being added to the queue. You are responsible for destroying the requests currently in the queue.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
request.dynamic
Play request dynamically created by a given function.
Type:
(?id : string?, ?available : {bool}, ?prefetch : int,
?retry_delay : {float}, ?timeout : float,
(() -> request?)) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.available(of type{bool}, which defaults totrue): Whether some new requests are available (when set to false, it stops after current playing request).prefetch(of typeint, which defaults to1): How many requests should be queued in advance.retry_delay(of type{float}, which defaults to0.1): Retry after a given time (in seconds) when callback returnsnull.timeout(of typefloat, which defaults to20.): Timeout (in sec.) for a single download.(unlabeled)(of type() -> request?)
Methods:
add(of type(request) -> bool): Add a request to the queue. Requests are resolved before being added. Returnstrueif the request was successfully added.current(of type() -> request?): Get the request currently being played.duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): Indicate if a source may fail, i.e. may not be ready to stream.fetch(of type() -> bool): Try feeding the queue with a new request. Returnstrueif successful. This method can take long to return and should usually be run in a separate thread.id(of type() -> string): Identifier of the source.is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.queue(of type() -> [request]): Get the requests currently in the queue.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.set_queue(of type([request]) -> unit): Set the queue of requests. Requests are resolved before being added to the queue. You are responsible for destroying the requests currently in the queue.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
request.once
Play a request once and become unavailable.
Type:
(?id : string?, ?timeout : float, request) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.timeout(of typefloat, which defaults to20.): Timeout in seconds for resolving the request.(unlabeled)(of typerequest): Request 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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.request(of typerequest): Get the request played by this sourceresolve(of type() -> bool): Resolve the request (this is useful to make sure that the source will be available in advance). This function returnstrueif we were able to successfully perform resolution. You should use this method instead ofrequest.resolveto make sure that the proper content type is decoded from the request.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
saw
Generate a saw wave.
Type:
(?id : string?, ?amplitude : {float}, ?duration : float?,
?{float}) -> source(audio=internal('a),
video=internal('b), midi=internal('c))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.amplitude(of type{float}, which defaults to1.): Maximal value of the waveform.duration(of typefloat?, which defaults tonull): Duration in seconds (nullmeans infinite).(unlabeled)(of type{float}, which defaults to440.): Frequency of the saw.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
sine
Generate a sine wave.
Type:
(?id : string?, ?amplitude : {float}, ?duration : float?,
?{float}) -> source(audio=internal('a),
video=internal('b), midi=internal('c))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.amplitude(of type{float}, which defaults to1.): Maximal value of the waveform.duration(of typefloat?, which defaults tonull): Duration in seconds (nullmeans infinite).(unlabeled)(of type{float}, which defaults to440.): Frequency of the sine.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
single
Loop on a request. It never fails if the request is static, meaning that it can be fetched once. Typically, http, ftp, say requests are static, and time is not.
Type:
(?id : string?, ?fallible : bool, ?prefetch : int,
?timeout : float, string) -> source(audio='a, video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fallible(of typebool, which defaults tofalse): Enforce fallibility of the request.prefetch(of typeint, which defaults to1): How many requests should be queued in advance.timeout(of typefloat, which defaults to20.): Timeout (in sec.) for a single download.(unlabeled)(of typestring): URI where to find the file
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
source.fail
A source that does not produce anything. No silence, no track at all.
Type:
(?id : string?) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
source.fail.init
A source that errors during its initialization phase, used for testing and debugging.
Type:
(?id : string?) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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.
square
Generate a square wave.
Type:
(?id : string?, ?amplitude : {float}, ?duration : float?,
?{float}) -> source(audio=internal('a),
video=internal('b), midi=internal('c))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.amplitude(of type{float}, which defaults to1.): Maximal value of the waveform.duration(of typefloat?, which defaults tonull): Duration in seconds (nullmeans infinite).(unlabeled)(of type{float}, which defaults to440.): Frequency of the square.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.testsrc
Generate a test video.
Type:
(?id : string?, ?height : int, ?width : int) ->
source(audio=internal('a), video=internal('b),
midi=internal('c))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.height(of typeint, which defaults to-1)width(of typeint, which defaults to-1)
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
Source / Liquidsoap
buffer
Create a buffer between two different clocks.
Type:
(?id : string?, ?buffer : float, ?fallible : bool,
?max : float, ?on_start : (() -> unit),
?on_stop : (() -> unit), ?start : bool, source(audio='a,
video='b, midi='c)) -> source(audio='a, video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.buffer(of typefloat, which defaults to1.): Amount of data to pre-buffer, in seconds.fallible(of typebool, which defaults totrue): Allow the child source to fail.max(of typefloat, which defaults to10.): Maximum amount of buffered data, in seconds.on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.start(of typebool, which defaults totrue): Start output as soon as it is available.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
buffer.adaptative
Create a buffer between two different clocks. The speed of the output is adapted so that no buffer underrun or overrun occurs. This wonderful behavior has a cost: the pitch of the sound might be changed a little.
Type:
(?id : string?, ?averaging : float, ?buffer : float,
?fallible : bool, ?limit : float, ?max : float,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?reset : bool, ?start : bool, source(audio=pcm('a),
video='b, midi='c)) -> source(audio=pcm('a), video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.averaging(of typefloat, which defaults to30.): Half-life for the averaging of the buffer size, in seconds.buffer(of typefloat, which defaults to1.): Amount of data to pre-buffer, in seconds.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.limit(of typefloat, which defaults to1.25): Maximum acceleration or deceleration factor.max(of typefloat, which defaults to10.): Maximum amount of buffered data, in seconds.on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.reset(of typebool, which defaults tofalse): Reset speed estimation to 1. when the source becomes available again.start(of typebool, which defaults totrue): Start output as soon as it is available.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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.
Source / MIDI Processing
midi.chord
Generate a chord.
Type:
(?id : string?, ?metadata : string, source(audio='a,
video='b, midi='c)) -> source(audio='d, video='e,
midi=midi(channels=1))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.metadata(of typestring, which defaults to"chord"): Name of the metadata containing the chords.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
midi.merge_all
Merge all MIDI tracks in one.
Type:
(?id : string?, ?track_out : int, source(audio='a,
video='b, midi=midi('c))) -> source(audio='a, video='b,
midi=midi('c))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.track_out(of typeint, which defaults to0): Destination track.(unlabeled)(of typesource(audio='a, video='b, midi=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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
midi.remove
Remove MIDI tracks.
Type:
(?id : string?, [int], source(audio='a, video='b,
midi=midi('c))) -> source(audio='a, video='b,
midi=midi('c))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of type[int]): Tracks to remove.(unlabeled)(of typesource(audio='a, video='b, midi=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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
Source / Output
ffmpeg.filter.audio_video.output
Return a source with audio and video from a filter’s output.
Type:
(?id : string?, ?fps : int?, ffmpeg.filter.graph,
ffmpeg.filter.audio, ffmpeg.filter.video) ->
source(audio=ffmpeg.audio.raw('a),
video=ffmpeg.video.raw('b), midi=none)Arguments:
id(of typestring?, which defaults tonull)fps(of typeint?, which defaults tonull)(unlabeled)(of typeffmpeg.filter.graph): Force the value of the source ID.(unlabeled)(of typeffmpeg.filter.audio): Output frame per seconds. Defaults to global value.(unlabeled)(of typeffmpeg.filter.video)
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
output.alsa
Output the source’s stream to an ALSA output device.
Type:
(?id : string?, ?bufferize : bool, ?clock_safe : bool,
?device : string, ?fallible : bool,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?start : bool, source(audio=pcm('a), video='b, midi='c)) ->
unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.bufferize(of typebool, which defaults totrue): Bufferize outputclock_safe(of typebool, which defaults totrue): Force the use of the dedicated ALSA clockdevice(of typestring, which defaults to"default"): Alsa device to usefallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.start(of typebool, which defaults totrue): Start output as soon as it is available.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.ao
Output stream to local sound card using libao.
Type:
(?id : string?, ?buffer_size : int,
?channels_matrix : string, ?clock_safe : bool,
?driver : string, ?fallible : bool,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?options : [string * string], ?start : bool,
source(audio=pcm('a), video='b, midi='c)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.buffer_size(of typeint, which defaults to2): Set buffer size, in frames.channels_matrix(of typestring, which defaults to""): Output channels matrix, “” for AO’s default.clock_safe(of typebool, which defaults totrue): Use the dedicated AO clock.driver(of typestring, which defaults to""): Driver to be used, “” for AO’s default.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.options(of type[string * string], which defaults to[]): List of parameters, depends on the driver.start(of typebool, which defaults totrue): Start output as soon as it is available.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.dummy
Dummy output for debugging purposes.
Type:
(?id : string?, ?fallible : bool,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?start : bool, source(audio='a, video='b, midi='c)) ->
unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.start(of typebool, which defaults totrue): Start output as soon as it is available.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.external
Send the stream to a process’ standard input.
Type:
(?id : string?, ?fallible : bool, ?flush : bool,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?reopen_delay : float, ?reopen_on_error : bool,
?reopen_on_metadata : bool, ?reopen_when : (() -> bool),
?self_sync : bool, ?start : bool, format('a), {string},
source('a)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.flush(of typebool, which defaults tofalse): Perform a flush after each write.on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.reopen_delay(of typefloat, which defaults to120.): Prevent re-opening within that delay, in seconds.reopen_on_error(of typebool, which defaults tofalse): Re-open if some error occurs.reopen_on_metadata(of typebool, which defaults tofalse): Re-open on every new metadata information.reopen_when(of type() -> bool, which defaults to{false}): When should the output be re-opened.self_sync(of typebool, which defaults tofalse): Set totrueif the process is expected to control the output’s latency. Typical example:ffmpegwith the-recommand-line option.start(of typebool, which defaults totrue): Start output as soon as it is available.(unlabeled)(of typeformat('a))(unlabeled)(of type{string}): Process to pipe data to. Some strftime conversion specifiers are available:%SMHdmY. You can also use$(..)interpolation notation for metadata.(unlabeled)(of typesource('a)): Encoding format.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.reopen(of type() -> unit): Reopen the pipe.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): Shutdown the output or 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.file
Output the source stream to a file.
Type:
(?id : string?, ?append : bool, ?dir_perm : int,
?fallible : bool, ?flush : bool,
?on_close : ((string) -> unit),
?on_start : (() -> unit), ?on_stop : (() -> unit),
?perm : int, ?reopen_delay : float,
?reopen_on_error : bool, ?reopen_on_metadata : bool,
?reopen_when : (() -> bool), ?start : bool, format('a),
{string}, source('a)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.append(of typebool, which defaults tofalse): Do not truncate but append in the file if it exists.dir_perm(of typeint, which defaults to511): Permission of the directories if some have to be created, up to umask. Although you can enter values in octal notation (0oXXX) they will be displayed in decimal (for instance, 0o777 = 78^2 + 78 + 7 = 511).fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.flush(of typebool, which defaults tofalse): Perform a flush after each write.on_close(of type(string) -> unit, which defaults to<fun>): This function will be called for each file, after that it is finished and closed. The filename will be passed as argument.on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.perm(of typeint, which defaults to438): Permission of the file if it has to be created, up to umask. You can and should write this number in octal notation: 0oXXX. The default value is however displayed in decimal (0o666 = 68^2 + 68 + 6 = 438).reopen_delay(of typefloat, which defaults to120.): Prevent re-opening within that delay, in seconds.reopen_on_error(of typebool, which defaults tofalse): Re-open if some error occurs.reopen_on_metadata(of typebool, which defaults tofalse): Re-open on every new metadata information.reopen_when(of type() -> bool, which defaults to{false}): When should the output be re-opened.start(of typebool, which defaults totrue): Start output as soon as it is available.(unlabeled)(of typeformat('a)): Encoding format.(unlabeled)(of type{string}): Filename where to output the stream. Some strftime conversion specifiers are available:%SMHdmY. You can also use$(..)interpolation notation for metadata.(unlabeled)(of typesource('a))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.file.hls
Output the source stream to an HTTP live stream served from a local directory.
Type:
(?id : string?, ?fallible : bool,
?on_file_change : ((state : string, string) -> unit),
?on_start : (() -> unit), ?on_stop : (() -> unit),
?perm : int, ?perms : int, ?persist_at : string?,
?playlist : string, ?prefix : string,
?segment_duration : float,
?segment_name : ((position : int, extname : string,
string) -> string),
?segments : int, ?segments_overhead : int,
?start : bool,
?streams_info : [string *
{
bandwidth : int,
codecs : string,
extname : string,
video_size : (int * int)?
}],
?strict_persist : bool, string, [string * format('a)],
source('a)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.on_file_change(of type(state : string, string) -> unit, which defaults to<fun>): Callback executed when a file changes.stateis one of:"opened","closed"or"deleted", second argument is file path. Typical use: upload files to a CDN when done writing ("close"state and remove when"deleted".on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.perm(of typeint, which defaults to420): Permission of the created files, up to umask. You can and should write this number in octal notation: 0oXXX. The default value is however displayed in decimal (0o666 = 68^2 + 48 + 4 = 412).perms(of typeint, which defaults to493): Default directory rights if created. Default:0o755persist_at(of typestring?, which defaults tonull): Location of the configuration file used to restart the output. Relative paths are assumed to be with regard to the directory for generated file.playlist(of typestring, which defaults to"stream.m3u8"): Playlist name (m3u8 extension is recommended).prefix(of typestring, which defaults to""): Prefix for each files in playlists.segment_duration(of typefloat, which defaults to10.): Segment duration (in seconds).segment_name(of type(position : int, extname : string, string) -> string, which defaults to<fun>): Segment name. Default:fun (~position,~extname,stream_name) -> "#{stream_name}_#{position}.#{extname}"segments(of typeint, which defaults to10): Number of segments per playlist.segments_overhead(of typeint, which defaults to5): Number of segments to keep after they have been featured in the live playlist.start(of typebool, which defaults totrue): Start output as soon as it is available.streams_info(of type[string * { bandwidth : int, codecs : string, extname : string, video_size : (int * int)? }], which defaults to[]): Additional information about the streams. Should be a list of the form:[(stream_name, (bandwidth, codecs, extname, (width, height)?)]. See RFC 6381 for info about codecs. Stream info are required when they cannot be inferred from the encoder.strict_persist(of typebool, which defaults tofalse): Fail if an invalid saved state exists.(unlabeled)(of typestring): Directory for generated files.(unlabeled)(of type[string * format('a)]): List of specifications for each stream: (name, format).(unlabeled)(of typesource('a))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.harbor
Encode and output the stream using the harbor server.
Type:
(?id : string?,
?auth : ((address : string, string, string) -> bool)?,
?buffer : int, ?burst : int, ?chunk : int,
?dumpfile : string?, ?encoding : string,
?fallible : bool, ?format : string,
?headers : [string * string], ?metaint : int,
mount : string,
?on_connect : ((headers : [string * string],
uri : string, protocol : string, string) ->
unit),
?on_disconnect : ((string) -> unit),
?on_start : (() -> unit), ?on_stop : (() -> unit),
?password : string?, ?port : int, ?start : bool,
?timeout : float, ?url : string?, ?user : string?,
format(audio='a, video='b, midi='c), source(audio='a,
video='b, midi='c)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.auth(of type((address : string, string, string) -> bool)?, which defaults tonull): Authentication function.f(~address,login,password)returnstrueif the user should be granted access for this login. When defined,userandpasswordarguments are not taken in account.buffer(of typeint, which defaults to327675): Maximum buffer per-client.burst(of typeint, which defaults to65534): Initial burst of data sent to the client.chunk(of typeint, which defaults to4096): Send data to clients using chunks of at least this length.dumpfile(of typestring?, which defaults tonull): Dump stream to file, for debugging purpose. Disabled if null.encoding(of typestring, which defaults to""): Encoding used to send metadata. If empty, defaults to “ISO-8859-1” for non-ogg formats and “UTF-8” otherwise.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.format(of typestring, which defaults to""): Format, e.g. “audio/ogg”. When empty, the encoder is used to guess.headers(of type[string * string], which defaults to[]): Additional headers.metaint(of typeint, which defaults to8192): Interval used to send ICY metadatamount(of typestring)on_connect(of type(headers : [string * string], uri : string, protocol : string, string) -> unit, which defaults to<fun>): Callback executed when connection is established (takes headers, connection uri, protocol and client’s IP as arguments).on_disconnect(of type(string) -> unit, which defaults to<fun>): Callback executed when connection stops (takes client’s IP as argument).on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.password(of typestring?, which defaults tonull): Password for client connection. Ausermust also be set. We check for this password is checked unless anauthfunction is defined, which is used in this case.port(of typeint, which defaults to8000)start(of typebool, which defaults totrue): Start output as soon as it is available.timeout(of typefloat, which defaults to30.): Timeout for network operations (in seconds).url(of typestring?, which defaults tonull)user(of typestring?, which defaults tonull): User for client connection. You also need to setup apassword.(unlabeled)(of typeformat(audio='a, video='b, midi='c)): Encoding format.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.harbor.hls
Output the source stream to an HTTP live stream served from the harbor HTTP server.
Type:
(?id : string?, ?fallible : bool,
?on_file_change : ((state : string, string) -> unit),
?on_start : (() -> unit), ?on_stop : (() -> unit),
?perm : int, ?perms : int, ?persist_at : string?,
?playlist : string, ?prefix : string,
?segment_duration : float, ?segments : int,
?segments_overhead : int, ?start : bool,
?streams_info : [string *
{
bandwidth : int,
codecs : string,
extname : string,
video_size : (int * int)?
}],
?strict_persist : bool,
?segment_name : ((position : int, extname : string,
string) -> string),
?headers : [string * string], ?port : int,
?path : string, ?tmpdir : string?,
[string * format('a)], source('a)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.on_file_change(of type(state : string, string) -> unit, which defaults to<fun>): Callback executed when a file changes.stateis one of:"opened","closed"or"deleted", second argument is file path. Typical use: upload files to a CDN when done writing ("close"state and remove when"deleted".on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.perm(of typeint, which defaults to420): Permission of the created files, up to umask. You can and should write this number in octal notation: 0oXXX. The default value is however displayed in decimal (0o666 = 68^2 + 48 + 4 = 412).perms(of typeint, which defaults to493): Default directory rights if created. Default:0o755persist_at(of typestring?, which defaults tonull): Location of the configuration file used to restart the output. Relative paths are assumed to be with regard to the directory for generated file.playlist(of typestring, which defaults to"stream.m3u8"): Playlist name (m3u8 extension is recommended).prefix(of typestring, which defaults to""): Prefix for each files in playlists.segment_duration(of typefloat, which defaults to10.): Segment duration (in seconds).segments(of typeint, which defaults to10): Number of segments per playlist.segments_overhead(of typeint, which defaults to5): Number of segments to keep after they have been featured in the live playlist.start(of typebool, which defaults totrue): Start output as soon as it is available.streams_info(of type[string * { bandwidth : int, codecs : string, extname : string, video_size : (int * int)? }], which defaults to[]): Additional information about the streams. Should be a list of the form:[(stream_name, (bandwidth, codecs, extname, (width, height)?)]. See RFC 6381 for info about codecs. Stream info are required when they cannot be inferred from the encoder.strict_persist(of typebool, which defaults tofalse): Fail if an invalid saved state exists.segment_name(of type(position : int, extname : string, string) -> string, which defaults to<fun>): Segment name. Default:fun (~position,~extname,stream_name) -> "#{stream_name}_#{position}.#{extname}"headers(of type[string * string], which defaults to[("Access-Control-Allow-Origin", "*")]): Default response headers.port(of typeint, which defaults to8000): Port for incoming harbor (http) connections.path(of typestring, which defaults to"/"): Base path for hls URIs.tmpdir(of typestring?, which defaults tonull): Directory for generated files.(unlabeled)(of type[string * format('a)]): List of specifications for each stream: (name, format).(unlabeled)(of typesource('a))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.harbor.ssl
Encode and output the stream using the SSL harbor server.
Type:
(?id : string?,
?auth : ((address : string, string, string) -> bool)?,
?buffer : int, ?burst : int, ?chunk : int,
?dumpfile : string?, ?encoding : string,
?fallible : bool, ?format : string,
?headers : [string * string], ?metaint : int,
mount : string,
?on_connect : ((headers : [string * string],
uri : string, protocol : string, string) ->
unit),
?on_disconnect : ((string) -> unit),
?on_start : (() -> unit), ?on_stop : (() -> unit),
?password : string?, ?port : int, ?start : bool,
?timeout : float, ?url : string?, ?user : string?,
format(audio='a, video='b, midi='c), source(audio='a,
video='b, midi='c)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.auth(of type((address : string, string, string) -> bool)?, which defaults tonull): Authentication function.f(~address,login,password)returnstrueif the user should be granted access for this login. When defined,userandpasswordarguments are not taken in account.buffer(of typeint, which defaults to327675): Maximum buffer per-client.burst(of typeint, which defaults to65534): Initial burst of data sent to the client.chunk(of typeint, which defaults to4096): Send data to clients using chunks of at least this length.dumpfile(of typestring?, which defaults tonull): Dump stream to file, for debugging purpose. Disabled if null.encoding(of typestring, which defaults to""): Encoding used to send metadata. If empty, defaults to “ISO-8859-1” for non-ogg formats and “UTF-8” otherwise.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.format(of typestring, which defaults to""): Format, e.g. “audio/ogg”. When empty, the encoder is used to guess.headers(of type[string * string], which defaults to[]): Additional headers.metaint(of typeint, which defaults to8192): Interval used to send ICY metadatamount(of typestring)on_connect(of type(headers : [string * string], uri : string, protocol : string, string) -> unit, which defaults to<fun>): Callback executed when connection is established (takes headers, connection uri, protocol and client’s IP as arguments).on_disconnect(of type(string) -> unit, which defaults to<fun>): Callback executed when connection stops (takes client’s IP as argument).on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.password(of typestring?, which defaults tonull): Password for client connection. Ausermust also be set. We check for this password is checked unless anauthfunction is defined, which is used in this case.port(of typeint, which defaults to8000)start(of typebool, which defaults totrue): Start output as soon as it is available.timeout(of typefloat, which defaults to30.): Timeout for network operations (in seconds).url(of typestring?, which defaults tonull)user(of typestring?, which defaults tonull): User for client connection. You also need to setup apassword.(unlabeled)(of typeformat(audio='a, video='b, midi='c)): Encoding format.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.icecast
Encode and output the stream to an icecast2 or shoutcast server.
Type:
(?id : string?, ?chunked : bool,
?connection_timeout : float, ?description : string?,
?dumpfile : string?, ?encoding : string?,
?fallible : bool, ?format : string, ?genre : string?,
?headers : [string * string], ?host : string,
?icy_id : int, ?icy_metadata : string, ?method : string,
?mount : string, ?name : string,
?on_connect : (() -> unit),
?on_disconnect : (() -> unit),
?on_error : ((string) -> float),
?on_start : (() -> unit), ?on_stop : (() -> unit),
?password : string, ?port : int, ?protocol : string,
?public : bool, ?start : bool, ?timeout : float,
?url : string?, ?user : string?, format('a), source('a)) ->
unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.chunked(of typebool, which defaults tofalse): Used chunked transfer with the ‘http(s)’ protocol.connection_timeout(of typefloat, which defaults to5.): Timeout for establishing network connections (disabled is negative).description(of typestring?, which defaults tonull)dumpfile(of typestring?, which defaults tonull): Dump stream to file, for debugging purpose. Disabled if null.encoding(of typestring?, which defaults tonull): Encoding used to send metadata and stream info (name, genre and description). If null, defaults to “UTF-8” for “http(s)” protocol and “ISO-8859-1” for “icy” protocol.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.format(of typestring, which defaults to""): Format, e.g. “audio/ogg”. When empty, the encoder is used to guess.genre(of typestring?, which defaults tonull)headers(of type[string * string], which defaults to[("User-Agent", "Liquidsoap/2.1.3 (Unix; OCaml 4.14.0)")]): Additional headers.host(of typestring, which defaults to"localhost")icy_id(of typeint, which defaults to1): Shoutcast source ID. Only supported by Shoutcast v2.icy_metadata(of typestring, which defaults to"guess"): Send new metadata using the ICY protocol. One of: “guess”, “true”, “false”method(of typestring, which defaults to"source"): method to use with the ‘http(s)’ protocol. One of: ‘source’, ‘put’ or ‘post’.mount(of typestring, which defaults to"Use [name]"): Source mount point. Mandatory when streaming to icecast.name(of typestring, which defaults to"Use [mount]")on_connect(of type() -> unit, which defaults to<fun>): Callback executed when connection is established.on_disconnect(of type() -> unit, which defaults to<fun>): Callback executed when connection stops.on_error(of type(string) -> float, which defaults tofun (_) -> 3.): Callback executed when an error happens. The callback receives a string representation of the error that occurred and returns a float. If returned value is positive, connection will be tried again after this amount of time (in seconds).on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.password(of typestring, which defaults to"hackme")port(of typeint, which defaults to8000)protocol(of typestring, which defaults to"http"): Protocol of the streaming server: ‘http’ or ‘https’ for Icecast, ‘icy’ for shoutcast.public(of typebool, which defaults totrue)start(of typebool, which defaults totrue): Start output as soon as it is available.timeout(of typefloat, which defaults to30.): Timeout for network read and write.url(of typestring?, which defaults tonull)user(of typestring?, which defaults tonull): User for shout source connection. Defaults to “source” for icecast connections. Useful only in special cases, like with per-mountpoint users.(unlabeled)(of typeformat('a)): Encoding format.(unlabeled)(of typesource('a))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.jack
Output stream to jack.
Type:
(?id : string?, ?buffer_size : int, ?clock_safe : bool,
?fallible : bool, ?on_start : (() -> unit),
?on_stop : (() -> unit), ?server : string,
?start : bool, source(audio=pcm('a), video='b, midi='c)) ->
unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.buffer_size(of typeint, which defaults to2): Set buffer size, in frames.clock_safe(of typebool, which defaults totrue): Force the use of the dedicated bjack clock.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.server(of typestring, which defaults to""): Jack server to connect to.start(of typebool, which defaults totrue): Start output as soon as it is available.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.oss
Output the source’s stream to an OSS output device.
Type:
(?id : string?, ?clock_safe : bool, ?device : string,
?fallible : bool, ?on_start : (() -> unit),
?on_stop : (() -> unit), ?start : bool,
source(audio=pcm('a), video='b, midi='c)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.clock_safe(of typebool, which defaults totrue): Force the use of the dedicated OSS clock.device(of typestring, which defaults to"/dev/dsp"): OSS device to use.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.start(of typebool, which defaults totrue): Start output as soon as it is available.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.portaudio
Output the source’s stream to a portaudio output device.
Type:
(?id : string?, ?buflen : int, ?clock_safe : bool,
?device_id : int?, ?fallible : bool, ?latency : float?,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?start : bool, source(audio=pcm('a), video='b, midi='c)) ->
unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.buflen(of typeint, which defaults to256): Length of a buffer in samples.clock_safe(of typebool, which defaults totrue): Force the use of the dedicated Portaudio clock.device_id(of typeint?, which defaults tonull): Device ID. Uses default device ifnull.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.latency(of typefloat?, which defaults tonull): Device latency. Only used when specifying device ID.on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.start(of typebool, which defaults totrue): Start output as soon as it is available.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.pulseaudio
Output the source’s stream to a portaudio output device.
Type:
(?id : string?, ?client : string, ?clock_safe : bool,
?device : string, ?fallible : bool,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?start : bool, source(audio=pcm('a), video='b, midi='c)) ->
unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.client(of typestring, which defaults to"liquidsoap")clock_safe(of typebool, which defaults totrue): Force the use of the dedicated Pulseaudio clock.device(of typestring, which defaults to""): Device to use. Uses default if set to ““.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.start(of typebool, which defaults totrue): Start output as soon as it is available.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.sdl
Display a video using SDL.
Type:
(?id : string?, ?fallible : bool,
?on_start : (() -> unit), ?on_stop : (() -> unit),
?start : bool, source(audio='a, video=canvas('b),
midi='c)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.start(of typebool, which defaults totrue): Start output as soon as it is available.(unlabeled)(of typesource(audio='a, video=canvas('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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.sdl.has_video
Check whether video output is available with SDL.
Type:
() -> boolArguments:
output.shoutcast
Output to shoutcast.
Type:
(?id : string?, ?chunked : bool,
?connection_timeout : float, ?dumpfile : string?,
?encoding : string?, ?fallible : bool, ?format : string,
?genre : string?, ?host : string, ?icy_id : int,
?icy_metadata : string, ?method : string,
?mount : string, ?name : string,
?on_connect : (() -> unit),
?on_disconnect : (() -> unit),
?on_error : ((string) -> float),
?on_start : (() -> unit), ?on_stop : (() -> unit),
?password : string, ?port : int, ?public : bool,
?start : bool, ?timeout : float, ?url : string?,
?user : string?, ?icy_reset : bool, ?icy_id : int,
?dj : (() -> string), ?aim : string, ?icq : string,
?irc : string, format(audio='a, video='b, midi='c),
source(audio='a, video='b, midi='c)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.chunked(of typebool, which defaults tofalse): Used chunked transfer with the ‘http(s)’ protocol.connection_timeout(of typefloat, which defaults to5.): Timeout for establishing network connections (disabled is negative).dumpfile(of typestring?, which defaults tonull): Dump stream to file, for debugging purpose. Disabled if null.encoding(of typestring?, which defaults tonull): Encoding used to send metadata and stream info (name, genre and description). If null, defaults to “UTF-8” for “http(s)” protocol and “ISO-8859-1” for “icy” protocol.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.format(of typestring, which defaults to""): Format, e.g. “audio/ogg”. When empty, the encoder is used to guess.genre(of typestring?, which defaults tonull)host(of typestring, which defaults to"localhost")icy_id(of typeint, which defaults to1): Shoutcast source ID. Only supported by Shoutcast v2.icy_metadata(of typestring, which defaults to"guess"): Send new metadata using the ICY protocol. One of: “guess”, “true”, “false”method(of typestring, which defaults to"source"): method to use with the ‘http(s)’ protocol. One of: ‘source’, ‘put’ or ‘post’.mount(of typestring, which defaults to"Use [name]"): Source mount point. Mandatory when streaming to icecast.name(of typestring, which defaults to"Use [mount]")on_connect(of type() -> unit, which defaults to<fun>): Callback executed when connection is established.on_disconnect(of type() -> unit, which defaults to<fun>): Callback executed when connection stops.on_error(of type(string) -> float, which defaults tofun (_) -> 3.): Callback executed when an error happens. The callback receives a string representation of the error that occurred and returns a float. If returned value is positive, connection will be tried again after this amount of time (in seconds).on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.password(of typestring, which defaults to"hackme")port(of typeint, which defaults to8000)public(of typebool, which defaults totrue)start(of typebool, which defaults totrue): Start output as soon as it is available.timeout(of typefloat, which defaults to30.): Timeout for network read and write.url(of typestring?, which defaults tonull)user(of typestring?, which defaults tonull): User for shout source connection. Defaults to “source” for icecast connections. Useful only in special cases, like with per-mountpoint users.icy_reset(of typebool, which defaults totrue): Reset shoutcast source buffer upon connecting (necessary for NSV).icy_id(of typeint, which defaults to1): Shoutcast source ID. Only supported by Shoutcast v2.dj(of type() -> string, which defaults to{""}): Callback to set dj name.aim(of typestring, which defaults to"")icq(of typestring, which defaults to"")irc(of typestring, which defaults to"")(unlabeled)(of typeformat(audio='a, video='b, midi='c)): Encoding format. For shoutcast, should be mp3 or AAC(+).(unlabeled)(of typesource(audio='a, video='b, midi='c)): The source to output
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.srt
Send a SRT stream to a distant agent.
Type:
(?id : string?, ?bind_address : string,
?connection_timeout : int?, ?fallible : bool,
?host : string, ?messageapi : bool, ?mode : string,
?on_connect : (() -> unit),
?on_disconnect : (() -> unit), ?on_start : (() -> unit),
?on_stop : (() -> unit), ?payload_size : int,
?port : int, ?read_timeout : int?, ?start : bool,
?stats_interval : int, ?write_timeout : int?,
format(audio='a, video='b, midi='c), source(audio='a,
video='b, midi='c)) -> unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.bind_address(of typestring, which defaults to"0.0.0.0"): Address to bind on the local machine. Used only in listener modeconnection_timeout(of typeint?, which defaults to3000): Timeout, in milliseconds, after which initial connection operations are aborted if no data was received, indefinite ifnull.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.host(of typestring, which defaults to"localhost"): Address to connect to. Used only in caller mode.messageapi(of typebool, which defaults totrue): Use message apimode(of typestring, which defaults to"caller"): Mode to operate on. One of:"listener"(waits for connection to come in) or"caller"(initiate connection to a remote server)on_connect(of type() -> unit, which defaults to<fun>): Function to execute when connected.on_disconnect(of type() -> unit, which defaults to<fun>): Function to execute when disconnectedon_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.payload_size(of typeint, which defaults to1316): Payload size.port(of typeint, which defaults to8000): Port to bind on the local machine (listener mode) or to connect to (caller mode). The termportas used in SRT is occasionally identical to the termUDP port. However SRT offers more flexibility than UDP because it manages ports as its own resources. For example, one port may be shared between various services.read_timeout(of typeint?, which defaults to1000): Timeout, in milliseconds, after which read operations are aborted if no data was received, indefinite ifnull.start(of typebool, which defaults totrue): Start output as soon as it is available.stats_interval(of typeint, which defaults to100): Interval used to collect statisticswrite_timeout(of typeint?, which defaults to1000): Timeout, in milliseconds, after which write operations are aborted if no data was received, indefinite ifnull.(unlabeled)(of typeformat(audio='a, video='b, midi='c)): Encoding format.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or source.skip(of type() -> unit): Skip to the next track.start(of type() -> unit): Ask the source or output to start.stats(of type() -> { byteAvailRcvBuf : int, byteAvailSndBuf : int, byteMSS : int, byteRcvBuf : int, byteRcvDrop : int, byteRcvDropTotal : int, byteRcvUndecrypt : int, byteRcvUndecryptTotal : int, byteRecv : int, byteRecvTotal : int, byteRetrans : int, byteRetransTotal : int, byteSent : int, byteSentTotal : int, byteSndBuf : int, byteSndDrop : int, byteSndDropTotal : int, mbpsBandwidth : float, mbpsMaxBW : float, mbpsRecvRate : float, mbpsSendRate : float, msRTT : float, msRcvBuf : int, msRcvTsbPdDelay : int, msSndBuf : int, msSndTsbPdDelay : int, msTimeStamp : int, pktCongestionWindow : int, pktFlightSize : int, pktFlowWindow : int, pktRcvAvgBelatedTime : float, pktRcvBelated : int, pktRcvBuf : int, pktRcvDrop : int, pktRcvDropTotal : int, pktRcvFilterExtra : int, pktRcvFilterExtraTotal : int, pktRcvFilterLoss : int, pktRcvFilterLossTotal : int, pktRcvFilterSupply : int, pktRcvFilterSupplyTotal : int, pktRcvLoss : int, pktRcvLossTotal : int, pktRcvRetrans : int, pktRcvUndecrypt : int, pktRcvUndecryptTotal : int, pktRecv : int, pktRecvACK : int, pktRecvACKTotal : int, pktRecvNAK : int, pktRecvNAKTotal : int, pktRecvTotal : int, pktReorderDistance : int, pktRetrans : int, pktRetransTotal : int, pktSent : int, pktSentACK : int, pktSentACKTotal : int, pktSentNAK : int, pktSentNAKTotal : int, pktSentTotal : int, pktSndBuf : int, pktSndDrop : int, pktSndDropTotal : int, pktSndFilterExtra : int, pktSndFilterExtraTotal : int, pktSndLoss : int, pktSndLossTotal : int, usPktSndPeriod : float, usSndDuration : int, usSndDurationTotal : int}): Statistics.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.url
Encode and let encoder handle data output. Useful with encoder with
no expected output or to encode to files that need full control from the
encoder, e.g. %ffmpeg with rtmp output.
Type:
(?id : string?, ?fallible : bool,
?on_error : ((error
.{
kind : string,
message : string,
positions : [string]
}) -> unit),
?on_start : (() -> unit), ?on_stop : (() -> unit),
?restart_delay : float?, ?self_sync : bool,
?start : bool, url : string, format('a), source('a)) ->
unitArguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fallible(of typebool, which defaults tofalse): Allow the child source to fail, in which case the output will be stopped until the source is available again.on_error(of type(error .{kind : string, message : string, positions : [string] }) -> unit, which defaults to<fun>): Callback executed when an error occurs.on_start(of type() -> unit, which defaults to<fun>): Callback executed when output starts.on_stop(of type() -> unit, which defaults to<fun>): Callback executed when output stops.restart_delay(of typefloat?, which defaults to2.): If notnull, restart output on errors after the given delay.self_sync(of typebool, which defaults tofalse): Should the source control its own synchronization? Set totruefor output to e.g.rtmpoutput using%ffmpegand etc.start(of typebool, which defaults totrue): Start output as soon as it is available.url(of typestring): Url to output to.(unlabeled)(of typeformat('a)): Encoding format.(unlabeled)(of typesource('a))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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):trueif 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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Shutdown the output or 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.
Source / Sound Processing
bass_boost
Add some bass to the sound.
Type:
(?frequency : {float}, ?gain : {float},
source(audio=pcm('a), video=internal('b),
midi=internal('c))) -> source(audio=pcm('a),
video=internal('b), midi=internal('c))Arguments:
frequency(of type{float}, which defaults to200.): Frequency below which sound is considered as bass.gain(of type{float}, which defaults to10.): Amount of boosting (dB).(unlabeled)(of typesource(audio=pcm('a), video=internal('b), midi=internal('c))): Source whose bass should be boosted
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
compress.multiband
Multiband compression. The list in argument specifies - the
frequency below which we should apply compression (it is
above previous band) - the attack time (ms) - the
release time (ms) - the compression ratio -
the threshold for compression - the gain for
the band
Type:
(?limit : bool, ?wet : {float}, source(audio=pcm('a),
video=internal('b), midi=internal('c)),
['d
.{
attack : {float},
frequency : {float},
gain : {float},
ratio : {float},
release : {float},
threshold : {float}
}]) -> source(audio=pcm('a), video=internal('b),
midi=internal('c))Arguments:
limit(of typebool, which defaults totrue): Also apply limiting to bands.wet(of type{float}, which defaults to1.)(unlabeled)(of typesource(audio=pcm('a), video=internal('b), midi=internal('c))): Parameters for compression bands.(unlabeled)(of type['d .{ attack : {float}, frequency : {float}, gain : {float}, ratio : {float}, release : {float}, threshold : {float} }]): Source on which multiband compression should be applied.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
dry_wet
Mix between dry and wet sources. Useful for testing effects. Typically:
c = interactive.float("wetness", min=0., max=1., 1.)
s = dry_wet(c, s, effect(s))and vary c to hear the difference between the source
without and with the effect.
Type:
(?power : bool, {float}, source(audio=internal('a),
video=internal('b), midi=internal('c)),
source(audio=internal('a), video=internal('b),
midi=internal('c))) -> source(audio=internal('a),
video=internal('b), midi=internal('c))Arguments:
power(of typebool, which defaults tofalse): Iftrueuse constant power mixing.(unlabeled)(of type{float}): Wetness coefficient, from 0 (fully dry) to 1 (fully wet).(unlabeled)(of typesource(audio=internal('a), video=internal('b), midi=internal('c))): Dry source.(unlabeled)(of typesource(audio=internal('a), video=internal('b), midi=internal('c))): Wet source.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
fade.in
Fade the beginning of tracks.
Type:
(?id : string, ?duration : float,
?override_duration : string, ?override_type : string,
?track_sensitive : bool, ?type : string,
source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring, which defaults to"fade.in"): Force the value of the source ID.duration(of typefloat, which defaults to3.): Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.override_duration(of typestring, which defaults to"liq_fade_in"): Metadata field which, if present and containing a float, overrides the ‘duration’ parameter for current track.override_type(of typestring, which defaults to"liq_fade_type"): Metadata field which, if present and correct, overrides the ‘type’ parameter for current track.track_sensitive(of typebool, which defaults totrue): Be track sensitive (iffalsewe only fade in once at the beginning of the track).type(of typestring, which defaults to"lin"): Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
fade.out
Fade the end of tracks.
Type:
(?id : string, ?duration : float,
?override_duration : string, ?override_type : string,
?track_sensitive : bool, ?type : string,
source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring, which defaults to"fade.out"): Force the value of the source ID.duration(of typefloat, which defaults to3.): Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.override_duration(of typestring, which defaults to"liq_fade_out"): Metadata field which, if present and containing a float, overrides the ‘duration’ parameter for current track.override_type(of typestring, which defaults to"liq_fade_type"): Metadata field which, if present and correct, overrides the ‘type’ parameter for current track.track_sensitive(of typebool, which defaults totrue): Be track sensitive (iffalsewe only fade ou once at the beginning of the track).type(of typestring, which defaults to"lin"): Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
fade.skip
Fade when the metadata trigger is received and then skip.
Type:
(?id : string, ?duration : float,
?override_duration : string, ?override_type : string,
?override_skip : string, ?type : string,
source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring, which defaults to"fade.skip"): Force the value of the source ID.duration(of typefloat, which defaults to5.): Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.override_duration(of typestring, which defaults to"liq_fade_skip"): Metadata field which, if present and containing a float, overrides the ‘duration’ parameter for current track.override_type(of typestring, which defaults to"liq_fade_skip"): Metadata field which, if present and correct, overrides the ‘type’ parameter for current track.override_skip(of typestring, which defaults to"liq_skip_meta"): Metadata field which, when present and set to “true”, will trigger the fadetype(of typestring, which defaults to"lin"): Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.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_high
A bandpass filter obtained by chaining a low-pass and a high-pass filter.
Type:
(?id : string?, low : {float}, high : {float},
?q : float, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull)low(of type{float}): Lower frequency of the bandpass filter.high(of type{float}): Higher frequency of the bandpass filter.q(of typefloat, which defaults to1.): Q factor.(unlabeled)(of typesource(audio='a, video='b, midi='c)): Force the value of the source ID.
limit
A limiter. This is a compress with tweaked
parameters.
Type:
(?attack : {float}, ?release : {float}, ?ratio : {float},
?threshold : {float}, ?pre_gain : {float},
?gain : {float}, source(audio=pcm('a), video='b,
midi='c)) -> source(audio=pcm('a), video='b, midi='c)Arguments:
attack(of type{float}, which defaults to50.)release(of type{float}, which defaults to200.)ratio(of type{float}, which defaults to20.)threshold(of type{float}, which defaults to-2.)pre_gain(of type{float}, which defaults to0.)gain(of type{float}, which defaults to0.)(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
mic_filter
Remove low frequencies often produced by microphones.
Type:
(?frequency : float, source(audio=pcm('a), video='b,
midi='c)) -> source(audio=pcm('a), video='b, midi='c)Arguments:
frequency(of typefloat, which defaults to200.): Frequency under which sound should be lowered.(unlabeled)(of typesource(audio=pcm('a), video='b, midi='c)): The input source.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
normalize
Normalization the volume of a stream (this is also called
automatic gain control). Dynamic normalization of the signal is
sometimes the only option (for instance, for live sources), and can make
a listening experience much nicer. However, its dynamic aspect implies
some limitations which can go as far as creating saturation in some
extreme cases. If possible, consider using some track-based
normalization techniques such as those based on ReplayGain. The
implementation of Liquidsoap < 2.0 was renamed to
normalize.old.
Type:
(?id : string?, ?target : {float}, ?up : {float},
?down : {float}, ?gain_min : float, ?gain_max : float,
?lufs : bool, ?lookahead : {float}, ?window : {float},
?threshold : {float}, ?track_sensitive : bool,
?debug : float??, source(audio=pcm('a), video='b,
midi='c)) -> source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.target(of type{float}, which defaults to-13.): Desired RMS (dB).up(of type{float}, which defaults to10.): Characteristic time to go up.down(of type{float}, which defaults to0.1): Characteristic time to go down.gain_min(of typefloat, which defaults to-12.): Minimal gain value (dB).gain_max(of typefloat, which defaults to12.): Maximal gain value (dB).lufs(of typebool, which defaults tofalse): Use LUFS instead of RMS to compute intensity.lookahead(of type{float}, which defaults to0.): How much time to look ahead of the signal (second). Setting a positive value delays the output by the corresponding amount of time.window(of type{float}, which defaults to0.5): Duration of the window used to compute the current RMS power (second).threshold(of type{float}, which defaults to-40.): Minimal RMS for activaing gain control (dB).track_sensitive(of typebool, which defaults totrue)debug(of typefloat??, which defaults tonull): How often to print debug messages, in seconds, useful to finetune the parameters. You should setset("log.level", 5)to see them.(unlabeled)(of typesource(audio=pcm('a), video='b, midi='c)): Source to normalize.
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 typebool): Indicate if a source may fail, i.e. may not be ready to stream.gain(of type() -> float): Current amplification coefficient (in linear scale).id(of type() -> string): Identifier of the source.is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Current rms (in linear scale).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.skip(of type() -> unit): Skip to the next track.target_gain(of type() -> float): Current target amplification coefficient (in linear scale).time(of type() -> float): Get a source’s time, based on its assigned clock.
replaygain
Amplify source tracks according to replaygain metadata. This operator
does not compute itself the replaygain: you can use either
enable_replaygain_metadata or the replaygain:
protocol for this.
Type:
(?id : string?, ?ebu_r128 : bool, source(audio=pcm('a),
video='b, midi='c)) -> source(audio=pcm('a), video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.ebu_r128(of typebool, which defaults totrue): Also amplify according to EBU R128 tags.(unlabeled)(of typesource(audio=pcm('a), video='b, midi='c)): Source to be amplified.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
Source / Sound Synthesis
dssi.register
Register a DSSI plugin.
Type:
(string) -> unitArguments:
(unlabeled)(of typestring): Path of the DSSI plugin file.
dtmf
Generate DTMF tones.
Type:
(?duration : float, ?delay : float, string) ->
source(audio=internal('a), video=internal('b),
midi=internal('c))Arguments:
duration(of typefloat, which defaults to0.1): Duration of a tone (in seconds).delay(of typefloat, which defaults to0.05): Dealy between two successive tones (in seconds).(unlabeled)(of typestring): String describing DTMF tones to generates: it should contains characters 0 to 9, A to D, or * or #.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
synth.all.saw
Saw synthesizer. It creates one synthesizer for each channel.
Type:
(?id : string?, ?attack : float, ?decay : float,
?envelope : bool, ?release : float, ?sustain : float,
source(audio=pcm(mono), video='a,
midi=midi(channels=16))) -> source(audio=pcm(mono),
video='a, midi=midi(channels=16))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.attack(of typefloat, which defaults to0.02): Envelope attack (in seconds).decay(of typefloat, which defaults to0.01): Envelope decay (in seconds).envelope(of typebool, which defaults totrue): Use envelope.release(of typefloat, which defaults to0.01): Envelope release (in seconds).sustain(of typefloat, which defaults to0.9): Envelope sustain level.(unlabeled)(of typesource(audio=pcm(mono), video='a, midi=midi(channels=16)))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
synth.all.sine
Sine synthesizer. It creates one synthesizer for each channel.
Type:
(?id : string?, ?attack : float, ?decay : float,
?envelope : bool, ?release : float, ?sustain : float,
source(audio=pcm(mono), video='a,
midi=midi(channels=16))) -> source(audio=pcm(mono),
video='a, midi=midi(channels=16))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.attack(of typefloat, which defaults to0.02): Envelope attack (in seconds).decay(of typefloat, which defaults to0.01): Envelope decay (in seconds).envelope(of typebool, which defaults totrue): Use envelope.release(of typefloat, which defaults to0.01): Envelope release (in seconds).sustain(of typefloat, which defaults to0.9): Envelope sustain level.(unlabeled)(of typesource(audio=pcm(mono), video='a, midi=midi(channels=16)))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
synth.all.square
Square synthesizer. It creates one synthesizer for each channel.
Type:
(?id : string?, ?attack : float, ?decay : float,
?envelope : bool, ?release : float, ?sustain : float,
source(audio=pcm(mono), video='a,
midi=midi(channels=16))) -> source(audio=pcm(mono),
video='a, midi=midi(channels=16))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.attack(of typefloat, which defaults to0.02): Envelope attack (in seconds).decay(of typefloat, which defaults to0.01): Envelope decay (in seconds).envelope(of typebool, which defaults totrue): Use envelope.release(of typefloat, which defaults to0.01): Envelope release (in seconds).sustain(of typefloat, which defaults to0.9): Envelope sustain level.(unlabeled)(of typesource(audio=pcm(mono), video='a, midi=midi(channels=16)))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
synth.saw
Saw synthesizer.
Type:
(?id : string?, ?attack : float, ?channel : int,
?decay : float, ?envelope : bool, ?release : float,
?sustain : float, ?volume : float,
source(audio=pcm(mono), video='a,
midi=midi(channels=1))) -> source(audio=pcm(mono),
video='a, midi=midi(channels=1))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.attack(of typefloat, which defaults to0.02): Envelope attack (in seconds).channel(of typeint, which defaults to0): MIDI channel to handle.decay(of typefloat, which defaults to0.01): Envelope decay (in seconds).envelope(of typebool, which defaults totrue): Use envelope.release(of typefloat, which defaults to0.05): Envelope release (in seconds).sustain(of typefloat, which defaults to0.9): Envelope sustain level.volume(of typefloat, which defaults to0.3): Initial volume.(unlabeled)(of typesource(audio=pcm(mono), video='a, midi=midi(channels=1)))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
synth.sine
Sine synthesizer.
Type:
(?id : string?, ?attack : float, ?channel : int,
?decay : float, ?envelope : bool, ?release : float,
?sustain : float, ?volume : float,
source(audio=pcm(mono), video='a,
midi=midi(channels=1))) -> source(audio=pcm(mono),
video='a, midi=midi(channels=1))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.attack(of typefloat, which defaults to0.02): Envelope attack (in seconds).channel(of typeint, which defaults to0): MIDI channel to handle.decay(of typefloat, which defaults to0.01): Envelope decay (in seconds).envelope(of typebool, which defaults totrue): Use envelope.release(of typefloat, which defaults to0.05): Envelope release (in seconds).sustain(of typefloat, which defaults to0.9): Envelope sustain level.volume(of typefloat, which defaults to0.3): Initial volume.(unlabeled)(of typesource(audio=pcm(mono), video='a, midi=midi(channels=1)))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
synth.square
Square synthesizer.
Type:
(?id : string?, ?attack : float, ?channel : int,
?decay : float, ?envelope : bool, ?release : float,
?sustain : float, ?volume : float,
source(audio=pcm(mono), video='a,
midi=midi(channels=1))) -> source(audio=pcm(mono),
video='a, midi=midi(channels=1))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.attack(of typefloat, which defaults to0.02): Envelope attack (in seconds).channel(of typeint, which defaults to0): MIDI channel to handle.decay(of typefloat, which defaults to0.01): Envelope decay (in seconds).envelope(of typebool, which defaults totrue): Use envelope.release(of typefloat, which defaults to0.05): Envelope release (in seconds).sustain(of typefloat, which defaults to0.9): Envelope sustain level.volume(of typefloat, which defaults to0.3): Initial volume.(unlabeled)(of typesource(audio=pcm(mono), video='a, midi=midi(channels=1)))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
Source / Track Processing
append
Append an extra track to every track. Set the metadata ‘liq_append’ to ‘false’ to inhibit appending on one track.
Type:
(?id : string?, ?insert_missing : bool, ?merge : bool,
source(audio='a, video='b, midi='c),
(([string * string]) -> source(audio='a, video='b,
midi='c))) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.insert_missing(of typebool, which defaults totrue): Treat track beginnings without metadata as having empty one.merge(of typebool, which defaults tofalse): Merge the track with its appended track.(unlabeled)(of typesource(audio='a, video='b, midi='c))(unlabeled)(of type([string * string]) -> source(audio='a, video='b, midi='c)): Given the metadata, build the source producing the track to append. This source is allowed to fail (produce nothing) if no relevant track is to be appended.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
blank.detect
Calls a given handler when detecting a blank.
Type:
(?id : string?, ?max_blank : float, ?min_noise : float,
?on_noise : (() -> unit), ?start_blank : bool,
?threshold : float, ?track_sensitive : bool,
(() -> unit), source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.max_blank(of typefloat, which defaults to20.): Maximum duration of silence allowed, in seconds.min_noise(of typefloat, which defaults to0.): Minimum duration of noise required to end silence, in seconds.on_noise(of type() -> unit, which defaults to<fun>): Handler called when noise is detected.start_blank(of typebool, which defaults tofalse): Start assuming we have blank.threshold(of typefloat, which defaults to-40.): Power in decibels under which the stream is considered silent.track_sensitive(of typebool, which defaults totrue): Reset blank counter at each track.(unlabeled)(of type() -> unit): Handler called when blank is detected.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.http.is_blank(of type() -> bool): Indicate whether blank was detected.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
blank.eat
Eat blanks, i.e., drop the contents of the stream until it is not blank anymore.
Type:
(?id : string?, ?at_beginning : bool, ?max_blank : float,
?min_noise : float, ?start_blank : bool,
?threshold : float, ?track_sensitive : bool,
source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.at_beginning(of typebool, which defaults tofalse): Only eat at the beginning of a track.max_blank(of typefloat, which defaults to20.): Maximum duration of silence allowed, in seconds.min_noise(of typefloat, which defaults to0.): Minimum duration of noise required to end silence, in seconds.start_blank(of typebool, which defaults tofalse): Start assuming we have blank.threshold(of typefloat, which defaults to-40.): Power in decibels under which the stream is considered silent.track_sensitive(of typebool, which defaults totrue): Reset blank counter at each track.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.http.is_blank(of type() -> bool): Indicate whether blank was detected.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
blank.skip
Skip track when detecting a blank.
Type:
(?id : string?, ?threshold : float, ?max_blank : float,
?min_noise : float, ?track_sensitive : bool,
source(audio=pcm('a), video='b, midi='c)
.{skip : () -> unit}) -> source(audio=pcm('a), video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.threshold(of typefloat, which defaults to-40.): Power in decibels under which the stream is considered silent.max_blank(of typefloat, which defaults to20.): Maximum silence length allowed, in seconds.min_noise(of typefloat, which defaults to0.): Minimum duration of noise required to end silence, in seconds.track_sensitive(of typebool, which defaults totrue): Reset blank counter at each track.(unlabeled)(of typesource(audio=pcm('a), video='b, midi='c) .{skip : () -> unit})
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.http.is_blank(of type() -> bool): Indicate whether blank was detected.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
blank.strip
Make the source unavailable when it is streaming blank.
Type:
(?id : string?, ?max_blank : float, ?min_noise : float,
?start_blank : bool, ?threshold : float,
?track_sensitive : bool, source(audio=pcm('a), video='b,
midi='c)) -> source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.max_blank(of typefloat, which defaults to20.): Maximum duration of silence allowed, in seconds.min_noise(of typefloat, which defaults to0.): Minimum duration of noise required to end silence, in seconds.start_blank(of typebool, which defaults tofalse): Start assuming we have blank.threshold(of typefloat, which defaults to-40.): Power in decibels under which the stream is considered silent.track_sensitive(of typebool, which defaults totrue): Reset blank counter at each track.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.http.is_blank(of type() -> bool): Indicate whether blank was detected.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
chop
Regularly insert track boundaries in a stream (useful for testing tracks).
Type:
(?every : {float}, ?metadata : {[string * string]},
source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)Arguments:
every(of type{float}, which defaults to3.): Duration of a track (in seconds).metadata(of type{[string * string]}, which defaults to[]): Metadata for tracks.(unlabeled)(of typesource(audio='a, video='b, midi='c)): The stream.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
cross.simple
Simple transition for crossfade
Type:
(?fade_in : float, ?fade_out : float,
source(audio=pcm('a), video=internal('b),
midi=internal('c)), source(audio=pcm('a),
video=internal('b), midi=internal('c))) ->
source(audio=pcm('a), video=internal('b),
midi=internal('c))Arguments:
fade_in(of typefloat, which defaults to3.): Fade-in duration, if any.fade_out(of typefloat, which defaults to3.): Fade-out duration, if any.(unlabeled)(of typesource(audio=pcm('a), video=internal('b), midi=internal('c))): Ending track(unlabeled)(of typesource(audio=pcm('a), video=internal('b), midi=internal('c))): Starting track
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
cross.smart
Smart transition for crossfade
Type:
(?log : ((string) -> unit), ?fade_in : float,
?fade_out : float,
?default : ((source(audio=pcm('a), video=internal('b),
midi=internal('c)), source(audio=pcm('a),
video=internal('b), midi=internal('c))) ->
source(audio=pcm('a), video=internal('b),
midi=internal('c))),
?high : float, ?medium : float, ?margin : float, 'd
.{
db_level : float,
metadata : [string * string],
source : source(audio=pcm('a),
video=internal('b),
midi=internal('c))
}, 'e
.{
db_level : float,
metadata : [string * string],
source : source(audio=pcm('a),
video=internal('b),
midi=internal('c))
}) -> source(audio=pcm('a), video=internal('b),
midi=internal('c))Arguments:
log(of type(string) -> unit, which defaults to<fun>): Default loggerfade_in(of typefloat, which defaults to3.): Fade-in duration, if any.fade_out(of typefloat, which defaults to3.): Fade-out duration, if any.default(of type(source(audio=pcm('a), video=internal('b), midi=internal('c)), source(audio=pcm('a), video=internal('b), midi=internal('c))) -> source(audio=pcm('a), video=internal('b), midi=internal('c)), which defaults to<fun>): Smart crossfade: transition used when no rule applies (default: sequence).high(of typefloat, which defaults to-15.): Value, in dB, for loud sound level.medium(of typefloat, which defaults to-32.): Value, in dB, for medium sound level.margin(of typefloat, which defaults to4.): Margin to detect sources that have too different sound level for crossing.(unlabeled)(of type'd .{ db_level : float, metadata : [string * string], source : source(audio=pcm('a), video=internal('b), midi=internal('c)) }): Ending track(unlabeled)(of type'e .{ db_level : float, metadata : [string * string], source : source(audio=pcm('a), video=internal('b), midi=internal('c)) }): Starting track
crossfade
Crossfade between tracks, taking the respective volume levels into account in the choice of the transition.
Type:
(?id : string?, ?duration : float,
?override_duration : string, ?fade_in : float,
?fade_out : float, ?smart : bool,
?default : ((source(audio=pcm('a), video=internal('b),
midi=internal('c)), source(audio=pcm('a),
video=internal('b), midi=internal('c))) ->
source(audio=pcm('a), video=internal('b),
midi=internal('c))),
?high : float, ?medium : float, ?margin : float,
?deduplicate : bool, ?minimum : float, ?width : float,
?conservative : bool, source(audio=pcm('a),
video=internal('b), midi=internal('c))) ->
source(audio=pcm('a), video=internal('b),
midi=internal('c))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of typefloat, which defaults to5.): Duration (in seconds) of buffered data from each track that is used to compute the transition between tracks.override_duration(of typestring, which defaults to"liq_cross_duration"): Metadata field which, if present and containing a float, overrides the ‘duration’ parameter for current track.fade_in(of typefloat, which defaults to3.): Fade-in duration, if any.fade_out(of typefloat, which defaults to3.): Fade-out duration, if any.smart(of typebool, which defaults tofalse): Enable smart crossfadingdefault(of type(source(audio=pcm('a), video=internal('b), midi=internal('c)), source(audio=pcm('a), video=internal('b), midi=internal('c))) -> source(audio=pcm('a), video=internal('b), midi=internal('c)), which defaults to<fun>): Smart crossfade: transition used when no rule applies (default: sequence).high(of typefloat, which defaults to-15.): Smart crossfade: value, in dB, for loud sound level.medium(of typefloat, which defaults to-32.): Smart crossfade: value, in dB, for medium sound level.margin(of typefloat, which defaults to4.): Smart crossfade: margin to detect sources that have too different sound level for crossing.deduplicate(of typebool, which defaults totrue): Crossfade transitions can generate duplicate metadata. Whentrue, the operator removes duplicate metadata from the returned source.minimum(of typefloat, 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.width(of typefloat, which defaults to2.): Width of the volume analysis window.conservative(of typebool, which defaults totrue): Always prepare for a premature end-of-track.(unlabeled)(of typesource(audio=pcm('a), video=internal('b), midi=internal('c))): The input source.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
cue_cut
Start track after a cue in point and stop it at cue out point. The cue points are given as metadata, in seconds from the beginning of tracks.
Type:
(?id : string?, ?cue_in_metadata : string,
?cue_out_metadata : string, ?on_cue_in : (() -> unit),
?on_cue_out : (() -> unit), source(audio='a, video='b,
midi='c)) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.cue_in_metadata(of typestring, which defaults to"liq_cue_in"): Metadata for cue in points.cue_out_metadata(of typestring, which defaults to"liq_cue_out"): Metadata for cue out points.on_cue_in(of type() -> unit, which defaults to<fun>): Callback to execute on cue inon_cue_out(of type() -> unit, which defaults to<fun>): Callback to execute on cue out(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
delay
Make the source unavailable for a given time between tracks.
Type:
(?id : string?, ?initial : bool, {float},
source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.initial(of typebool, which defaults tofalse): Start in unavailable state, as if a track had just finished.(unlabeled)(of type{float}): The source won’t be ready less than this amount of seconds after any end of track(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
drop_metadata
Removes all metadata coming from a source.
Type:
(source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)Arguments:
(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
fallback
At the beginning of each track, select the first ready child.
Type:
(?id : string?, ?override : string,
?replay_metadata : bool, ?track_sensitive : bool,
?transition_length : float,
?transitions : [(source(audio='a, video='b, midi='c),
source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)],
[source(audio='a, video='b, midi='c)]) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.override(of typestring, which defaults to"liq_transition_length"): Metadata field which, if present and containing a float, overrides thetransition_lengthparameter.replay_metadata(of typebool, which defaults totrue): Replay the last metadata of a child when switching to it in the middle of a track.track_sensitive(of typebool, which defaults totrue): Re-select only on end of tracks.transition_length(of typefloat, which defaults to5.): Maximum transition duration.transitions(of type[(source(audio='a, video='b, midi='c), source(audio='a, video='b, midi='c)) -> source(audio='a, video='b, midi='c)], which defaults to[]): Transition functions, padded withfun (x,y) -> yfunctions.(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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).selected(of type() -> source(audio='A, video='B, midi='C)?): Currently selected source.self_sync(of type() -> bool): Is the source currently controling its own real-time loop.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
insert_metadata
Dynamically insert metadata in a stream. Returns the source decorated
with a method insert_metadata which is a function of type
(?new_track,metadata)->unit, used to insert metadata in
the source. This function also inserts a new track with the given
metadata if passed new_track=true.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): Indicate if a source may fail, i.e. may not be ready to stream.id(of type() -> string): Identifier of the source.insert_metadata(of type(?new_track : bool, [string * string]) -> unit): Insert metadata in the source. Thenew_trackparameter indicates whether a track boundary should also be inserted (by default, no track is inserted).is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
map_first_track
Apply a function to the first track of a source
Type:
(?id : string?,
((source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)),
source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of type(source(audio='a, video='b, midi='c)) -> source(audio='a, video='b, midi='c)): The applied function.(unlabeled)(of typesource(audio='a, video='b, midi='c)): The input source.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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).selected(of type() -> source(audio='A, video='B, midi='C)?): Currently selected source.self_sync(of type() -> bool): Is the source currently controling its own real-time loop.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
max_duration
Limit source duration
Type:
(?id : string?, ?override : string, float,
source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.override(of typestring, which defaults to"liq_remaining"): Metadata field which, if present and containing a float, overrides the remaining play time.(unlabeled)(of typefloat): Maximum duration(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
merge_tracks
Merge consecutive tracks from the input source. They will be
considered as one big track, so on_track() will not trigger
for example.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
metadata.artist
Extract artist from metadata.
Type:
([string * string]) -> stringArguments:
(unlabeled)(of type[string * string])
metadata.comment
Extract comment from metadata.
Type:
([string * string]) -> stringArguments:
(unlabeled)(of type[string * string])
metadata.cover
Extract cover from metadata. This function implements cover extraction for the following formats: coverart (ogg) and apic (flac, mp3).
Type:
(?coverart_mime : string?, [string * string]) -> string
.{mime : string}?Arguments:
coverart_mime(of typestring?, which defaults tonull): Mime type to use for"coverart"metadata. Support disasbled ifnull.(unlabeled)(of type[string * string]): Metadata from which the cover should be extracted.
metadata.cover.remove
Remove cover metadata. This is mostly useful in order not to flood logs with coverart when logging metadata.
Type:
([string * 'a]) -> [string * 'a]Arguments:
(unlabeled)(of type[string * 'a])
metadata.deduplicate
Remove duplicate metadata in source
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults to"metadata.deduplicate"): Source id(unlabeled)(of typesource(audio='a, video='b, midi='c)): source
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
metadata.export
Cleanup metadata for export. This is used to remove Liquidsoap’s
internal metadata entries before sending them. List of exported metadata
is set using settings.encoder.metadata.export.set.
Type:
([string * string]) -> [string * string]Arguments:
(unlabeled)(of type[string * string])
metadata.filename
Extract filename from metadata.
Type:
([string * string]) -> stringArguments:
(unlabeled)(of type[string * string])
metadata.map
Rewrite metadata on the fly using a function.
Type:
(?id : string?, ?insert_missing : bool, ?strip : bool,
?update : bool,
(([string * string]) -> [string * string]),
source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.insert_missing(of typebool, which defaults totrue): Treat track beginnings without metadata as having empty ones. The operational order is: create empty if needed, map and strip if enabled.strip(of typebool, which defaults tofalse): Completely remove empty metadata. Operates on both empty values and empty metadata chunk.update(of typebool, which defaults totrue): Update metadata. If false, existing metadata are cleared and only returned values are set as new metadata.(unlabeled)(of type([string * string]) -> [string * string]): A function that returns new metadata.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
metadata.title
Extract title from metadata.
Type:
([string * string]) -> stringArguments:
(unlabeled)(of type[string * string])
mksafe
Turn a source into an infaillible source by adding blank when the source is not available.
Type:
(?id : string, source(audio=internal('a),
video=internal('b), midi=internal('c))) ->
source(audio=internal('a), video=internal('b),
midi=internal('c))Arguments:
id(of typestring, which defaults to"mksafe")(unlabeled)(of typesource(audio=internal('a), video=internal('b), midi=internal('c))): the source to turn infaillible
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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).selected(of type() -> source(audio='A, video='B, midi='C)?): Currently selected source.self_sync(of type() -> bool): Is the source currently controling its own real-time loop.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
on_offset
Call a given handler when position in track is equal or more than a given amount of time.
Type:
(?id : string?, ?force : bool, ?offset : float,
?override : string,
((float, [string * string]) -> unit), source(audio='a,
video='b, midi='c)) -> source(audio='a, video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.force(of typebool, which defaults tofalse): Force execution of callback if track ends before ‘offset’ position has been reached.offset(of typefloat, which defaults to-1.): Execute handler when position in track is equal or more than to this value.override(of typestring, which defaults to"liq_on_offset"): Metadata field which, if present and containing a float, overrides the ‘offset’ parameter.(unlabeled)(of type(float, [string * string]) -> unit): Function to execute. First argument is the actual position within the current track, second is the latest metadata. That function should be fast because it is executed in the main streaming thread.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
once
Creates a source that plays only one track of the input source.
Type:
(source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)Arguments:
(unlabeled)(of typesource(audio='a, video='b, midi='c)): The input source.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
overlap_sources
Rotate between overlapping sources. Next track starts according to ‘liq_start_next’ offset metadata.
Type:
(?id : string?, ?normalize : bool, ?start_next : string,
?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 typestring?, which defaults tonull): Force the value of the source ID.normalize(of typebool, which defaults tofalse)start_next(of typestring, which defaults to"liq_start_next"): Metadata field indicating when the next track should start, relative to current track’s time.weights(of type[{float}], which defaults to[]): Relative weight of the sources in the sum. The empty list stands for the homogeneous distribution.(unlabeled)(of type[source(audio=internal('a), video=internal('b), midi=internal('c))]): Sources to toggle from
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 typebool): Indicate if a source may fail, i.e. may not be ready to stream.id(of type() -> string): Identifier of the source.insert_metadata(of type(?new_track : bool, [string * string]) -> unit): Insert metadata in the source. Thenew_trackparameter indicates whether a track boundary should also be inserted (by default, no track is inserted).is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
playlog
Keep a record of played files. This is primarily useful to know when a song was last played and avoid repetitions.
Type:
(?duration : float, ?persistency : string?,
?hash : (([string * string]) -> string)) -> unitArguments:
duration(of typefloat, which defaults toinf): Duration (in seconds) after which songs are forgotten. By default, songs are not forgotten which means that the playlog will contain all the songs ever played.persistency(of typestring?, which defaults tonull): Set a file name where the values are stored and loaded in case the script is restarted.hash(of type([string * string]) -> string, which defaults to<fun>): Function to extract an identifier from the metadata. By default, the filename is used but we could return the artist to know when a song from a given artist was last played for instance.
Methods:
add(of type([string * string]) -> unit): Record that file with given metadata has been played.last(of type([string * string]) -> float): How long ago a file was played (in seconds),infinityis returned if the song has never been played.
prepend
Prepend an extra track before every track. Set the metadata ‘liq_prepend’ to ‘false’ to inhibit prepending on one track.
Type:
(?id : string?, ?merge : bool, source(audio='a, video='b,
midi='c),
(([string * string]) -> source(audio='a, video='b,
midi='c))) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.merge(of typebool, which defaults tofalse): Merge the track with its appended track.(unlabeled)(of typesource(audio='a, video='b, midi='c))(unlabeled)(of type([string * string]) -> source(audio='a, video='b, midi='c)): Given the metadata, build the source producing the track to prepend. This source is allowed to fail (produce nothing) if no relevant track is to be appended. However, success must be immediate or it will not be taken into account.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
random
At the beginning of every track, select a random ready child.
Type:
(?id : string?, ?override : string,
?replay_metadata : bool, ?transition_length : float,
?transitions : [(source(audio='a, video='b, midi='c),
source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)],
?weights : [{int}],
[source(audio='a, video='b, midi='c)]) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.override(of typestring, which defaults to"liq_transition_length"): Metadata field which, if present and containing a float, overrides thetransition_lengthparameter.replay_metadata(of typebool, which defaults totrue): Replay the last metadata of a child when switching to it in the middle of a track.transition_length(of typefloat, which defaults to5.): Maximum transition duration.transitions(of type[(source(audio='a, video='b, midi='c), source(audio='a, video='b, midi='c)) -> source(audio='a, video='b, midi='c)], which defaults to[]): Transition functions, padded withfun (x,y) -> yfunctions.weights(of type[{int}], which defaults to[]): Weights of the children (padded with 1), defining for each child the probability that it is selected.(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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).selected(of type() -> source(audio='A, video='B, midi='C)?): Currently selected source.self_sync(of type() -> bool): Is the source currently controling its own real-time loop.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
request.player
Create a source on which plays immediately requests given with the
play method.
Type:
(?simultaneous : bool) -> source(audio=internal('a),
video=internal('b), midi=internal('c))Arguments:
simultaneous(of typebool, which defaults totrue): Allow multiple requests to play simultaneously. Iffalsea new request replaces the previous one.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.length(of type() -> int): Number of currently playing requests.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.play(of type(request) -> unit): Play a request.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.set(of type(source(audio=?internal('A), video=?internal('B), midi=?internal('C))) -> unit): Set the source.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
request.queue
Play a queue of requests (the first added request gets played first).
Type:
(?id : string?, ?interactive : bool, ?prefetch : int,
?native : bool, ?queue : [request], ?timeout : float) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.interactive(of typebool, which defaults totrue): Should the queue be controllable via telnet?prefetch(of typeint, which defaults to1): How many requests should be queued in advance.native(of typebool, which defaults tofalse): Use native implementation.queue(of type[request], which defaults to[]): Initial queue of requests.timeout(of typefloat, which defaults to20.): Timeout (in sec.) for a single download.
Methods:
add(of type(request) -> bool): This method is internal and should not be used. Consider usingpushinstead.current(of type() -> request?): Get the request currently being played.duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): Indicate if a source may fail, i.e. may not be ready to stream.fetch(of type() -> bool): Try feeding the queue with a new request. Returnstrueif successful. This method can take long to return and should usually be run in a separate thread.id(of type() -> string): Identifier of the source.is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.length(of type() -> int): Length of the queue.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.push(of type((request) -> unit).{uri : (string) -> unit}): Push a request on the request queue.queue(of type() -> [request]): Get the requests currently in the queue.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.set_queue(of type([request]) -> unit)skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
rotate
Rotate between sources.
Type:
(?id : string?, ?override : string,
?replay_metadata : bool, ?transition_length : float,
?transitions : [(source(audio='a, video='b, midi='c),
source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)],
?weights : [{int}],
[source(audio='a, video='b, midi='c)]) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.override(of typestring, which defaults to"liq_transition_length"): Metadata field which, if present and containing a float, overrides thetransition_lengthparameter.replay_metadata(of typebool, which defaults totrue): Replay the last metadata of a child when switching to it in the middle of a track.transition_length(of typefloat, which defaults to5.): Maximum transition duration.transitions(of type[(source(audio='a, video='b, midi='c), source(audio='a, video='b, midi='c)) -> source(audio='a, video='b, midi='c)], which defaults to[]): Transition functions, padded withfun (x,y) -> yfunctions.weights(of type[{int}], which defaults to[]): Weights of the children (padded with 1), defining for each child how many tracks are played from it per round, if that many are actually available.(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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).selected(of type() -> source(audio='A, video='B, midi='C)?): Currently selected source.self_sync(of type() -> bool): Is the source currently controling its own real-time loop.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
rotate.merge
Same operator as rotate but merges tracks from each sources. For
instance, rotate.merge([intro,main,outro]) creates a source
that plays a sequence [intro,main,outro] as single track
and loops back.
Type:
(?id : string?,
?transitions : [(source(audio=internal('a),
video=internal('b), midi=internal('c)),
source(audio=internal('a),
video=internal('b), midi=internal('c))) ->
source(audio=internal('a),
video=internal('b), midi=internal('c))],
?weights : [{int}],
[source(audio=internal('a), video=internal('b),
midi=internal('c))]) -> source(audio=internal('a),
video=internal('b), midi=internal('c))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.transitions(of type[(source(audio=internal('a), video=internal('b), midi=internal('c)), source(audio=internal('a), video=internal('b), midi=internal('c))) -> source(audio=internal('a), video=internal('b), midi=internal('c))], which defaults to[]): Transition functions, padded withfun (x,y) -> yfunctions.weights(of type[{int}], which defaults to[]): Weights of the children (padded with 1), defining for each child how many tracks are played from it per round, if that many are actually available.(unlabeled)(of type[source(audio=internal('a), video=internal('b), midi=internal('c))]): Sequence of sources to be merged
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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).selected(of type() -> source(audio='A, video='B, midi='C)?): Currently selected source.self_sync(of type() -> bool): Is the source currently controling its own real-time loop.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
sequence
Play only one track of every successive source, except for the last one which is played as much as available.
Type:
(?id : string?, ?merge : bool,
[source(audio='a, video='b, midi='c)]) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.merge(of typebool, which defaults tofalse): Merge tracks when advancing from one source to the next one. This will NOT merge consecutive tracks from the last source; see merge_tracks() if you need that too.(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
server.insert_metadata
Register a server/telnet command to update a source’s metadata. Returns a new source, which will receive the updated metadata. The command has the following format: insert key1=“val1”,key2=“val2”,…
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): Indicate if a source may fail, i.e. may not be ready to stream.id(of type() -> string): Identifier of the source.insert_metadata(of type(?new_track : bool, [string * string]) -> unit): Insert metadata in the source. Thenew_trackparameter indicates whether a track boundary should also be inserted (by default, no track is inserted).is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
source.available
Change the availability of a source depending on a predicate.
Type:
(?id : string?, ?override : bool,
?track_sensitive : {bool}, source(audio='a, video='b,
midi='c), {bool}) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.override(of typebool, which defaults tofalse): Don’t take availability of original source in account (this can be dangerous and should be avoided).track_sensitive(of type{bool}, which defaults tofalse): Change availability only on end of tracks.(unlabeled)(of typesource(audio='a, video='b, midi='c)): Source of which the availability should be changed.(unlabeled)(of type{bool}): Predicate indicating whether the source should be available or not.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
source.dynamic
Dynamically change the underlying source: it can either be changed by
the function given as argument, which returns the source to be played,
or by calling the set method.
Type:
(?id : string?, ?infallible : bool,
?init : source(audio='a, video='b, midi='c)?,
?resurection_time : float?, ?track_sensitive : bool,
?(() -> source(audio='a, video='b, midi='c)?)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.infallible(of typebool, which defaults tofalse): Whether the source is infallible or not (be careful when setting this, it will not be checked by the typing system).init(of typesource(audio='a, video='b, midi='c)?, which defaults tonull): Initial value for the sourceresurection_time(of typefloat?, which defaults to1.): When track sensitive and the source is unavailable, how long we should wait before trying to update source again (nullmeans never).track_sensitive(of typebool, which defaults tofalse): Whether the source should only be updated on track change.(unlabeled)(of type() -> source(audio='a, video='b, midi='c)?, which defaults to<fun>): Function returning the source to be used,nullmeans keep current source.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.set(of type(source(audio='A, video='B, midi='C)) -> unit): Set the 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.
source.frame.duration
Compute the duration of the last frame.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c
.{frame_duration : float})Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): Indicate if a source may fail, i.e. may not be ready to stream.frame_duration(of typefloat): Compute the duration of the last frame.id(of type() -> string): Identifier of the source.is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
source.frame.rms
Compute the rms of the last frame.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c.{frame_rms : float})Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): Indicate if a source may fail, i.e. may not be ready to stream.frame_rms(of typefloat): Compute the rms of the last frame.id(of type() -> string): Identifier of the source.is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
source.on_end
Call a given handler when there is less than a given amount of time remaining before then end of track.
Type:
(?id : string?, ?delay : {float}, source(audio='a,
video='b, midi='c),
((float, [string * string]) -> unit)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.delay(of type{float}, which defaults to5.): Execute handler when remaining time is less or equal to this value.(unlabeled)(of typesource(audio='a, video='b, midi='c))(unlabeled)(of type(float, [string * string]) -> unit): Function to execute. First argument is the remaining time, second is the latest metadata. That function should be fast because it is executed in the main streaming thread.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
source.on_frame
Call a given handler on every frame.
Type:
(?id : string?, source(audio='a, video='b, midi='c),
(() -> unit)) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(audio='a, video='b, midi='c))(unlabeled)(of type() -> unit): Function called on every frame. It should be fast because it is executed in the main streaming thread.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
source.on_metadata
Call a given handler on metadata packets.
Type:
(?id : string?, source(audio='a, video='b, midi='c),
(([string * string]) -> unit)) -> source(audio='a,
video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(audio='a, video='b, midi='c))(unlabeled)(of type([string * string]) -> unit): Function called on every metadata packet in the stream. It should be fast because it is executed in the main streaming thread.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
source.on_track
Call a given handler on new tracks.
Type:
(?id : string?, source(audio='a, video='b, midi='c),
(([string * string]) -> unit)) -> source(audio='a,
video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(audio='a, video='b, midi='c))(unlabeled)(of type([string * string]) -> unit): Function called on every beginning of track in the stream, with the corresponding metadata as argument. If there is no metadata at the beginning of track, the empty list is passed. That function should be fast because it is executed in the main streaming thread.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
source.run
Run a function regularly. This is similar to thread.run
but based on a source internal time instead of the world’s time.
Type:
(source(audio='a, video='b, midi='c), ?delay : float,
?every : float?, (() -> unit)) -> source(audio='a,
video='b, midi='c)Arguments:
(unlabeled)(of typesource(audio='a, video='b, midi='c)): Source whose time is taken as reference.delay(of typefloat, which defaults to0.): Time to wait before the first run (in seconds).every(of typefloat?, which defaults tonull): How often to run the function (in seconds). The function is run once ifnull.(unlabeled)(of type() -> unit): Function to run.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
source.say_metadata
Append speech-synthesized tracks reading the metadata.
Type:
(?id : string?,
?pattern : (([string * string]) -> string),
source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull)pattern(of type([string * string]) -> string, which defaults to<fun>): Pattern to use(unlabeled)(of typesource(audio='a, video='b, midi='c)): The source to use
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
switch
At the beginning of a track, select the first source whose predicate is true.
Type:
(?id : string?, ?all_predicates : bool,
?override : string, ?replay_metadata : bool,
?single : [bool], ?track_sensitive : {bool},
?transition_length : float,
?transitions : [(source(audio='a, video='b, midi='c),
source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)],
[(() -> bool) * source(audio='a, video='b, midi='c)]) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.all_predicates(of typebool, which defaults tofalse): Always evaluate all predicates when re-selecting.override(of typestring, which defaults to"liq_transition_length"): Metadata field which, if present and containing a float, overrides thetransition_lengthparameter.replay_metadata(of typebool, which defaults totrue): Replay the last metadata of a child when switching to it in the middle of a track.single(of type[bool], which defaults to[]): Forbid the selection of a branch for two tracks in a row. The empty list stands for[false,...,false].track_sensitive(of type{bool}, which defaults totrue): Re-select only on end of tracks.transition_length(of typefloat, which defaults to5.): Maximum transition duration.transitions(of type[(source(audio='a, video='b, midi='c), source(audio='a, video='b, midi='c)) -> source(audio='a, video='b, midi='c)], which defaults to[]): Transition functions, padded withfun (x,y) -> yfunctions.(unlabeled)(of type[(() -> bool) * source(audio='a, video='b, midi='c)]): Sources with the predicate telling when they can be played.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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).selected(of type() -> source(audio='A, video='B, midi='C)?): Currently selected source.self_sync(of type() -> bool): Is the source currently controling its own real-time loop.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
Source / Video Processing
ffmpeg.filter.video.output
Return a video source from a filter’s output
Type:
(?id : string?, ?fps : int?, ?pass_metadata : bool,
ffmpeg.filter.graph, ffmpeg.filter.video) ->
source(audio=none, video=ffmpeg.video.raw('a), midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fps(of typeint?, which defaults tonull): Output frame per seconds. Defaults to global valuepass_metadata(of typebool, which defaults tofalse): Pass ffmpeg stream metadata to liquidsoap(unlabeled)(of typeffmpeg.filter.graph)(unlabeled)(of typeffmpeg.filter.video)
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
image
Generate a source from a static image.
Type:
(?id : string?, ?fallible : bool, ?string) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.fallible(of typebool, which defaults tofalse): Whether we are allowed to fail (in case the file is non-existent or invalid).(unlabeled)(of typestring, which defaults to""): Path to the image.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.set(of type(string) -> unit): Change the image.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.add_image
Add a static image on the first video channel.
Type:
(?id : string?, ?width : int?, ?height : int?,
?x : {int}, ?y : {int}, file : string,
source(audio=internal('a), video=internal('b),
midi=internal('c))) -> source(audio=internal('a),
video=internal('b), midi=internal('c))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.width(of typeint?, which defaults tonull): Scale to widthheight(of typeint?, which defaults tonull): Scale to heightx(of type{int}, which defaults to0): x position.y(of type{int}, which defaults to0): y position.file(of typestring): Path to the image file.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.add_subtitle
Add subtitle from metadata.
Type:
(?override : string, ?size : int, ?color : int,
?offset : int, source(audio=?internal('A),
video=canvas('B), midi=?internal('C))) ->
source(audio=?internal('A), video=canvas('B),
midi=?internal('C))Arguments:
override(of typestring, which defaults to"subtitle"): Metadata where subtitle to display are located.size(of typeint, which defaults to18)color(of typeint, which defaults to16777215)offset(of typeint, which defaults to20): Offset in pixels.(unlabeled)(of typesource(audio=?internal('A), video=canvas('B), midi=?internal('C))): Source.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.add_text
Add a text to a stream. Uses the first available operator in: camlimages, SDL, FFmpeg, GStreamer, gd or native. Display a text using the first available operator in: SDL, GStreamer, gd or native. def video.add_text.native = add_text_builder(video.text.native) end
Type:
(?id : string?, ?duration : float?, ?color : int,
?cycle : bool, ?font : string?, ?metadata : string?,
?size : int, ?speed : int, ?x : {int}, ?y : {int},
{string}, source(audio=?internal('A), video=canvas('B),
midi=?internal('C)).{is_ready : () -> bool}) ->
source(audio=?internal('A), video=canvas('B),
midi=?internal('C))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of typefloat?, which defaults tonull)color(of typeint, which defaults to16777215): Text color (in 0xRRGGBB format).cycle(of typebool, which defaults totrue): Cycle text when it reaches left boundary.font(of typestring?, which defaults tonull): Path to ttf font file.metadata(of typestring?, which defaults tonull): Change text on a particular metadata (empty string means disabled).size(of typeint, which defaults to18): Font size.speed(of typeint, which defaults to0): Horizontal speed in pixels per second (0 means no scrolling and update according to x and y in case they are variable).x(of type{int}, which defaults to10): x offset.y(of type{int}, which defaults to10): y offset.(unlabeled)(of type{string}): d Text to display.(unlabeled)(of typesource(audio=?internal('A), video=canvas('B), midi=?internal('C)).{is_ready : () -> bool})
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.add_text.camlimages
Add a text to a stream (camlimages implementation). def video.add_text.native = add_text_builder(video.text.native) end
Type:
(?id : string?, ?duration : float?, ?color : int,
?cycle : bool, ?font : string?, ?metadata : string?,
?size : int, ?speed : int, ?x : {int}, ?y : {int},
{string}, source(audio=?internal('A), video=canvas('B),
midi=?internal('C)).{is_ready : () -> bool}) ->
source(audio=?internal('A), video=canvas('B),
midi=?internal('C))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of typefloat?, which defaults tonull)color(of typeint, which defaults to16777215): Text color (in 0xRRGGBB format).cycle(of typebool, which defaults totrue): Cycle text when it reaches left boundary.font(of typestring?, which defaults tonull): Path to ttf font file.metadata(of typestring?, which defaults tonull): Change text on a particular metadata (empty string means disabled).size(of typeint, which defaults to18): Font size.speed(of typeint, which defaults to0): Horizontal speed in pixels per second (0 means no scrolling and update according to x and y in case they are variable).x(of type{int}, which defaults to10): x offset.y(of type{int}, which defaults to10): y offset.(unlabeled)(of type{string}): d Text to display.(unlabeled)(of typesource(audio=?internal('A), video=canvas('B), midi=?internal('C)).{is_ready : () -> bool})
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.add_text.ffmpeg.internal
Display a text.
Type:
(?id : string?, ?color : int, ?cycle : bool,
?font : string?, ?duration : float?,
?metadata : string?, ?size : int, ?speed : int,
?x : {int}, ?y : {int}, {string}, source(audio=pcm('a),
video=canvas('b), midi=none)) -> source(audio=pcm('c),
video=canvas('d), midi=none)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.color(of typeint, which defaults to16777215): Text color (in 0xRRGGBB format).cycle(of typebool, which defaults totrue): Cycle text when it reaches left boundary.font(of typestring?, which defaults tonull): Path to ttf font file.duration(of typefloat?, which defaults tonull)metadata(of typestring?, which defaults tonull): Change text on a particular metadata (empty string means disabled).size(of typeint, which defaults to18): Font size.speed(of typeint, which defaults to70): Horizontal speed in pixels per second (0 means no scrolling and update according to x and y in case they are variable).x(of type{int}, which defaults to10): x offset.y(of type{int}, which defaults to10): y offset.(unlabeled)(of type{string}): d Text to display.(unlabeled)(of typesource(audio=pcm('a), video=canvas('b), midi=none))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.add_text.ffmpeg.raw
Display a text. Use this operator inside ffmpeg filters with a input source
Type:
(?color : int, ?cycle : bool, ?font : string?,
?metadata : string?, ?size : int, ?speed : int,
?x : {int}, ?y : {int}, graph : ffmpeg.filter.graph,
?{string}, source(audio=none,
video=ffmpeg.video.raw('a), midi=none)) ->
ffmpeg.filter.videoArguments:
color(of typeint, which defaults to16777215): Text color (in 0xRRGGBB format).cycle(of typebool, which defaults totrue): Cycle text when it reaches left boundary.font(of typestring?, which defaults tonull): Path to ttf font file.metadata(of typestring?, which defaults tonull): Change text on a particular metadata (empty string means disabled).size(of typeint, which defaults to18): Font size.speed(of typeint, which defaults to70): Horizontal speed in pixels per second (0 means no scrolling and update according to x and y in case they are variable).x(of type{int}, which defaults to10): x offset.y(of type{int}, which defaults to10): y offset.graph(of typeffmpeg.filter.graph): a ffmpeg filter graph to attach this filter to.(unlabeled)(of type{string}, which defaults to""): d Text to display.(unlabeled)(of typesource(audio=none, video=ffmpeg.video.raw('a), midi=none))
video.add_text.ffmpeg.raw.filter
Display a text. Use this operator inside ffmpeg filters with a ffmpeg
video input Returns a ffmpeg video output with on_change
and on_metadata methods to be used to update the output
text.
Type:
(?color : int, ?cycle : bool, ?font : string?,
?metadata : string?, ?size : int, ?speed : int,
?x : {int}, ?y : {int}, graph : ffmpeg.filter.graph,
?{string}, ffmpeg.filter.video) -> ffmpeg.filter.videoArguments:
color(of typeint, which defaults to16777215): Text color (in 0xRRGGBB format).cycle(of typebool, which defaults totrue): Cycle text when it reaches left boundary.font(of typestring?, which defaults tonull): Path to ttf font file.metadata(of typestring?, which defaults tonull): Change text on a particular metadata (empty string means disabled).size(of typeint, which defaults to18): Font size.speed(of typeint, which defaults to70): Horizontal speed in pixels per second (0 means no scrolling and update according to x and y in case they are variable).x(of type{int}, which defaults to10): x offset.y(of type{int}, which defaults to10): y offset.graph(of typeffmpeg.filter.graph): a ffmpeg filter graph to attach this filter to.(unlabeled)(of type{string}, which defaults to""): d Text to display.(unlabeled)(of typeffmpeg.filter.video)
Methods:
on_change(of type() -> unit)on_metadata(of type([string * string]) -> unit)
video.add_text.native
Add a text to a stream (native implementation). def video.add_text.native = add_text_builder(video.text.native) end
Type:
(?id : string?, ?duration : float?, ?color : int,
?cycle : bool, ?font : string?, ?metadata : string?,
?size : int, ?speed : int, ?x : {int}, ?y : {int},
{string}, source(audio=?internal('A), video=canvas('B),
midi=?internal('C)).{is_ready : () -> bool}) ->
source(audio=?internal('A), video=canvas('B),
midi=?internal('C))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of typefloat?, which defaults tonull)color(of typeint, which defaults to16777215): Text color (in 0xRRGGBB format).cycle(of typebool, which defaults totrue): Cycle text when it reaches left boundary.font(of typestring?, which defaults tonull): Path to ttf font file.metadata(of typestring?, which defaults tonull): Change text on a particular metadata (empty string means disabled).size(of typeint, which defaults to18): Font size.speed(of typeint, which defaults to0): Horizontal speed in pixels per second (0 means no scrolling and update according to x and y in case they are variable).x(of type{int}, which defaults to10): x offset.y(of type{int}, which defaults to10): y offset.(unlabeled)(of type{string}): d Text to display.(unlabeled)(of typesource(audio=?internal('A), video=canvas('B), midi=?internal('C)).{is_ready : () -> bool})
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.add_text.sdl
Add a text to a stream (SDL implementation). def video.add_text.native = add_text_builder(video.text.native) end
Type:
(?id : string?, ?duration : float?, ?color : int,
?cycle : bool, ?font : string?, ?metadata : string?,
?size : int, ?speed : int, ?x : {int}, ?y : {int},
{string}, source(audio=?internal('A), video=canvas('B),
midi=?internal('C)).{is_ready : () -> bool}) ->
source(audio=?internal('A), video=canvas('B),
midi=?internal('C))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of typefloat?, which defaults tonull)color(of typeint, which defaults to16777215): Text color (in 0xRRGGBB format).cycle(of typebool, which defaults totrue): Cycle text when it reaches left boundary.font(of typestring?, which defaults tonull): Path to ttf font file.metadata(of typestring?, which defaults tonull): Change text on a particular metadata (empty string means disabled).size(of typeint, which defaults to18): Font size.speed(of typeint, which defaults to0): Horizontal speed in pixels per second (0 means no scrolling and update according to x and y in case they are variable).x(of type{int}, which defaults to10): x offset.y(of type{int}, which defaults to10): y offset.(unlabeled)(of type{string}): d Text to display.(unlabeled)(of typesource(audio=?internal('A), video=canvas('B), midi=?internal('C)).{is_ready : () -> bool})
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.alpha.movement
Make moving parts visible and non-moving parts transparent. A cheap way to have a bluescreen.
Type:
(?id : string?, ?precision : float, source(audio='a,
video='b, midi='c)) -> source(audio='a, video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.precision(of typefloat, which defaults to0.2): Precision when comparing pixels to those of previous image (between 0 and 1).(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.alpha.of_color
Set a color to be transparent.
Type:
(?id : string?, ?color : int, ?precision : float,
source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.color(of typeint, which defaults to0): Color which should be transparent (in 0xRRGGBB format).precision(of typefloat, which defaults to0.2): Precision in color matching (0. means match precisely the color and 1. means match every color).(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.alpha.remove
Remove α channel.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.alpha.to_y
Convert the α channel to Y channel, thus converting opaque (resp. transparent) pixels to bright (resp. dark) ones. This is useful to observe the α channel.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.bounding_box
Retrieve the origin (methods x / y) and the
dimensions (methods width / height) of the
bounding box of the video.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): Indicate if a source may fail, i.e. may not be ready to stream.height(of type() -> int): Height of video.id(of type() -> string): Identifier of the source.is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.width(of type() -> int): Width of video.x(of type() -> int): x offset of video.y(of type() -> int): y offset of video.
video.cover
Generate a video source containing cover-art for current track of input audio source.
Type:
('b.{on_track : ((([string * string]) -> unit)) -> 'a}) ->
source(audio=none, video='d, midi='e)Arguments:
(unlabeled)(of type'b.{on_track : ((([string * string]) -> unit)) -> 'a}): Audio source whose metadata contain cover-art.
video.crop
Make the bounding box of the current video start at upper left corner. This is useful to place centered videos for instance.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.dimensions
Retrieve the dimensions of the video through the width
and height methods.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): Indicate if a source may fail, i.e. may not be ready to stream.height(of type() -> int): Height of video.id(of type() -> string): Identifier of the source.is_active(of type() -> bool):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.width(of type() -> int): Width of video.
video.fade.in
Fade the beginning of tracks. Metadata ‘liq_video_fade_in’ can be used to set the duration for a specific track (float in seconds).
Type:
(?id : string?, ?duration : float, ?override : string,
?transition : string, ?type : string, source(audio='a,
video=canvas('b), midi='c)) -> source(audio='a,
video=canvas('b), midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of typefloat, which defaults to3.): Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.override(of typestring, which defaults to"liq_video_fade_in"): Metadata field which, if present and containing a float, overrides the ‘duration’ parameter for current track.transition(of typestring, which defaults to"fade"): Kind of transition (fade|slide_left|slide_right|slide_up|slide_down|grow|disc|random).type(of typestring, which defaults to"lin"): Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.(unlabeled)(of typesource(audio='a, video=canvas('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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.fade.out
Fade the end of tracks. Metadata ‘liq_video_fade_out’ can be used to set the duration for a specific track (float in seconds).
Type:
(?id : string?, ?duration : float, ?override : string,
?transition : string, ?type : string, source(audio='a,
video=canvas('b), midi='c)) -> source(audio='a,
video=canvas('b), midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of typefloat, which defaults to3.): Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.override(of typestring, which defaults to"liq_video_fade_out"): Metadata field which, if present and containing a float, overrides the ‘duration’ parameter for current track.transition(of typestring, which defaults to"fade"): Kind of transition (fade|slide_left|slide_right|slide_up|slide_down|grow|disc|random).type(of typestring, which defaults to"lin"): Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.(unlabeled)(of typesource(audio='a, video=canvas('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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.fill
Fill frame with a color.
Type:
(?id : string?, ?color : {int}, source(audio='a,
video='b, midi='c)) -> source(audio='a, video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.color(of type{int}, which defaults to0): Color to fill the image with (0xRRGGBB).(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.frame.height
Height for all video frames.
Type:
() -> intArguments:
video.frame.rate
Framerate for all video frames.
Type:
() -> intArguments:
video.frame.width
Width for all video frames.
Type:
() -> intArguments:
video.greyscale
Convert video to greyscale.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.hmirror
Flip image horizontally.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.invert
Invert video.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.line
Draw a line on the video.
Type:
(?id : string?, ?color : {int}, {int * int}, {int * int},
source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.color(of type{int}, which defaults to16777215): Color to fill the image with (0xRRGGBB).(unlabeled)(of type{int * int}): Start point.(unlabeled)(of type{int * int}): End point.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.lomo
Emulate the “Lomo effect”.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.opacity
Scale opacity of video.
Type:
(?id : string?, {float}, source(audio='a, video='b,
midi='c)) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of type{float}): Coefficient to scale opacity with.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.opacity.box
Set alpha value on a given box inside the image.
Type:
(?id : string?, alpha : {float}, height : {int},
width : {int}, ?x : {int}, ?y : {int}, source(audio='a,
video='b, midi='c)) -> source(audio='a, video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.alpha(of type{float}): alpha value.height(of type{int}): Box height.width(of type{int}): Box width.x(of type{int}, which defaults to0): x offset.y(of type{int}, which defaults to0): y offset.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.persistence
Make images of the video persistent.
Type:
(?id : string?, ?duration : {float}, source(audio='a,
video='b, midi='c)) -> source(audio='a, video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of type{float}, which defaults to1.): Persistence duration in seconds.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.rectangle
Draw a rectangle.
Type:
(?id : string?, ?color : {int}, height : {int},
width : {int}, ?x : {int}, ?y : {int}, source(audio='a,
video='b, midi='c)) -> source(audio='a, video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.color(of type{int}, which defaults to0): Color to fill the image with (0xAARRGGBB).height(of type{int}): Height.width(of type{int}): Width.x(of type{int}, which defaults to0): Horizontal offset.y(of type{int}, which defaults to0): Vertical offset.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.render
Render the video by computing the result of its canvas images.
Type:
(?id : string?, ?transparent : bool, source(audio='a,
video='b, midi='c)) -> source(audio='a, video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.transparent(of typebool, which defaults totrue): Make uncovered portions of the image transparent (they are black by default).(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.resize
Resize and translate video.
Type:
(?id : string?, ?height : {int}?, ?width : {int}?,
?x : {int}, ?y : {int}, source(audio='a, video='b,
midi='c)) -> source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.height(of type{int}?, which defaults tonull): Target height (nullmeans original height).width(of type{int}?, which defaults tonull): Target width (nullmeans original width).x(of type{int}, which defaults to0): x offset.y(of type{int}, which defaults to0): y offset.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.rotate
Rotate video.
Type:
(?id : string?, ?angle : {float}, source(audio='a,
video='b, midi='c)) -> source(audio='a, video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.angle(of type{float}, which defaults to0.): Angle in radians.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.scale
Scale and translate video.
Type:
(?id : string?, ?scale : {float}, ?x : {int},
?xscale : {float}, ?y : {int}, ?yscale : {float},
source(audio='a, video='b, midi='c)) -> source(audio='a,
video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.scale(of type{float}, which defaults to1.): Scaling coefficient in both directions.x(of type{int}, which defaults to0): x offset.xscale(of type{float}, which defaults to1.): x scaling.y(of type{int}, which defaults to0): y offset.yscale(of type{float}, which defaults to1.): y scaling.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.sepia
Convert video to sepia.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.still_frame
Take still frames from a video source by calling the
save method. For now only bitmap output is supported.
Type:
(?id : string?, source(audio='a, video=canvas('b),
midi='c)) -> source(audio='a, video=canvas('b), midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(audio='a, video=canvas('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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.save(of type(string) -> unit): Save current image, argument is the file name to save to.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.testsrc.ffmpeg
A test video source, which generates various patterns.
Type:
(?id : string?, ?pattern : string, ?max_buffer : float,
?duration : 'a?) -> source(audio=none, video=canvas('c),
midi=none)Arguments:
id(of typestring?, which defaults tonull)pattern(of typestring, which defaults to"testsrc"): Pattern drawn in the video:"testsrc","testsrc2","smptebars"or"rgbtestsrc".max_buffer(of typefloat, which defaults to0.5): Maximum data buffer in secondsduration(of type'a?, which defaults tonull): Duration of the source.
video.text
Display a text.
Type:
(?id : string?, ?color : int, ?duration : float?,
?font : string?, ?size : int, {string}) ->
source(audio=?internal('A), video=canvas('B),
midi=?internal('C))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.color(of typeint, which defaults to16777215): Text color (in 0xRRGGBB format).duration(of typefloat?, which defaults tonull): Duration in seconds (nullmeans infinite).font(of typestring?, which defaults tonull): Path to ttf font file.size(of typeint, which defaults to18): Font size.(unlabeled)(of type{string}): Text to display.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.text.camlimages
Display a text.
Type:
(?id : string?, ?color : int, ?duration : float?,
?font : string?, ?size : int, {string}) ->
source(audio='a, video=canvas('b), midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.color(of typeint, which defaults to16777215): Text color (in 0xRRGGBB format).duration(of typefloat?, which defaults tonull): Duration in seconds (nullmeans infinite).font(of typestring?, which defaults tonull): Path to ttf font file.size(of typeint, which defaults to18): Font size.(unlabeled)(of type{string}): Text to display.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.text.gd
Add a text to a stream (GD implementation). def video.add_text.native = add_text_builder(video.text.native) end
Type:
(?id : string?, ?duration : float?, ?color : int,
?cycle : bool, ?font : string?, ?metadata : string?,
?size : int, ?speed : int, ?x : {int}, ?y : {int},
{string}, source(audio=?internal('A), video=canvas('B),
midi=?internal('C)).{is_ready : () -> bool}) ->
source(audio=?internal('A), video=canvas('B),
midi=?internal('C))Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of typefloat?, which defaults tonull)color(of typeint, which defaults to16777215): Text color (in 0xRRGGBB format).cycle(of typebool, which defaults totrue): Cycle text when it reaches left boundary.font(of typestring?, which defaults tonull): Path to ttf font file.metadata(of typestring?, which defaults tonull): Change text on a particular metadata (empty string means disabled).size(of typeint, which defaults to18): Font size.speed(of typeint, which defaults to0): Horizontal speed in pixels per second (0 means no scrolling and update according to x and y in case they are variable).x(of type{int}, which defaults to10): x offset.y(of type{int}, which defaults to10): y offset.(unlabeled)(of type{string}): d Text to display.(unlabeled)(of typesource(audio=?internal('A), video=canvas('B), midi=?internal('C)).{is_ready : () -> bool})
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.text.native
Display a text.
Type:
(?id : string?, ?color : int, ?duration : float?,
?font : string?, ?size : int, {string}) ->
source(audio='a, video=canvas('b), midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.color(of typeint, which defaults to16777215): Text color (in 0xRRGGBB format).duration(of typefloat?, which defaults tonull): Duration in seconds (nullmeans infinite).font(of typestring?, which defaults tonull): Path to ttf font file.size(of typeint, which defaults to18): Font size.(unlabeled)(of type{string}): Text to display.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.text.sdl
Display a text.
Type:
(?id : string?, ?color : int, ?duration : float?,
?font : string?, ?size : int, {string}) ->
source(audio='a, video=canvas('b), midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.color(of typeint, which defaults to16777215): Text color (in 0xRRGGBB format).duration(of typefloat?, which defaults tonull): Duration in seconds (nullmeans infinite).font(of typestring?, which defaults tonull): Path to ttf font file.size(of typeint, which defaults to18): Font size.(unlabeled)(of type{string}): Text to display.
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.tile
Tile sources (same as add but produces tiles of videos).
Type:
(?id : string?, ?normalize : {bool}, ?power : {bool},
?proportional : bool, ?weights : [{float}],
[source(audio='a, video=canvas('b), midi='c)]) ->
source(audio='a, video=canvas('b), midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.normalize(of type{bool}, which defaults totrue)power(of type{bool}, which defaults tofalse): Perform constant-power normalization.proportional(of typebool, which defaults totrue): Scale preserving the proportions.weights(of type[{float}], which defaults to[]): Relative weight of the sources in the sum. The empty list stands for the homogeneous distribution.(unlabeled)(of type[source(audio='a, video=canvas('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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.translate
Translate video.
Type:
(?id : string?, ?x : {int}, ?y : {int}, source(audio='a,
video='b, midi='c)) -> source(audio='a, video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.x(of type{int}, which defaults to0): x offset.y(of type{int}, which defaults to0): y offset.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
Source / Visualization
bpm
Detect the BPM (number of beats per minute). The returned source has
a method bpm, which can be called to compute it.
Type:
(?id : string?, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(audio=pcm('a), video='b, midi='c))
Methods:
bpm(of type() -> float): Compute the current BPM.duration(of type() -> float): Estimation of the duration of the current track.elapsed(of type() -> float): Elapsed time in the current track.fallible(of typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
lufs
Compute current LUFS of the source according to the EBU R128 standard. It returns the source with a method to compute the current value.
Type:
(?id : string?, ?window : {float}, source(audio=pcm('a),
video='b, midi='c)) -> source(audio=pcm('a), video='b,
midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.window(of type{float}, which defaults to3.): Duration of the window (in seconds) used to compute the LUFS.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.lufs(of type() -> float): Current value for the LUFS (short-term value computed over the duration specified by thewindowparameter).lufs_momentary(of type() -> float): Momentary LUFS (over a 400ms window).on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
midi.inspect
Display midi events on standard output.
Type:
(?id : string?, source(audio='a, video='b, midi='c)) ->
source(audio='a, video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
rms.smooth
Compute the current RMS for the source, this varies more smoothly
that rms and is updated more frequently. Returns the source
with a method rms.
Type:
(?id : string?, ?duration : {float},
source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.duration(of type{float}, which defaults to0.5): Duration of the window in seconds (more precisely, this is the time constant of the low-pass filter).(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Current value for the RMS.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
server.rms
Register a command that outputs the RMS of the returned source.
Type:
(?id : string?, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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): Current value for the RMS volume.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
video.volume
Graphical visualization of the sound.
Type:
(?id : string?, source(audio=pcm('a), video='b, midi='c)) ->
source(audio=pcm('a), video='b, midi='c)Arguments:
id(of typestring?, which defaults tonull): Force the value of the source ID.(unlabeled)(of typesource(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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.
String
%
pattern % [...,(k,v),...] changes in the pattern
occurrences of:
$(k)intov- `$(if $(k2),“a”,“b”) into “a” if k2 is found in the list, “b” otherwise.
Type:
(string, [string * string]) -> stringArguments:
(unlabeled)(of typestring)(unlabeled)(of type[string * string])
^
Concatenate strings.
Type:
(string, string) -> stringArguments:
(unlabeled)(of typestring)(unlabeled)(of typestring)
bool_of_string
Convert a string to a bool.
Type:
(?default : bool, string) -> boolArguments:
default(of typebool, which defaults tofalse)(unlabeled)(of typestring)
file.metadata.flac.cover.decode
Decode a flac-encoded cover metadata string
Type:
(string) -> string
.{
color_depth : int,
description : string,
height : int,
mime : string,
number_of_colors : int?,
picture_type : int,
width : int}?Arguments:
(unlabeled)(of typestring)
file.metadata.flac.cover.encode
Encode cover metadata for embedding with flac files
Type:
(picture_type : int, mime : string,
?description : string, width : int, height : int,
color_depth : int, ?number_of_colors : int?, string) ->
stringArguments:
picture_type(of typeint)mime(of typestring)description(of typestring, which defaults to"")width(of typeint)height(of typeint)color_depth(of typeint)number_of_colors(of typeint?, which defaults tonull)(unlabeled)(of typestring)
float_of_string
Convert a string to a float.
Type:
(?default : float, string) -> floatArguments:
default(of typefloat, which defaults to0.)(unlabeled)(of typestring)
int_of_string
Convert a string to a int.
Type:
(?default : int, string) -> intArguments:
default(of typeint, which defaults to0)(unlabeled)(of typestring)
json
Create a generic json object
Type:
() -> jsonArguments:
Methods:
add(of type(string, 'a) -> unit): Add or replace a newkey/valuepair to the object.remove(of type(string) -> unit): Remove a key from the object. Does not nothing if the key does not exist.stringify(of type(?compact : bool, ?json5 : bool) -> string): Render object as json string.
json.stringify
Convert a value to a JSON string.
Type:
(?compact : bool, ?json5 : bool, 'a) -> stringArguments:
compact(of typebool, which defaults tofalse): Output compact text.json5(of typebool, which defaults tofalse): Use JSON5 extended spec.(unlabeled)(of type'a)
metadata.json.parse
Parse metadata from JSON object
Type:
(string) -> [string * string]Arguments:
(unlabeled)(of typestring)
metadata.json.stringify
Export metadata as JSON object. Cover art, if found, is extracted
using metadata.cover and exported with key
"cover" and exported using
string.data_uri.encode.
Type:
(?coverart_mime : string?, ?base64 : bool,
?compact : bool, ?json5 : bool, [string * string]) ->
stringArguments:
coverart_mime(of typestring?, which defaults tonull): Mime type to use for"coverart"metadata. Support disasbled ifnull.base64(of typebool, which defaults totrue)compact(of typebool, which defaults tofalse): Output compact text.json5(of typebool, which defaults tofalse): Use json5 extended spec.(unlabeled)(of type[string * string])
regexp
Create a regular expression
Type:
(?flags : [string], string) -> regexpArguments:
flags(of type[string], which defaults to[]): List of flags. Valid flags:"i","g","s","m".(unlabeled)(of typestring)
Methods:
exec(of type(string) -> [int * string]): Extract substrings from a string. Returns a list of (index,value). If the list does not have a pair associated to some index, it means that the corresponding pattern was not found.replace(of type(((string) -> string), string) -> string): Replace all substrings matched by a pattern by another string returned by a function.split(of type(string) -> [string]): Split a string on the given regular expression.test(of type(string) -> bool): Match a string with the expressionn.
string
Ensure that we have a string (useful for removing fields from strings).
Type:
(string) -> stringArguments:
(unlabeled)(of typestring)
string.annotate.parse
Parse a string of the form
<key>=<value>,...:<uri> as given by the
annotate: protocol
Type:
(string) -> [string * string] * stringArguments:
(unlabeled)(of typestring)
string.base64.decode
Decode a Base64 encoded string.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring)
string.base64.encode
Encode a string in Base64.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring)
string.binary.of_int
Encode a positive (unsigned) integer using native memory representation.
Type:
(?pad : int, ?little_endian : bool, int) -> stringArguments:
pad(of typeint, which defaults to0): Minimum length in digits (pad on the left with zeros in order to reach it)little_endian(of typebool, which defaults totrue): Whether the memory representation is little endian.(unlabeled)(of typeint): String containing the binary representation.
string.binary.to_int
Value of a positive (unsigned) integer encoded using native memory representation.
Type:
(?little_endian : bool, string) -> intArguments:
little_endian(of typebool, which defaults totrue): Whether the memory representation is little endian.(unlabeled)(of typestring): String containing the binary representation.
string.capitalize
Return a string with the first character set to upper case (capitalize), or to lower case (uncapitalize).
Type:
(?capitalize : bool, ?space_sensitive : bool, string) ->
stringArguments:
capitalize(of typebool, which defaults totrue): Capitalize if true, uncapitalize otherwisespace_sensitive(of typebool, which defaults totrue): Capitalize each space separated sub-string.(unlabeled)(of typestring)
string.case
Convert a string to lower or upper case.
Type:
(?lower : bool, string) -> stringArguments:
lower(of typebool, which defaults totrue): Convert to lower case if true and uppercase otherwise.(unlabeled)(of typestring)
string.char
Create a string with one character.
Type:
(int) -> stringArguments:
(unlabeled)(of typeint): Code of the character.
string.char.ascii.random
Return a random ASCII character
Type:
(?[int]) -> stringArguments:
(unlabeled)(of type[int], which defaults to[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127])
string.concat
Concatenate strings.
Type:
(?separator : string, [string]) -> stringArguments:
separator(of typestring, which defaults to"")(unlabeled)(of type[string])
string.contains
Test whether a string contains a given prefix, substring or suffix.
Type:
(?prefix : string, ?substring : string, ?suffix : string,
string) -> boolArguments:
prefix(of typestring, which defaults to""): Prefix to look for.substring(of typestring, which defaults to""): Substring to look for.suffix(of typestring, which defaults to""): Suffix to look for.(unlabeled)(of typestring): The string to look into.
string.data_uri.decode
Decode a string using the data uri format,
i.e. "data:<mime>[;base64],<data>".
Type:
(string) -> string.{mime : string}?Arguments:
(unlabeled)(of typestring)
string.data_uri.encode
Encode a string using the data uri format,
i.e. "data:<mime>[;base64],<data>".
Type:
(?base64 : bool, mime : string, string) -> stringArguments:
base64(of typebool, which defaults totrue): Encode data using the base64 formatmime(of typestring): Data mime type(unlabeled)(of typestring)
string.escape
Escape special characters in an string. By default, the string is
assumed to be "utf8" encoded and is escaped following JSON
and javascript specification.
Type:
(?special_char : ((encoding : string, string) -> bool)?,
?escape_char : ((encoding : string, string) -> string)?,
?encoding : string?, string) -> stringArguments:
special_char(of type((encoding : string, string) -> bool)?, which defaults tonull): Returntrueif the given character (passed as a string) should be escaped. Defaults to control charaters for"utf8"and control characters and any character above\x7E(non-printable characters) for"ascii".escape_char(of type((encoding : string, string) -> string)?, which defaults tonull): Function used to escape a character. Defaults to\xxxoctal notation for"ascii"and\uxxxxhexadecimal notation for"utf8".encoding(of typestring?, which defaults tonull): One of:"ascii"or"utf8". Ifnull,utf8is tried first andasciiis used as a fallback if this fails.(unlabeled)(of typestring)
string.escape.all
Escape each character in the given string using a specific escape sequence
Type:
(?format : string, string) -> stringArguments:
format(of typestring, which defaults to"utf8"): Escape format. One of:"octal","hex"or"utf8".(unlabeled)(of typestring)
string.escape.special_char
Default function to detect characters to escape. See
string.escape for more details.
Type:
(?encoding : string, string) -> boolArguments:
encoding(of typestring, which defaults to"utf8"): One of:"ascii"or"utf8".(unlabeled)(of typestring)
string.extract
Extract substrings from a string. Perl compatible regular expressions
are recognized. Hence, special characters should be escaped. Returns a
list of (index,value). If the list does not have a pair associated to
some index, it means that the corresponding pattern was not found. Alter
natively, one can use the r/_/.exec(_) syntax for regular
expressions.
Type:
(pattern : string, string) -> [int * string]Arguments:
pattern(of typestring)(unlabeled)(of typestring)
string.getter.concat
Combine a list of string getters [g1, ...] and return a
single getter g such that:
string.getter.flush(separator=s, g) = string.concat(separator=s, list.filter(fun (s) -> s != "", [string.getter.flush(g1), ...]))
Type:
([{string}]) -> {string}Arguments:
(unlabeled)(of type[{string}])
string.getter.flush
Flush all values from a string getter and return the concatenated result. If the getter is constant, return the constant string. Otherwise, call the getter repeatedly until it returns an empty string and return the concatenated result
Type:
(?separator : string, {string}) -> stringArguments:
separator(of typestring, which defaults to"")(unlabeled)(of type{string})
string.hex_of_int
Hexadecimal representation of an integer.
Type:
(?pad : int, int) -> stringArguments:
pad(of typeint, which defaults to0): Minimum length in digits (pad on the left with zeros in order to reach it).(unlabeled)(of typeint)
string.id
Generate an identifier with given operator name.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring): Operator name.
string.id.default
Generate an identifier if no identifier was provided.
Type:
(default : string, string?) -> stringArguments:
default(of typestring): Name from which identifier is generated if not present.(unlabeled)(of typestring?): Proposed identifier.
string.is_int
Test whether a string is a valid integer.
Type:
(string) -> boolArguments:
(unlabeled)(of typestring)
string.length
Get the length of a string.
Type:
(string) -> intArguments:
(unlabeled)(of typestring)
string.make
Create a string of a given length using the given character.
Type:
(?char_code : int, int) -> stringArguments:
char_code(of typeint, which defaults to32): Character code.(unlabeled)(of typeint): String length.
string.match
Match a string with an expression. Perl compatible regular
expressions are recognized. Hence, special characters should be escaped.
Alternatively, one can use the the r/_/.test(_) syntax for
regular expressions.
Type:
(pattern : string, string) -> boolArguments:
pattern(of typestring)(unlabeled)(of typestring)
string.nth
Retrieve a character in a string. Raises error.not_found
if character does not exist.
Type:
(string, int) -> intExample:
c = string.nth("abcde", 2)
print(c) # should print "c"Arguments:
(unlabeled)(of typestring): String to look into.(unlabeled)(of typeint): Index of the character.
string.null_terminated
Add a null character at the end of a string.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring): String.
string.quote
Return a quoted copy of the given string. By default, the string is
assumed to be "utf8" encoded and is escaped following JSON
and javascript specification.
Type:
(?encoding : string?, string) -> stringArguments:
encoding(of typestring?, which defaults tonull): One of:"ascii"or"utf8". Ifnull,utf8is tried first andasciiis used as a fallback if this fails.(unlabeled)(of typestring)
string.recode
Convert a string. Effective only if Camomile is enabled.
Type:
(?in_enc : string?, ?out_enc : string, string) -> stringArguments:
in_enc(of typestring?, which defaults tonull): Input encoding. Autodetected if null.out_enc(of typestring, which defaults to"UTF-8"): Output encoding.(unlabeled)(of typestring)
string.replace
Replace all substrings matched by a pattern by another string
returned by a function. Alternatively, one can use the
r/_/g.replace(_) syntax for regular expressions.
Type:
(pattern : string, ((string) -> string), string) ->
stringArguments:
pattern(of typestring): Pattern (regular expression) of substrings which should be replaced.(unlabeled)(of type(string) -> string): Function getting a matched substring an returning the string to replace it with.(unlabeled)(of typestring): String whose substrings should be replaced.
string.split
Split a string at “separator”. Perl compatible regular expressions
are recognized. Hence, special characters should be escaped.
Alternatively, one can use the r/_/.split(_) syntax for
regular expressions.
Type:
(separator : string, string) -> [string]Arguments:
separator(of typestring)(unlabeled)(of typestring)
string.sub
Get a substring of a string. Returns “” if no such substring exists.
Type:
(string, start : int, length : int) -> stringArguments:
(unlabeled)(of typestring)start(of typeint): Return a sub string starting at this position. First position is 0.length(of typeint): Return a sub string oflengthcharacters.
string.to_float
Convert a string to a float.
Type:
(?default : float, string) -> floatArguments:
default(of typefloat, which defaults to0.)(unlabeled)(of typestring)
string.to_int
Convert a string to a int.
Type:
(?default : int, string) -> intArguments:
default(of typeint, which defaults to0)(unlabeled)(of typestring)
string.trim
Return a string without leading and trailing whitespace.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring)
string.unescape
This function is the inverse of string.escape.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring)
string_of
Return the representation of a value.
Type:
(?fields : bool, 'a) -> stringArguments:
fields(of typebool, which defaults tofalse): Show toplevel fields around the value.(unlabeled)(of type'a)
string_of_float
String representation of a float
Type:
(?decimal_places : int?, float) -> stringArguments:
decimal_places(of typeint?, which defaults tonull): Number of decimal places.(unlabeled)(of typefloat)
string_of_metadata
Standard function for displaying metadata. Shows artist and title, using “Unknown” when a field is empty.
Type:
([string * string]) -> stringArguments:
(unlabeled)(of type[string * string]): Metadata packet to be displayed.
time.string
Obtain a string representation of the current time. It takes a string as argument where special strings are replaced roughly following strftime: %H is replaced by the current hour, %M minute, %S second, %A week day (%a week day abbreviated), %d month day, %B month name (%b month name abbreviated), %z timezone.
Type:
(?time : float?, ?string?) -> stringArguments:
time(of typefloat?, which defaults tonull): If specified convert the given time (in seconds since 00:00:00 GMT, Jan. 1, 1970) instead of the current time.(unlabeled)(of typestring?, which defaults tonull): Description of the string to produce, e.g."Current time is %H:%M“`.
url.decode
Decode an encoded url (e.g. “%20” becomes ” “).
Type:
(?plus : bool, string) -> stringArguments:
plus(of typebool, which defaults totrue)(unlabeled)(of typestring)
url.encode
Encode an url (e.g. ” ” becomes “%20”).
Type:
(?plus : bool, string) -> stringArguments:
plus(of typebool, which defaults totrue)(unlabeled)(of typestring)
url.split
Split an url of the form foo?arg=bar&arg2=bar2 into
("foo",[("arg","bar"),("arg2","bar2")]). The returned
strings are decoded (see url.decode).
Type:
(string) -> string * [string * string]Arguments:
(unlabeled)(of typestring): Url to split.
url.split_args
Split the arguments of an url of the form
arg=bar&arg2=bar2 into
[("arg","bar"),("arg2","bar2")]. The returned strings are
decoded (see url.decode).
Type:
(string) -> [string * string]Arguments:
(unlabeled)(of typestring): Argument string to split.
System
argv
Get command-line parameters. The parameters are numbered starting from 1, the zeroth parameter being the script name.
Type:
(?default : string, int) -> stringArguments:
default(of typestring, which defaults to"")(unlabeled)(of typeint)
environment
Return the process environment.
Type:
() -> [string * string]Arguments:
exe_ext
Executable file extension.
Type:
stringArguments:
exit
Immediately stop the application. This should only be used in extreme cases or to specify an exit value. The recommended way of stopping Liquidsoap is to use shutdown.
Type:
(int) -> unitArguments:
(unlabeled)(of typeint): Exit value.
file.cover
Obtain cover-art for a file. An empty string is returned in case there is no such information.
Type:
(string) -> string.{mime : string}?Arguments:
(unlabeled)(of typestring): File from which the cover should be obtained
getenv
Get the value associated to a variable in the process environment. Returns “” if the variable is not set.
Type:
(?default : string, string) -> stringArguments:
default(of typestring, which defaults to"")(unlabeled)(of typestring)
getopt
Parse command line options: getopt("-o") returns “1” if
“-o” was passed without any parameter, “0” otherwise.
getopt(default="X","-o") returns “Y” if “-o Y” was passed,
“X” otherwise. The result is removed from the list of arguments,
affecting subsequent calls to argv() and
getopt().
Type:
(?default : string, string) -> stringArguments:
default(of typestring, which defaults to"")(unlabeled)(of typestring)
getpid
Get the process’ pid.
Type:
() -> intArguments:
on_shutdown
Register a function to be called when Liquidsoap shuts down.
Type:
((() -> unit)) -> unitArguments:
(unlabeled)(of type() -> unit)
on_start
Register a function to be called when Liquidsoap starts.
Type:
((() -> unit)) -> unitArguments:
(unlabeled)(of type() -> unit)
os.type
Type of OS running liquidsoap.
Type:
stringArguments:
process.quote
Return a quoted copy of the given string, suitable for use as one argument in a command line, escaping all meta-characters. Warning: under Windows, the output is only suitable for use with programs that follow the standard Windows quoting conventions.
Type:
(string) -> stringArguments:
(unlabeled)(of typestring): String to escape
process.quote.command
Return a quoted command line, suitable for use as an argument to
process.run.
The optional arguments stdin, stdout and
stderr are file names used to redirect the standard input,
the standard output, or the standard error of the command.
If stdin=f is given, a redirection < f
is performed and the standard input of the command reads from file
f.
If stdout=f is given, a redirection > f
is performed and the standard output of the command is written to file
f.
If stderr=f is given, a redirection 2> f
is performed and the standard error of the command is written to file
f.
If both stdout=f and stderr=f are given,
with the exact same file name f, a 2>&1
redirection is performed so that the standard output and the standard
error of the command are interleaved and redirected to the same file
f.
Type:
(?stdin : string?, ?stdout : string?, ?stderr : string?,
?args : [string], string) -> stringArguments:
stdin(of typestring?, which defaults tonull): command standard inputstdout(of typestring?, which defaults tonull): command standard outputstderr(of typestring?, which defaults tonull): command standard errorargs(of type[string], which defaults to[]): command arguments(unlabeled)(of typestring): Command to execute
process.read
Perform a shell call and return its output.
Type:
(?timeout : float, ?env : [string * string],
?inherit_env : bool, ?log_errors : bool, string) ->
stringArguments:
timeout(of typefloat, which defaults to-1.): Cancel process aftertimeouthas elapsed. Ignored if negative.env(of type[string * string], which defaults to[]): Process environmentinherit_env(of typebool, which defaults totrue): Inherit calling process’s environment whenenvparameter is empty.log_errors(of typebool, which defaults totrue): Log details if the command does not return 0.(unlabeled)(of typestring): Command to run
process.read.lines
Perform a shell call and return the list of its output lines.
Type:
(?timeout : float, ?env : [string * string],
?inherit_env : bool, ?log_errors : bool, string) ->
[string]Arguments:
timeout(of typefloat, which defaults to-1.): Cancel process aftertimeouthas elapsed. Ignored if negative.env(of type[string * string], which defaults to[]): Process environmentinherit_env(of typebool, which defaults totrue): Inherit calling process’s environment whenenvparameter is empty.log_errors(of typebool, which defaults totrue): Log details if the command does not return 0.(unlabeled)(of typestring): Command to run
process.run
Run a process in a shell environment. Returns the standard output, as well as standard error and status as methods. The status can be “exit” (the status code is set), “killed” or “stopped” (the status code is the signal), or “exception” (the description is set) or “timeout” (the description is the run time).
Type:
(?env : [string * string], ?inherit_env : bool,
?rwdirs : [string], ?rodirs : [string],
?network : bool?, ?timeout : float?, string) -> unitArguments:
env(of type[string * string], which defaults to[]): Process environmentinherit_env(of typebool, which defaults totrue): Inherit calling process’s environment whenenvparameter is empty.rwdirs(of type[string], which defaults to["default"]): Read/write directories for sandboxing."default"expands to sandbox default.rodirs(of type[string], which defaults to["default"]): Read-only directories for sandboxing"default"expands to sandbox default.network(of typebool?, which defaults tonull): Enable or disable network inside sandboxed environment (sandbox default if not specified).timeout(of typefloat?, which defaults tonull): Cancel process aftertimeouthas elapsed. Ignored if negative.(unlabeled)(of typestring): Command to run
Methods:
status(of typestring.{code : int, description : string}): Status when process ended, can be one of"exit"(the program exited, thestatuscode is then relevant),"killed"(the program was killed by signal given instatuscode),"stopped"(the program was stopped by signal given instatuscode) or"exception"(the program raised and exception detailed in thedescription).stderr(of typestring): Messages written by process on standard error stream.stdout(of typestring): Messages written by process on standard output stream.
process.test
Return true if process exited with 0 code.
Type:
(?timeout : float, ?env : [string * string],
?inherit_env : bool, string) -> boolArguments:
timeout(of typefloat, which defaults to-1.): Cancel process aftertimeouthas elapsed. Ignored if negative.env(of type[string * string], which defaults to[]): Process environmentinherit_env(of typebool, which defaults totrue): Inherit calling process’s environment whenenvparameter is empty.(unlabeled)(of typestring): Command to test
read
Read some value from standard input (console).
Type:
(?hide : bool) -> stringArguments:
hide(of typebool, which defaults tofalse): Hide typed characters (for passwords).
reopen.stderr
Reopen standard error on the given file
Type:
(string) -> unitArguments:
(unlabeled)(of typestring)
reopen.stdin
Reopen standard input on the given file
Type:
(string) -> unitArguments:
(unlabeled)(of typestring)
reopen.stdout
Reopen standard output on the given file
Type:
(string) -> unitArguments:
(unlabeled)(of typestring)
restart
Restart the application.
Type:
() -> unitArguments:
setenv
Set the value associated to a variable in the process environment.
Type:
(string, string) -> unitArguments:
(unlabeled)(of typestring): Variable to be set.(unlabeled)(of typestring): Value to set.
shutdown
Shutdown the application.
Type:
(?code : int) -> unitArguments:
code(of typeint, which defaults to0): Exit code. Default:0
sleep
Interrupt execution for a given amount of seconds. This freezes the calling thread and should not be used in the main streaming loop.
Type:
(float) -> unitArguments:
(unlabeled)(of typefloat): Number of seconds of sleep.
source.is_up
Check whether a source is up.
Type:
(source('a)) -> boolArguments:
(unlabeled)(of typesource('a))
source.on_leave
Register a function to be called when source is not used anymore by another source.
Type:
(source('a), (() -> unit)) -> unitArguments:
(unlabeled)(of typesource('a))(unlabeled)(of type() -> unit)
source.on_shutdown
Register a function to be called when source shuts down.
Type:
(source('a), (() -> unit)) -> unitArguments:
(unlabeled)(of typesource('a))(unlabeled)(of type() -> unit)
thread.when
Execute a given action when a predicate is true.
Type:
(?fast : bool, ?every : float, ?once : bool,
?changed : bool, (() -> bool), (() -> unit)) -> unitArguments:
fast(of typebool, which defaults totrue)every(of typefloat, which defaults to1.): How often (in sec.) to check for the predicate.once(of typebool, which defaults tofalse): Execute the function only once.changed(of typebool, which defaults totrue): Execute the function only if the predicate was false when last checked.(unlabeled)(of type() -> bool): Predicate indicating when to execute the function, typically a time interval such as{10h-10h30}.(unlabeled)(of type() -> unit): Function to execute when the predicate is true.
time
Return the current time since 00:00:00 GMT, Jan. 1, 1970, in seconds.
Type:
() -> floatArguments:
time.local
Convert a time in seconds into a date in the local time zone (current time is used if no argument is provided).
Type:
(?float?) -> unitArguments:
(unlabeled)(of typefloat?, which defaults tonull)
Methods:
day(of typeint): Day of month.dst(of typebool): Daylight time savings in effect.hour(of typeint): Hours.min(of typeint): Minutes.month(of typeint): Month of year.sec(of typeint): Seconds.week_day(of typeint): Day of week (Sunday is 0 or 7, Saturday is 6).year(of typeint): Year.year_day(of typeint): Day of year.
time.up
Current time, in seconds, since the script has started.
Type:
() -> floatArguments:
time.utc
Convert a time in seconds into a date in the UTC time zone (current time is used if no argument is provided).
Type:
(?float?) -> unitArguments:
(unlabeled)(of typefloat?, which defaults tonull)
Methods:
day(of typeint): Day of month.dst(of typebool): Daylight time savings in effect.hour(of typeint): Hours.min(of typeint): Minutes.month(of typeint): Month of year.sec(of typeint): Seconds.week_day(of typeint): Day of week (Sunday is 0 or 7, Saturday is 6).year(of typeint): Year.year_day(of typeint): Day of year.
Visualization
video.vumeter
VU meter: display the audio volume (RMS in dB). This adds a video track to the source.
Type:
(?rms_min : float, ?rms_max : float, ?window : float,
?color : int, ?persistence : float,
source(audio=pcm('a), video=none, midi='b)) ->
source(audio=pcm('a), video=internal('c), midi='b)Arguments:
rms_min(of typefloat, which defaults to-35.): Minimal volume (dB).rms_max(of typefloat, which defaults to0.): Maximal volume (dB).window(of typefloat, which defaults to0.1): Duration in seconds of volume computation.color(of typeint, which defaults to16711680): Color of the display (0xRRGGBB).persistence(of typefloat, which defaults to0.): Persistence of the display (s).(unlabeled)(of typesource(audio=pcm('a), video=none, midi='b))
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 typebool): 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):trueif the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically,truefor outputs and sources such asinput.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 istruewhen the source is currently being used or if it could be used at any time, typically inside aswitchorfallback.last_metadata(of type() -> [string * string]?): Return the last metadata from the source.log(of type{level : (() -> int?).{set : (int) -> unit}}): Get or set the source’s log level, from1to5.on_get_ready(of type((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source’s final ID is set.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.skip(of type() -> unit): Skip to the next track.time(of type() -> float): Get a source’s time, based on its assigned clock.