Version: 2.5.x (dev)

Liquidsoap

`clock`

Decorate a clock with all its methods.

Type:

(clock) -> clock

Arguments:

(unlabeled) (of type clock)

Methods:

active_sources (of type () -> [clock_source.{id : () -> string}]): List of active sources connected to the clock. This returns abstract sources for logging and etc. These sources cannot be used in operators.
dump (of type () -> string): Dump source graph for the clock.
id (of type (() -> string).{set : (string) -> unit}): The clock's id
outputs (of type () -> [clock_source.{id : () -> string}]): List of outputs connected to the clock. This returns abstract sources for logging and etc. These sources cannot be used in operators.
passive_sources (of type () -> [clock_source.{id : () -> string}]): List of passive sources connected to the clock. This returns abstract sources for logging and etc. These sources cannot be used in operators.
self_sync (of type () -> bool): true if the clock is in control of its latency.
sources (of type () -> [clock_source.{id : () -> string}]): List of sources connected to the clock. This returns abstract sources for logging and etc. These sources cannot be used in operators.
start (of type (?force : bool) -> unit): Start the clock.
stop (of type () -> unit): Stop the clock. Does nothing if the clock is stopping or stopped.
sub_clocks (of type () -> [clock]): The list of sub-clocks for this clock.
sync (of type () -> string): The clock's current sync mode. One of: "stopped", "stopping", "auto", "CPU", "unsynced" or "passive".
tick (of type () -> unit): Animate the clock and run one tick
ticks (of type () -> int): The total number of times the clock has ticked.
unify (of type (clock) -> unit): Unify the clock with another one. One of the two clocks should be in "stopped" sync mode.

`clock.active`

Return the list of clocks currently in use.

Type:

() -> [clock]

`clock.create`

Create a new clock

Type:

(?id : string?, ?on_error : ((error) -> unit)?, ?sync : string) -> clock

Arguments:

id (of type string?, which defaults to null): Identifier for the new clock.
on_error (of type ((error) -> unit)?, which defaults to null): Error callback executed when a streaming error occurs. When passed, all streaming errors are silenced. Intended mostly for debugging purposes.
sync (of type string, which defaults to "auto"): Clock sync mode. Should be one of: "auto", "CPU", "unsynced" or "passive". Defaults to "auto". Defaults to: "auto"

Methods:

active_sources (of type () -> [clock_source.{id : () -> string}]): List of active sources connected to the clock. This returns abstract sources for logging and etc. These sources cannot be used in operators.
dump (of type () -> string): Dump source graph for the clock.
id (of type (() -> string).{set : (string) -> unit}): The clock's id
outputs (of type () -> [clock_source.{id : () -> string}]): List of outputs connected to the clock. This returns abstract sources for logging and etc. These sources cannot be used in operators.
passive_sources (of type () -> [clock_source.{id : () -> string}]): List of passive sources connected to the clock. This returns abstract sources for logging and etc. These sources cannot be used in operators.
self_sync (of type () -> bool): true if the clock is in control of its latency.
sources (of type () -> [clock_source.{id : () -> string}]): List of sources connected to the clock. This returns abstract sources for logging and etc. These sources cannot be used in operators.
start (of type (?force : bool) -> unit): Start the clock.
stop (of type () -> unit): Stop the clock. Does nothing if the clock is stopping or stopped.
sub_clocks (of type () -> [clock]): The list of sub-clocks for this clock.
sync (of type () -> string): The clock's current sync mode. One of: "stopped", "stopping", "auto", "CPU", "unsynced" or "passive".
tick (of type () -> unit): Animate the clock and run one tick
ticks (of type () -> int): The total number of times the clock has ticked.
unify (of type (clock) -> unit): Unify the clock with another one. One of the two clocks should be in "stopped" sync mode.

`clock.dump`

Return a string description of the clocks currently being used.

Type:

() -> string

`clock.dump_all_sources`

Return a string description of all the streaming graph currently being used.

Type:

() -> string

`decoder.add`

Register an external decoder. The decoder receives a local file and produces another local file. Produced file can be any format decodable by liquidsoap and can also be a request uri. Recommended returned value is: annotate:metadata="value",..:/path/to/file.wav. File decoders are applied during the request resolution process.

Type:

(name : string, description : string, ?static : ((string) -> bool),
 ?mimes : [string], file_extensions : [string],
 ((rlog : ((string) -> unit), maxtime : float, string) -> string
  .{temporary? : bool}?)) -> unit

Arguments:

name (of type string)
description (of type string): Description of the decoder.
static (of type (string) -> bool, which defaults to fun (_) -> true): Return true, then requests can be resolved once and for all. Typically, static decoders can be used to create infallible sources.
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]): List of file extensions. Should not be empty.
(unlabeled) (of type (rlog : ((string) -> unit), maxtime : float, string) -> string .{temporary? : bool}?): Resolution function. Returns null if no file could be decoded.

`decoder.metadata.add`

Type:

(?priority : {int}, ?mime_types : [string]?, ?file_extensions : [string]?,
 ?reentrant : bool, string,
 ((metadata : [string * string], string) -> [string * string])) -> unit

Arguments:

priority (of type {int}, which defaults to 1): Resolver's priority.
mime_types (of type [string]?, which defaults to null): Decode files that match the mime types in this list. Accept any file if null.
file_extensions (of type [string]?, which defaults to null): Decode files that have the file extensions in this list. Accept any file if null.
reentrant (of type bool, which defaults to false): Set to true to indicate that the decoder needs to resolve a request. Such decoders need to be mutually exclusive to avoid request resolution loops!
(unlabeled) (of type string): Format/resolver's name.
(unlabeled) (of type (metadata : [string * string], string) -> [string * string]): Process to start. The function takes the format and filename as argument and returns a list of (name,value) fields.

`decoder.metadata.reentrant`

Return the list of reentrant decoders.

Type:

() -> [string]

`encoder.content_type`

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

Type:

(format('a)) -> string

Arguments:

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

`encoder.extension`

Return the file extension of an encoder, if known.

Type:

(format('a)) -> string

Arguments:

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

`error.methods`

Decorate an error with all its methods

Type:

(error) -> error

Arguments:

(unlabeled) (of type error)

Methods:

kind (of type string): Error kind.
message (of type string): Error message.
trace (of type [ { cstart : int, cstop : int, filename : string, lstart : int, lstop : int, to_string : (?prefix : string) -> string }]): Error stacktrace.

`jack.server.buffer_size`

Return the current buffer size of the JACK server.

Type:

(?server : string?) -> int

Arguments:

server (of type string?, which defaults to null): JACK server to query. Uses default server if null.

`jack.server.connect`

Connect a JACK output port to a JACK input port.

Type:

(?server : string?, jack_input_port, jack_output_port) -> unit

Arguments:

server (of type string?, which defaults to null): JACK server to query. Uses default server if null.
(unlabeled) (of type jack_input_port): Input port.
(unlabeled) (of type jack_output_port): Output port.

`jack.server.get_input_ports`

Return the JACK input ports matching the given pattern and type.

Type:

(?server : string?, ?pattern : string, ?type : string, ?flags : [string]) ->
[jack_input_port]

Arguments:

server (of type string?, which defaults to null): JACK server to query. Uses default server if null.
pattern (of type string, which defaults to ""): Port name pattern. Empty string matches all ports.
type (of type string, which defaults to "audio"): Port type to filter by: "audio" or "midi".
flags (of type [string], which defaults to []): Additional port flags to filter by. Valid values: "is_physical", "can_monitor", "is_terminal".

`jack.server.get_output_ports`

Return the JACK output ports matching the given pattern and type.

Type:

(?server : string?, ?pattern : string, ?type : string, ?flags : [string]) ->
[jack_output_port]

Arguments:

server (of type string?, which defaults to null): JACK server to query. Uses default server if null.
pattern (of type string, which defaults to ""): Port name pattern. Empty string matches all ports.
type (of type string, which defaults to "audio"): Port type to filter by: "audio" or "midi".
flags (of type [string], which defaults to []): Additional port flags to filter by. Valid values: "is_physical", "can_monitor", "is_terminal".

`jack.server.sample_rate`

Return the current sample rate of the JACK server.

Type:

(?server : string?) -> int

Arguments:

server (of type string?, which defaults to null): JACK server to query. Uses default server if null.

`liquidsoap.executable`

Path to the Liquidsoap executable.

Type:

string

`liquidsoap.functions.count`

Number of functions registered in the standard library.

Type:

() -> int

`liquidsoap.script.path`

Path to the current script, if available

Type:

string?

`liquidsoap.version.at_least`

Ensure that Liquidsoap version is greater or equal to given one.

Type:

(string) -> bool

Arguments:

(unlabeled) (of type string): Minimal version.

`log`

Log a message.

Type:

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

Arguments:

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

`log.flush`

Flush all pending log messages.

Type:

() -> unit

`playlist.parse`

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

Type:

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

Arguments:

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

`playlist.parse.get_file`

Resolve a uri relative to a given pwd.

Type:

(?pwd : string?, string) -> string

Arguments:

pwd (of type string?, which defaults to null): Current directory to use for relative file path.
(unlabeled) (of type string): URI

`playlist.parse.m3u`

Parse M3U playlists

Type:

(string, ?pwd : string?) -> [[string * string] * string]

Arguments:

(unlabeled) (of type string): Playlist file
pwd (of type string?, which defaults to null): Current directory to use for relative file path.

`playlist.parse.register`

Type:

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

Arguments:

name (of type string): User-friendly format name
mimes (of type [string]): Supported mime formats.
strict (of type bool): True if playlist format can be detected unambiguously.
(unlabeled) (of type (?pwd : string, string) -> [[string * string] * string]): Playlist parser

`playlist.parse.scpls`

Parse SCPLS playlists

Type:

(string, ?pwd : string?) -> [[string * string] * string]

Arguments:

(unlabeled) (of type string): Playlist file
pwd (of type string?, which defaults to null): Current directory to use for relative file path.

`playlist.parse.xml`

Parse XML playlists

Type:

(string, ?pwd : string?) -> [[string * string] * string]

Arguments:

(unlabeled) (of type string): Playlist file
pwd (of type string?, which defaults to null): Current directory to use for relative file path.

`profiler.disable`

Record profiling statistics.

Type:

() -> unit

`profiler.enable`

Record profiling statistics.

Type:

() -> unit

`profiler.run`

Time a function with the profiler.

Type:

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

Arguments:

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

`profiler.stats.string`

Profiling statistics.

Type:

() -> string

`prometheus.latency`

Monitor a source's internal latencies on Prometheus

Type:

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

Arguments:

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

`protocol.add`

Type:

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

Arguments:

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

`protocol.count`

Number of registered protocols.

Type:

() -> int

`request.all`

Return all the requests currently available.

Type:

() -> [request]

`request.create`

Create a request from an URI.

Type:

(?cue_in_metadata : string?, ?cue_out_metadata : string?, ?persistent : bool,
 ?resolve_metadata : bool, ?excluded_metadata_resolvers : [string],
 ?temporary : bool, string) -> request

Arguments:

cue_in_metadata (of type string?, which defaults to "liq_cue_in"): Metadata for cue in points. Disabled if null.
cue_out_metadata (of type string?, which defaults to "liq_cue_out"): Metadata for cue out points. Disabled if null.
persistent (of type bool, which defaults to false): Indicate that the request is persistent, i.e. that it may be used again once it has been played.
resolve_metadata (of type bool, which defaults to true): Set to false to prevent metadata resolution on this request.
excluded_metadata_resolvers (of type [string], which defaults to []): List of metadata resolves to exclude when resolving metadata.
temporary (of type bool, which defaults to false): Indicate that the request is a temporary file: it will be destroyed after being played.
(unlabeled) (of type string)

`request.destroy`

Destroying a request causes any temporary associated file to be deleted, and releases its RID. Persistent requests resist to destroying, unless forced.

Type:

(?force : bool, request) -> unit

Arguments:

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

`request.duration`

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

Type:

(?resolvers : [string]?, ?resolve_metadata : bool,
 ?metadata : [string * string], ?timeout : float?, string) -> float?

Arguments:

resolvers (of type [string]?, which defaults to null): Set to a list of resolvers to only resolve duration using a specific decoder.
resolve_metadata (of type bool, which defaults to true): Set to false to prevent metadata resolution on this request.
metadata (of type [string * string], which defaults to []): Optional metadata used to decode the file, e.g. ffmpeg_options.
timeout (of type float?, which defaults to null): Limit in seconds to the duration of request resolution. Defaults to settings.request.timeout when null.
(unlabeled) (of type string)

`request.duration.ffmpeg`

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

Type:

(?resolve_metadata : bool, ?metadata : [string * string], ?timeout : float?,
 string) -> float?

Arguments:

resolve_metadata (of type bool, which defaults to true): Set to false to prevent metadata resolution on this request.
metadata (of type [string * string], which defaults to []): Optional metadata used to decode the file, e.g. ffmpeg_options.
timeout (of type float?, which defaults to null): Limit in seconds to the duration of request resolution. Defaults to settings.request.timeout when null.
(unlabeled) (of type string)

`request.duration.flac`

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

Type:

(?resolve_metadata : bool, ?metadata : [string * string], ?timeout : float?,
 string) -> float?

Arguments:

resolve_metadata (of type bool, which defaults to true): Set to false to prevent metadata resolution on this request.
metadata (of type [string * string], which defaults to []): Optional metadata used to decode the file, e.g. ffmpeg_options.
timeout (of type float?, which defaults to null): Limit in seconds to the duration of request resolution. Defaults to settings.request.timeout when null.
(unlabeled) (of type string)

`request.duration.mad`

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

Type:

(?resolve_metadata : bool, ?metadata : [string * string], ?timeout : float?,
 string) -> float?

Arguments:

resolve_metadata (of type bool, which defaults to true): Set to false to prevent metadata resolution on this request.
metadata (of type [string * string], which defaults to []): Optional metadata used to decode the file, e.g. ffmpeg_options.
timeout (of type float?, which defaults to null): Limit in seconds to the duration of request resolution. Defaults to settings.request.timeout when null.
(unlabeled) (of type string)

`request.duration.ogg_flac`

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

Type:

(?resolve_metadata : bool, ?metadata : [string * string], ?timeout : float?,
 string) -> float?

Arguments:

resolve_metadata (of type bool, which defaults to true): Set to false to prevent metadata resolution on this request.
metadata (of type [string * string], which defaults to []): Optional metadata used to decode the file, e.g. ffmpeg_options.
timeout (of type float?, which defaults to null): Limit in seconds to the duration of request resolution. Defaults to settings.request.timeout when null.
(unlabeled) (of type string)

`request.duration.vorbis`

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

Type:

(?resolve_metadata : bool, ?metadata : [string * string], ?timeout : float?,
 string) -> float?

Arguments:

resolve_metadata (of type bool, which defaults to true): Set to false to prevent metadata resolution on this request.
metadata (of type [string * string], which defaults to []): Optional metadata used to decode the file, e.g. ffmpeg_options.
timeout (of type float?, which defaults to null): Limit in seconds to the duration of request resolution. Defaults to settings.request.timeout when null.
(unlabeled) (of type string)

`request.duration.wav/aiff`

Compute the duration in seconds of audio data contained in a request using the wav/aiff decoder. The computation may be expensive. Returns null if computation failed, typically if the file was not recognized as valid audio.

Type:

(?resolve_metadata : bool, ?metadata : [string * string], ?timeout : float?,
 string) -> float?

Arguments:

resolve_metadata (of type bool, which defaults to true): Set to false to prevent metadata resolution on this request.
metadata (of type [string * string], which defaults to []): Optional metadata used to decode the file, e.g. ffmpeg_options.
timeout (of type float?, which defaults to null): Limit in seconds to the duration of request resolution. Defaults to settings.request.timeout when null.
(unlabeled) (of type string)

`request.filename`

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

Type:

(request) -> string

Arguments:

(unlabeled) (of type request)

`request.id`

Identifier of a request.

Type:

(request) -> int

Arguments:

(unlabeled) (of type request)

`request.is_static`

true if the given URI is assumed to be static, e.g. a file.

Type:

(string) -> bool

Arguments:

(unlabeled) (of type string)

`request.log`

Get log data associated to a request.

Type:

(request) -> string

Arguments:

(unlabeled) (of type request)

`request.metadata`

Get the metadata associated to a request.

Type:

(request) -> [string * string]

Arguments:

(unlabeled) (of type request)

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

Type:

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

Arguments:

timeout (of type float?, which defaults to null): Limit in seconds to the duration of the request resolution. Defaults to settings.request.timeout when null.
content_type (of type source('a)?, which defaults to null): Check that the request can decode content suitable for the given source.
(unlabeled) (of type request)

`request.resolved`

Check if a request is resolved, i.e. is associated to a valid local file.

Type:

(request) -> bool

Arguments:

(unlabeled) (of type request)

`request.status`

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

Type:

(request) -> string

Arguments:

(unlabeled) (of type request)

`request.uri`

Initial URI of a request.

Type:

(request) -> string

Arguments:

(unlabeled) (of type request)

`runtime.gc.compact`

Perform a full major collection and compact the heap. Note that heap compaction is a lengthy operation.

Type:

() -> unit

`runtime.gc.full_major`

Trigger full major garbage collection.

Type:

() -> unit

`runtime.gc.major`

Trigger a minor collection and finish the current major collection cycle..

Type:

() -> unit

`runtime.gc.major_slice`

Do a minor collection and a slice of major collection. The optional argument n is the size of the slice: the GC will do enough work to free (on average) n words of memory. If 0 (its default), the GC will try to do enough work to ensure that the next automatic slice has no work to do.

Type:

(?int) -> unit

Arguments:

(unlabeled) (of type int, which defaults to 0): Size of the slice

`runtime.gc.minor`

Trigger full minor garbage collection.

Type:

() -> unit

`seconds_of_main`

Convert a number of main ticks to seconds. Sub-second precision is available as the fractional part (64-bit float).

Type:

(int) -> float

Arguments:

(unlabeled) (of type int)

`server.execute`

Execute a liquidsoap server command.

Type:

(string, ?string) -> [string]

Arguments:

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

`source.composition.file`

Set the default composition profile for file sources. The profile record contains on_leave, on_select, track_sensitive, and replay_metadata defaults used by switch operators.

Type:

(
 {
   on_leave : ({source : source('a), track_sensitive : bool}) -> unit,
   on_select : (
                {
                  ending : source('a)?,
                  replay_metadata : bool,
                  starting : source('a)
                }) -> source('a),
   replay_metadata : bool,
   track_sensitive : bool
 }) -> unit

`source.composition.live`

Set the default composition profile for live sources. The profile record contains on_leave, on_select, track_sensitive, and replay_metadata defaults used by switch operators.

Type:

(
 {
   on_leave : ({source : source('a), track_sensitive : bool}) -> unit,
   on_select : (
                {
                  ending : source('a)?,
                  replay_metadata : bool,
                  starting : source('a)
                }) -> source('a),
   replay_metadata : bool,
   track_sensitive : bool
 }) -> unit

`srt.socket`

Decorate a srt socket with all its methods.

Type:

(srt_socket) -> srt_socket

Arguments:

(unlabeled) (of type srt_socket)

Methods:

bistats (of type (?clear : bool?, ?instantaneous : bool?) -> { 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}): Socket bstats
bstats (of type (?clear : bool?) -> { 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}): Socket bstats
close (of type () -> unit): Close socket
id (of type int): Socket ID
ipv6only (of type () -> bool): Get ipv6only option
latency (of type () -> int): Get latency option
pbkeylen (of type () -> int): Get pbkeylen option
peerlatency (of type () -> int): Get peerlatency option
rcvbuf (of type () -> int): Get rcvbuf option
rcvdata (of type () -> int): Get rcvdata option
rcvlatency (of type () -> int): Get rcvlatency option
rcvsyn (of type () -> bool): Get rcvsyn option
rcvtimeout (of type () -> int): Get rcvtimeout option
reuseaddr (of type () -> bool): Get reuseaddr option
set_conntimeo (of type (int) -> unit): Set conntimeo option
set_enforced_encryption (of type (bool) -> unit): Set enforced_encryption option
set_ipv6only (of type (bool) -> unit): Set ipv6only option
set_latency (of type (int) -> unit): Set latency option
set_messageapi (of type (bool) -> unit): Set messageapi option
set_passphrase (of type (string) -> unit): Set passphrase option
set_payloadsize (of type (int) -> unit): Set payloadsize option
set_pbkeylen (of type (int) -> unit): Set pbkeylen option
set_peerlatency (of type (int) -> unit): Set peerlatency option
set_rcvbuf (of type (int) -> unit): Set rcvbuf option
set_rcvlatency (of type (int) -> unit): Set rcvlatency option
set_rcvsyn (of type (bool) -> unit): Set rcvsyn option
set_rcvtimeout (of type (int) -> unit): Set rcvtimeout option
set_reuseaddr (of type (bool) -> unit): Set reuseaddr option
set_sndbuf (of type (int) -> unit): Set sndbuf option
set_sndsyn (of type (bool) -> unit): Set sndsyn option
set_sndtimeout (of type (int) -> unit): Set sndtimeout option
set_streamid (of type (string) -> unit): Set streamid option
set_udp_rcvbuf (of type (int) -> unit): Set udp_rcvbuf option
set_udp_sndbuf (of type (int) -> unit): Set udp_sndbuf option
sndbuf (of type () -> int): Get sndbuf option
sndsyn (of type () -> bool): Get sndsyn option
sndtimeout (of type () -> int): Get sndtimeout option
status (of type () -> string): Socket status
streamid (of type () -> string): Get streamid option
udp_rcvbuf (of type () -> int): Get udp_rcvbuf option
udp_sndbuf (of type () -> int): Get udp_sndbuf option

`track.clock`

Return the clock associated with the given track.

Type:

('a) -> clock where 'a is a track

Arguments:

(unlabeled) (of type anything that is a track)

`track.format`

Return the content format of a track. Use format.description to introspect the returned value.

Type:

('a) -> content_format where 'a is a track

Arguments:

(unlabeled) (of type anything that is a track)

clock
clock.active
clock.create
clock.dump
clock.dump_all_sources
decoder.add
decoder.metadata.add
decoder.metadata.reentrant
encoder.content_type
encoder.extension
error.methods
jack.server.buffer_size
jack.server.connect
jack.server.get_input_ports
jack.server.get_output_ports
jack.server.sample_rate
liquidsoap.executable
liquidsoap.functions.count
liquidsoap.script.path
liquidsoap.version.at_least
log
log.flush
playlist.parse
playlist.parse.get_file
playlist.parse.m3u
playlist.parse.register
playlist.parse.scpls
playlist.parse.xml
profiler.disable
profiler.enable
profiler.run
profiler.stats.string
prometheus.latency
protocol.add
protocol.count
request.all
request.create
request.destroy
request.duration
request.duration.ffmpeg
request.duration.flac
request.duration.mad
request.duration.ogg_flac
request.duration.vorbis
request.duration.wav/aiff
request.filename
request.id
request.is_static
request.log
request.metadata
request.resolve
request.resolved
request.status
request.uri
runtime.gc.compact
runtime.gc.full_major
runtime.gc.major
runtime.gc.major_slice
runtime.gc.minor
seconds_of_main
server.execute
source.composition.file
source.composition.live
srt.socket
track.clock
track.format

clock​

clock.active​

clock.create​

clock.dump​

clock.dump_all_sources​

decoder.add​

decoder.metadata.add​

decoder.metadata.reentrant​

encoder.content_type​

encoder.extension​

error.methods​

jack.server.buffer_size​

jack.server.connect​

jack.server.get_input_ports​

jack.server.get_output_ports​

jack.server.sample_rate​

liquidsoap.executable​

liquidsoap.functions.count​

liquidsoap.script.path​

liquidsoap.version.at_least​

log​

log.flush​

playlist.parse​

playlist.parse.get_file​

playlist.parse.m3u​

playlist.parse.register​

playlist.parse.scpls​

playlist.parse.xml​

profiler.disable​

profiler.enable​

profiler.run​

profiler.stats.string​

prometheus.latency​

protocol.add​

protocol.count​

request.all​

request.create​

request.destroy​

request.duration​

request.duration.ffmpeg​

request.duration.flac​

request.duration.mad​

request.duration.ogg_flac​

request.duration.vorbis​

request.duration.wav/aiff​

request.filename​

request.id​

request.is_static​

request.log​

request.metadata​

request.resolve​

request.resolved​

request.status​

request.uri​

runtime.gc.compact​

runtime.gc.full_major​

runtime.gc.major​

runtime.gc.major_slice​

runtime.gc.minor​

seconds_of_main​

server.execute​

source.composition.file​

source.composition.live​

srt.socket​

track.clock​

track.format​

`clock`

`clock.active`

`clock.create`

`clock.dump`

`clock.dump_all_sources`

`decoder.add`

`decoder.metadata.add`

`decoder.metadata.reentrant`

`encoder.content_type`

`encoder.extension`

`error.methods`

`jack.server.buffer_size`

`jack.server.connect`

`jack.server.get_input_ports`

`jack.server.get_output_ports`

`jack.server.sample_rate`

`liquidsoap.executable`

`liquidsoap.functions.count`

`liquidsoap.script.path`

`liquidsoap.version.at_least`

`log`

`log.flush`

`playlist.parse`

`playlist.parse.get_file`

`playlist.parse.m3u`

`playlist.parse.register`

`playlist.parse.scpls`

`playlist.parse.xml`

`profiler.disable`

`profiler.enable`

`profiler.run`

`profiler.stats.string`

`prometheus.latency`

`protocol.add`

`protocol.count`

`request.all`

`request.create`

`request.destroy`

`request.duration`

`request.duration.ffmpeg`

`request.duration.flac`

`request.duration.mad`

`request.duration.ogg_flac`

`request.duration.vorbis`

`request.duration.wav/aiff`

`request.filename`

`request.id`

`request.is_static`

`request.log`

`request.metadata`

`request.resolve`

`request.resolved`

`request.status`

`request.uri`

`runtime.gc.compact`

`runtime.gc.full_major`

`runtime.gc.major`

`runtime.gc.major_slice`

`runtime.gc.minor`

`seconds_of_main`

`server.execute`

`source.composition.file`

`source.composition.live`

`srt.socket`

`track.clock`

`track.format`