Version: 2.5.x (dev)

Source / Input / Active

`input.alsa`

Stream from an ALSA input device.

Type:

(?id : string?, ?buffer_size : float?, ?device : string, ?fallible : bool,
 ?self_sync : bool, ?start : bool) -> source(audio=pcm('a))

Synchronization:

This source uses the ALSA hardware clock as synchronization source when self_sync=true and the device is open.

Composition:

This source uses live composition by default.

Arguments:

id (of type string?, which defaults to null): Force the value of the source ID.
buffer_size (of type float?, which defaults to null): ALSA buffer size in seconds. Defaults to frame duration when null.
device (of type string, which defaults to "default"): Alsa device to use
fallible (of type bool, which defaults to false): Allow the source to fail. If set to false, start must be true and stop method raises an error.
self_sync (of type bool, which defaults to true): Mark the source as being synchronized by the ALSA driver.
start (of type bool, which defaults to true): Start input as soon as it is available.

Methods:

buffered (of type () -> [string * float]): Length of buffered data.
clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
clock (of type clock): The source's clock
duration (of type () -> float): Estimation of the duration of the current track.
elapsed (of type () -> float): Elapsed time in the current track.
fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
id (of type () -> string): Identifier of the source.
insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
is_started (of type () -> bool): true if the output or source is started.
is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
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, from 1 to 5.
register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
remaining (of type () -> float): Estimation of remaining time in the current track.
reset_last_metadata_on_track (of type (() -> bool).{set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
self_sync_description (of type () -> string): This source uses the ALSA hardware clock as synchronization source when self_sync=true and the device is open.
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.

Callbacks:

on_collect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source is collected
on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> unit): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> unit): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler to execute on each metadata
on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> unit): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
on_shutdown (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source shuts down
on_start (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source starts
on_stop (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source stops
on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler on track marks
on_wake_up (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called after the source is asked to get ready

Composition methods:

composition_type (of type (() -> string).{set : (string) -> unit}): This source uses live composition by default.
on_leave (of type ({source : source(audio=pcm('A)), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
on_select (of type ( { ending : source(audio=pcm('A))?, replay_metadata : bool, starting : source(audio=pcm('A)) }) -> source(audio=pcm('A))): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

`input.ffmpeg`

Create a stream using ffmpeg

Type:

(?id : string?, ?debug : bool, ?deduplicate_metadata : bool,
 ?float_args : [string * float], ?format : string?,
 ?int_args : [string * int], ?max_buffer : float,
 ?metadata_filter : (([string * string]) -> [string * string])?,
 ?new_track_on_metadata : bool, ?poll_delay : float, ?self_sync : {bool},
 ?start : bool, ?string_args : [string * string], ?trim_url : bool, {string}) ->
source('a)

Synchronization:

This source uses the FFmpeg input stream as synchronization source when self_sync=true and connected.

Composition:

This source uses live composition by default.

Arguments:

id (of type string?, which defaults to null): Force the value of the source ID.
debug (of type bool, which defaults to false): Run in debugging mode, not catching some exceptions.
deduplicate_metadata (of type bool, which defaults to true): Prevent duplicated metadata.
float_args (of type [string * float], which defaults to [])
format (of type string?, which defaults to null): Force a specific input format. Autodetected when passed a null argument
int_args (of type [string * int], which defaults to [])
max_buffer (of type float, which defaults to 5.0): Maximum duration of buffered data
metadata_filter (of type (([string * string]) -> [string * string])?, which defaults to null): Metadata filter function. Returned metadata are set a metadata. Default: filter id3v2_priv metadata.
new_track_on_metadata (of type bool, which defaults to true): Treat new metadata as new track.
poll_delay (of type float, which defaults to 2.0): Polling delay when trying to connect to the stream.
self_sync (of type {bool}, which defaults to false): Should the source control its own timing? Set to true if you are having synchronization issues. Should be false for most typical cases.
start (of type bool, which defaults to true): Start input as soon as it is available.
string_args (of type [string * string], which defaults to [])
trim_url (of type bool, which defaults to true): Trim input URL.
(unlabeled) (of type {string}): URL to decode.

Methods:

buffered (of type () -> [string * float]): Length of buffered data.
clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
clock (of type clock): The source's clock
duration (of type () -> float): Estimation of the duration of the current track.
elapsed (of type () -> float): Elapsed time in the current track.
fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
id (of type () -> string): Identifier of the source.
insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
is_started (of type () -> bool): true if the output or source is started.
is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
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, from 1 to 5.
register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
remaining (of type () -> float): Estimation of remaining time in the current track.
reset_last_metadata_on_track (of type (() -> bool).{set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
self_sync_description (of type () -> string): This source uses the FFmpeg input stream as synchronization source when self_sync=true and connected.
set_url (of type ({string}) -> unit): Set the source's url.
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), "starting" (polling task is about to begin) "polling" (attempting to connect to the HTTP stream), "connected " (connected to , buffering or playing back the stream) or "stopping" (source is stopping).
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.

Callbacks:

on_collect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source is collected
on_connect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler Function to execute when a source is connected.
on_disconnect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when a source is disconnected.
on_error (of type (synchronous : bool, ((error) -> unit)) -> unit): Call a given handler when an error occurs.
on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> unit): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> unit): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler to execute on each metadata
on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> unit): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
on_shutdown (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source shuts down
on_start (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source starts
on_stop (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source stops
on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler on track marks
on_wake_up (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called after the source is asked to get ready

Composition methods:

composition_type (of type (() -> string).{set : (string) -> unit}): This source uses live composition by default.
on_leave (of type ({source : source('A), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
on_select (of type ({ending : source('A)?, replay_metadata : bool, starting : source('A)}) -> source('A)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

`input.harbor`

Create a source that receives a http/icecast stream and forwards it as a stream.

Type:

(?id : string?,
 ?auth : ((
           {
             address : string,
             method : string,
             password : string,
             query : [string * string],
             uri : string,
             user : string
           }) -> bool)?,
 ?buffer : float, ?debug : bool, ?dumpfile : string?, ?icy : bool,
 ?icy_metadata_charset : string?, ?logfile : string?, ?max : float,
 ?metadata_charset : string?, ?password : string, ?port : int,
 ?replay_metadata : bool, ?timeout : float, ?transport : http_transport,
 ?user : string, string) -> source('a)

Composition:

This source uses live composition by default.

Arguments:

id (of type string?, which defaults to null): Force the value of the source ID.
auth (of type (( { address : string, method : string, password : string, query : [string * string], uri : string, user : string }) -> bool)?, which defaults to null): Authentication function. Receives a record with: user, password, uri (request URI), query (URL query parameters as a list of key-value pairs), address (client network address) and method (connection method: "PUT" or "POST" for HTTP source connections, "SOURCE" for Xaudiocast/ICE sources, "ICY" for Shoutcast/ICY sources, "WEBSOCKET" for WebSocket sources, "GET" for ICY metadata updates) and returns true if the user should be granted access for this login. Override any other method if used.
buffer (of type float, which defaults to 12.0): Duration of the pre-buffered data (in seconds). Default value is set to make it possible to use crossfade transitions with input.harbor. You might be able to reduce it but, in this case, make sure to not use the operator with crossfade or make sure that it has enough buffered data for it.
debug (of type bool, which defaults to false): Run in debugging mode by not catching some exceptions.
dumpfile (of type string?, which defaults to null): Dump stream to file, for debugging purpose. Disabled if null.
icy (of type bool, which defaults to false): Enable ICY (shoutcast) protocol.
icy_metadata_charset (of type string?, which defaults to null): 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.
logfile (of type string?, which defaults to null): Log buffer status to file, for debugging purpose. Disabled if null.
max (of type float, which defaults to 20.0): Maximum duration of the buffered data (in seconds).
metadata_charset (of type string?, which defaults to null): Metadata charset for non-ICY (shoutcast) source protocols. Guessed if null.
password (of type string, which defaults to "hackme"): Source password.
port (of type int, which defaults to 8005): Port used to connect to the source.
replay_metadata (of type bool, which defaults to false): Replay last known metadata when switching back to this source. This helps when source has dropped due to temporary connection issues.
timeout (of type float, which defaults to 30.0): Timeout for source connectionn.
transport (of type http_transport, which defaults to <unix_transport>): Http transport. Use http.transport.ssl or http.transport.secure_transport, when available, to enable HTTPS output
user (of type string, which defaults to "source"): Source user.
(unlabeled) (of type string): Mountpoint to look for.

Methods:

buffer_length (of type () -> float): Length of the buffer (in seconds).
buffered (of type () -> [string * float]): Length of buffered data.
clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
clock (of type clock): The source's clock
connected_client (of type () -> string?): Returns the address of the client currently connected, if there is one.
duration (of type () -> float): Estimation of the duration of the current track.
elapsed (of type () -> float): Elapsed time in the current track.
fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
id (of type () -> string): Identifier of the source.
insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
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, from 1 to 5.
register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
remaining (of type () -> float): Estimation of remaining time in the current track.
reset_last_metadata_on_track (of type (() -> bool).{set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
self_sync_description (of type () -> string)
skip (of type () -> unit): Skip to the next track.
status (of type () -> string): Current status of the input.
stop (of type () -> unit): Disconnect the client currently connected to the harbor. Does nothing if no client is connected.
time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

on_collect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source is collected
on_connect (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler when a source is connected. Its receives the list of headers, of the form: (,). All labels are lowercase.
on_disconnect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when a source is disconnected.
on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> unit): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> unit): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler to execute on each metadata
on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> unit): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
on_shutdown (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source shuts down
on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler on track marks
on_wake_up (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called after the source is asked to get ready

Composition methods:

composition_type (of type (() -> string).{set : (string) -> unit}): This source uses live composition by default.
on_leave (of type ({source : source('A), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
on_select (of type ({ending : source('A)?, replay_metadata : bool, starting : source('A)}) -> source('A)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

`input.harbor.dynamic.regexp`

Start a http/icecast receiver server. When a source connects, a new source is created and its description (URI, format, streams, headers) passed to the on_connect callback, which returns a function that receives the source. A copy_encoder is provided for passthrough remuxing.

Type:

(?buffer : float, ?max : float, ?timeout : float, ?user : string,
 ?password : string, ?port : int, ?transport : http_transport, ?icy : bool,
 ?icy_metadata_charset : string?, ?metadata_charset : string?,
 ?replay_metadata : bool,
 ?auth : ((
           {
             address : string,
             method : string,
             password : string,
             query : [string * string],
             uri : string,
             user : string
           }) -> bool)?,
 ?dumpfile : string?, ?logfile : string?, ?debug : bool, regexp,
 on_connect : ((
                {
                  copy_encoder : (?string?, ?options : [string * string]) ->
                                 format('a),
                  format : string?,
                  headers : [string * string],
                  mime_type : string?,
                  query : [string * string],
                  streams : [
                             {
                               channel_layout? : string,
                               channels? : int,
                               codec : string,
                               field : string,
                               frame_rate? : float?,
                               height? : int,
                               pixel_format? : string,
                               samplerate? : int,
                               type : string,
                               width? : int
                             }],
                  uri : string
                }) ->
               (source('a)
                .{
                  buffer_length : () -> float,
                  connected_client : () -> string?,
                  on_connect : (synchronous : bool,
                                (([string * string]) -> unit)) -> unit,
                  on_disconnect : (synchronous : bool, (() -> unit)) -> unit,
                  status : () -> string,
                  stop : () -> unit
                }) -> unit)) -> unit

Arguments:

buffer (of type float, which defaults to 12.0): Duration of the pre-buffered data (in seconds). Default value is set to make it possible to use crossfade transitions with input.harbor. You might be able to reduce it but, in this case, make sure to not use the operator with crossfade or make sure that it has enough buffered data for it.
max (of type float, which defaults to 20.0): Maximum duration of the buffered data (in seconds).
timeout (of type float, which defaults to 30.0): Timeout for source connectionn.
user (of type string, which defaults to "source"): Source user.
password (of type string, which defaults to "hackme"): Source password.
port (of type int, which defaults to 8005): Port used to connect to the source.
transport (of type http_transport, which defaults to <unix_transport>): Http transport. Use http.transport.ssl or http.transport.secure_transport, when available, to enable HTTPS output
icy (of type bool, which defaults to false): Enable ICY (shoutcast) protocol.
icy_metadata_charset (of type string?, which defaults to null): 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.
metadata_charset (of type string?, which defaults to null): Metadata charset for non-ICY (shoutcast) source protocols. Guessed if null.
replay_metadata (of type bool, which defaults to false): Replay last known metadata when switching back to this source. This helps when source has dropped due to temporary connection issues.
auth (of type (( { address : string, method : string, password : string, query : [string * string], uri : string, user : string }) -> bool)?, which defaults to null): Authentication function. Receives a record with: user, password, uri (request URI), query (URL query parameters as a list of key-value pairs), address (client network address) and method (connection method: "PUT" or "POST" for HTTP source connections, "SOURCE" for Xaudiocast/ICE sources, "ICY" for Shoutcast/ICY sources, "WEBSOCKET" for WebSocket sources, "GET" for ICY metadata updates) and returns true if the user should be granted access for this login. Override any other method if used.
dumpfile (of type string?, which defaults to null): Dump stream to file, for debugging purpose. Disabled if null.
logfile (of type string?, which defaults to null): Log buffer status to file, for debugging purpose. Disabled if null.
debug (of type bool, which defaults to false): Run in debugging mode by not catching some exceptions.
(unlabeled) (of type regexp): Mountpoint to look for.
on_connect (of type ( { copy_encoder : (?string?, ?options : [string * string]) -> format('a), format : string?, headers : [string * string], mime_type : string?, query : [string * string], streams : [ { channel_layout? : string, channels? : int, codec : string, field : string, frame_rate? : float?, height? : int, pixel_format? : string, samplerate? : int, type : string, width? : int }], uri : string }) -> (source('a) .{ buffer_length : () -> float, connected_client : () -> string?, on_connect : (synchronous : bool, (([string * string]) -> unit)) -> unit, on_disconnect : (synchronous : bool, (() -> unit)) -> unit, status : () -> string, stop : () -> unit }) -> unit): Callback when a source connects. Called with a connection record containing uri, query, format, mime_type, streams, headers and copy_encoder; returns a function that receives the source.

`input.http`

Create a http stream using ffmpeg

Type:

(?id : string?, ?debug : bool, ?deduplicate_metadata : bool,
 ?float_args : [string * float], ?format : string?,
 ?int_args : [string * int], ?max_buffer : float,
 ?metadata_filter : (([string * string]) -> [string * string])?,
 ?new_track_on_metadata : bool, ?poll_delay : float, ?self_sync : {bool?},
 ?start : bool, ?string_args : [string * string], ?timeout : float,
 ?trim_url : bool, ?user_agent : string, {string}) -> source('a)

Synchronization:

This source uses the FFmpeg input stream as synchronization source when self_sync=true and connected.

Composition:

This source uses live composition by default.

Arguments:

id (of type string?, which defaults to null): Force the value of the source ID.
debug (of type bool, which defaults to false): Run in debugging mode, not catching some exceptions.
deduplicate_metadata (of type bool, which defaults to true): Prevent duplicated metadata.
float_args (of type [string * float], which defaults to [])
format (of type string?, which defaults to null): Force a specific input format. Autodetected when passed a null argument
int_args (of type [string * int], which defaults to [])
max_buffer (of type float, which defaults to 5.0): Maximum duration of buffered data
metadata_filter (of type (([string * string]) -> [string * string])?, which defaults to null): Metadata filter function. Returned metadata are set a metadata. Default: filter id3v2_priv metadata.
new_track_on_metadata (of type bool, which defaults to true): Treat new metadata as new track.
poll_delay (of type float, which defaults to 2.0): Polling delay when trying to connect to the stream.
self_sync (of type {bool?}, which defaults to null): Should the source control its own timing? If null, the source will control its latency if it can be detected that it is connecting to an icecast or shoutcast server. Otherwise, see input.ffmpeg for more details about this option.
start (of type bool, which defaults to true): Start input as soon as it is available.
string_args (of type [string * string], which defaults to [])
timeout (of type float, which defaults to 10.0): Timeout for source connection.
trim_url (of type bool, which defaults to true): Trim input URL.
user_agent (of type string, which defaults to "Liquidsoap/2.5.0+git@8f7582e (Unix; OCaml 5.4.0)"): User agent.
(unlabeled) (of type {string}): URL to decode.

Methods:

buffered (of type () -> [string * float]): Length of buffered data.
clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
clock (of type clock): The source's clock
duration (of type () -> float): Estimation of the duration of the current track.
elapsed (of type () -> float): Elapsed time in the current track.
fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
id (of type () -> string): Identifier of the source.
insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
is_started (of type () -> bool): true if the output or source is started.
is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
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, from 1 to 5.
register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
remaining (of type () -> float): Estimation of remaining time in the current track.
reset_last_metadata_on_track (of type (() -> bool).{set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
self_sync_description (of type () -> string): This source uses the FFmpeg input stream as synchronization source when self_sync=true and connected.
set_url (of type ({string}) -> unit): Set the source's url.
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), "starting" (polling task is about to begin) "polling" (attempting to connect to the HTTP stream), "connected " (connected to , buffering or playing back the stream) or "stopping" (source is stopping).
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.

Callbacks:

on_collect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source is collected
on_connect (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler when a source is connected. Its receives the list of ICY-specific headers, if available.
on_disconnect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when a source is disconnected.
on_error (of type (synchronous : bool, ((error) -> unit)) -> unit): Call a given handler when an error occurs.
on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> unit): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> unit): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler to execute on each metadata
on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> unit): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
on_shutdown (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source shuts down
on_start (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source starts
on_stop (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source stops
on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler on track marks
on_wake_up (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called after the source is asked to get ready

Composition methods:

composition_type (of type (() -> string).{set : (string) -> unit}): This source uses live composition by default.
on_leave (of type ({source : source('A), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
on_select (of type ({ending : source('A)?, replay_metadata : bool, starting : source('A)}) -> source('A)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

`input.jack`

Get stream from JACK.

Type:

(?id : string?, ?server : string?, ?start : bool) -> source(audio=pcm('a))

Composition:

This source uses live composition by default.

Arguments:

id (of type string?, which defaults to null): Force the value of the source ID.
server (of type string?, which defaults to null): JACK server to connect to.
start (of type bool, which defaults to true): Start input as soon as it is available.

Methods:

buffered (of type () -> [string * float]): Length of buffered data.
clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
clock (of type clock): The source's clock
duration (of type () -> float): Estimation of the duration of the current track.
elapsed (of type () -> float): Elapsed time in the current track.
fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
id (of type () -> string): Identifier of the source.
insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
is_started (of type () -> bool): true if the output or source is started.
is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
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, from 1 to 5.
ports (of type () -> [jack_input_port.{connect : (jack_output_port) -> unit, name : string}]): List of JACK input ports for this source.
register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
remaining (of type () -> float): Estimation of remaining time in the current track.
reset_last_metadata_on_track (of type (() -> bool).{set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
self_sync_description (of type () -> string)
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.

Callbacks:

on_collect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source is collected
on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> unit): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> unit): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler to execute on each metadata
on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> unit): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
on_shutdown (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source shuts down
on_start (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source starts
on_stop (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source stops
on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler on track marks
on_wake_up (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called after the source is asked to get ready

Composition methods:

composition_type (of type (() -> string).{set : (string) -> unit}): This source uses live composition by default.
on_leave (of type ({source : source(audio=pcm('A)), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
on_select (of type ( { ending : source(audio=pcm('A))?, replay_metadata : bool, starting : source(audio=pcm('A)) }) -> source(audio=pcm('A))): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

`input.keyboard.sdl`

Play notes from the keyboard.

Type:

(?id : string?, ?velocity : float) -> source(midi=midi('a))

Composition:

This source uses live composition by default.

Arguments:

id (of type string?, which defaults to null): Force the value of the source ID.
velocity (of type float, which defaults to 0.8): Velocity of notes.

Methods:

buffered (of type () -> [string * float]): Length of buffered data.
clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
clock (of type clock): The source's clock
duration (of type () -> float): Estimation of the duration of the current track.
elapsed (of type () -> float): Elapsed time in the current track.
fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
id (of type () -> string): Identifier of the source.
insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
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, from 1 to 5.
register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
remaining (of type () -> float): Estimation of remaining time in the current track.
reset_last_metadata_on_track (of type (() -> bool).{set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
self_sync_description (of type () -> string)
skip (of type () -> unit): Skip to the next track.
time (of type () -> float): Get a source's time, based on its assigned clock.

Callbacks:

on_collect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source is collected
on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> unit): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> unit): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler to execute on each metadata
on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> unit): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
on_shutdown (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source shuts down
on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler on track marks
on_wake_up (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called after the source is asked to get ready

Composition methods:

composition_type (of type (() -> string).{set : (string) -> unit}): This source uses live composition by default.
on_leave (of type ({source : source(midi=midi('A)), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
on_select (of type ( { ending : source(midi=midi('A))?, replay_metadata : bool, starting : source(midi=midi('A)) }) -> source(midi=midi('A))): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

This function is experimental.

`input.oss`

Stream from an OSS input device.

Type:

(?id : string?, ?device : string, ?fallible : bool, ?self_sync : bool,
 ?start : bool) -> source(audio=pcm('a))

Synchronization:

This source uses the OSS hardware clock as synchronization source when self_sync=true and the device is open.

Composition:

This source uses live composition by default.

Arguments:

id (of type string?, which defaults to null): Force the value of the source ID.
device (of type string, which defaults to "/dev/dsp"): OSS device to use.
fallible (of type bool, which defaults to false): Allow the source to fail. If set to false, start must be true and stop method raises an error.
self_sync (of type bool, which defaults to true): Mark the source as being synchronized by the OSS driver.
start (of type bool, which defaults to true): Start input as soon as it is available.

Methods:

buffered (of type () -> [string * float]): Length of buffered data.
clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
clock (of type clock): The source's clock
duration (of type () -> float): Estimation of the duration of the current track.
elapsed (of type () -> float): Elapsed time in the current track.
fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
id (of type () -> string): Identifier of the source.
insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
is_started (of type () -> bool): true if the output or source is started.
is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
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, from 1 to 5.
register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
remaining (of type () -> float): Estimation of remaining time in the current track.
reset_last_metadata_on_track (of type (() -> bool).{set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
self_sync_description (of type () -> string): This source uses the OSS hardware clock as synchronization source when self_sync=true and the device is open.
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.

Callbacks:

on_collect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source is collected
on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> unit): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> unit): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler to execute on each metadata
on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> unit): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
on_shutdown (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source shuts down
on_start (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source starts
on_stop (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source stops
on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler on track marks
on_wake_up (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called after the source is asked to get ready

Composition methods:

composition_type (of type (() -> string).{set : (string) -> unit}): This source uses live composition by default.
on_leave (of type ({source : source(audio=pcm('A)), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
on_select (of type ( { ending : source(audio=pcm('A))?, replay_metadata : bool, starting : source(audio=pcm('A)) }) -> source(audio=pcm('A))): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

`input.portaudio`

Stream from a portaudio input device.

Type:

(?id : string?, ?buflen : int, ?device_id : int?, ?device_name : string?,
 ?fallible : bool, ?latency : float?, ?self_sync : bool, ?start : bool) ->
source(audio=pcm('a))

Synchronization:

This source uses the PortAudio clock as synchronization source when self_sync=true and the stream is open.

Composition:

This source uses live composition by default.

Arguments:

id (of type string?, which defaults to null): Force the value of the source ID.
buflen (of type int, which defaults to 256): Length of a buffer in samples.
device_id (of type int?, which defaults to null): Device ID. Uses default device if null.
device_name (of type string?, which defaults to null): Device name.
fallible (of type bool, which defaults to false): Allow the source to fail. If set to false, start must be true and stop method raises an error.
latency (of type float?, which defaults to null): Device latency. Only used when specifying device ID.
self_sync (of type bool, which defaults to true): Mark the source as being synchronized by the portaudio driver.
start (of type bool, which defaults to true): Start input as soon as it is available.

Methods:

buffered (of type () -> [string * float]): Length of buffered data.
clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
clock (of type clock): The source's clock
duration (of type () -> float): Estimation of the duration of the current track.
elapsed (of type () -> float): Elapsed time in the current track.
fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
id (of type () -> string): Identifier of the source.
insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
is_started (of type () -> bool): true if the output or source is started.
is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
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, from 1 to 5.
register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
remaining (of type () -> float): Estimation of remaining time in the current track.
reset_last_metadata_on_track (of type (() -> bool).{set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
self_sync_description (of type () -> string): This source uses the PortAudio clock as synchronization source when self_sync=true and the stream is open.
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.

Callbacks:

on_collect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source is collected
on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> unit): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> unit): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler to execute on each metadata
on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> unit): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
on_shutdown (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source shuts down
on_start (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source starts
on_stop (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source stops
on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler on track marks
on_wake_up (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called after the source is asked to get ready

Composition methods:

composition_type (of type (() -> string).{set : (string) -> unit}): This source uses live composition by default.
on_leave (of type ({source : source(audio=pcm('A)), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
on_select (of type ( { ending : source(audio=pcm('A))?, replay_metadata : bool, starting : source(audio=pcm('A)) }) -> source(audio=pcm('A))): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

`input.pulseaudio`

Stream from a pulseaudio input device.

Type:

(?id : string?, ?client : string, ?device : string?, ?fallible : bool,
 ?on_error : ((string) -> unit), ?retry_delay : float, ?self_sync : bool,
 ?start : bool) -> source(audio=pcm('a))

Synchronization:

This source uses the PulseAudio clock as synchronization source when self_sync=true and the stream is open.

Composition:

This source uses live composition by default.

Arguments:

id (of type string?, which defaults to null): Force the value of the source ID.
client (of type string, which defaults to "liquidsoap")
device (of type string?, which defaults to null): Device to use. Uses default if set to null.
fallible (of type bool, which defaults to true): Allow the source to fail. If set to false, start must be true and stop method raises an error.
on_error (of type (string) -> unit, which defaults to fun (_) -> ()): Function executed when an operation with the pulseaudio server returns an error.
retry_delay (of type float, which defaults to 1.0): When fallible, time to wait before trying to connect again.
self_sync (of type bool, which defaults to true): Use the PulseAudio clock as synchronization source. When false, delegate to the underlying source's synchronization.
start (of type bool, which defaults to true): Start input as soon as it is available.

Methods:

buffered (of type () -> [string * float]): Length of buffered data.
clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
clock (of type clock): The source's clock
duration (of type () -> float): Estimation of the duration of the current track.
elapsed (of type () -> float): Elapsed time in the current track.
fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
id (of type () -> string): Identifier of the source.
insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
is_started (of type () -> bool): true if the output or source is started.
is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
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, from 1 to 5.
register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
remaining (of type () -> float): Estimation of remaining time in the current track.
reset_last_metadata_on_track (of type (() -> bool).{set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
self_sync_description (of type () -> string): This source uses the PulseAudio clock as synchronization source when self_sync=true and the stream is open.
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.

Callbacks:

on_collect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source is collected
on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> unit): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> unit): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler to execute on each metadata
on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> unit): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
on_shutdown (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source shuts down
on_start (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source starts
on_stop (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source stops
on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler on track marks
on_wake_up (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called after the source is asked to get ready

Composition methods:

composition_type (of type (() -> string).{set : (string) -> unit}): This source uses live composition by default.
on_leave (of type ({source : source(audio=pcm('A)), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
on_select (of type ( { ending : source(audio=pcm('A))?, replay_metadata : bool, starting : source(audio=pcm('A)) }) -> source(audio=pcm('A))): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

`input.srt`

Receive a SRT stream from a distant agent.

Type:

(?id : string?, ?bind_address : string, ?connection_timeout : float?,
 ?content_type : string, ?dump : string, ?enforced_encryption : bool?,
 ?host : string, ?ipv6only : bool?,
 ?listen_callback : ((hs_version : int, peeraddr : string,
                      streamid : string?, srt_socket) -> bool)?,
 ?max : float, ?messageapi : bool, ?mode : string, ?passphrase : string?,
 ?payload_size : int, ?pbkeylen : int?, ?polling_delay : float, ?port : int,
 ?prefer_address : string?, ?read_timeout : float?, ?self_sync : bool,
 ?start : bool, ?streamid : string?, ?write_timeout : float?) -> source('a)

Synchronization:

This source uses the SRT stream as synchronization source when self_sync=true and connected.

Composition:

This source uses live composition by default.

Arguments:

id (of type string?, which defaults to null): Force the value of the source ID.
bind_address (of type string, which defaults to "0.0.0.0"): Address to bind on the local machine. Used only in listener mode
connection_timeout (of type float?, which defaults to null): Timeout, in seconds, after which initial connection operations are aborted if no data was received. Uses library's default if null. Used only in client mode.
content_type (of type string, which defaults to "application/ffmpeg"): Content-Type (mime type) used to find a decoder for the input stream.
dump (of type string, which defaults to ""): Dump received data to the given file for debugging. Unused is empty.
enforced_encryption (of type bool?, which defaults to null): Enforces that both connection parties have the same passphrase set, or both do not set the passphrase, otherwise the connection is rejected.
host (of type string, which defaults to "localhost"): Address to connect to. Used only in caller mode.
ipv6only (of type bool?, which defaults to null): If true and mode is set to listen, only ipv6 connections are accepted. When null, defaults to true when the bind_address is a ipv6 address and system defaults otherwise.
listen_callback (of type ((hs_version : int, peeraddr : string, streamid : string?, srt_socket) -> bool)?, which defaults to null): Callback used to decide whether to accept new incoming connections. Used in listener mode only.
max (of type float, which defaults to 10.0): Maximum duration of the buffered data.
messageapi (of type bool, which defaults to true): Use message api
mode (of type string, 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)
passphrase (of type string?, which defaults to null): When set to a non-empty string, this option enables encryption and sets the passphrase for it. See libsrt documentation for more details.
payload_size (of type int, which defaults to 1316): Payload size.
pbkeylen (of type int?, which defaults to null): Set encryption key length. See libsrt documentation for more details.
polling_delay (of type float, which defaults to 2.0): Delay between connection attempts. Used only in caller mode.
port (of type int, which defaults to 8000): Port to bind on the local machine (listener mode) or to connect to (caller mode). The term port as used in SRT is occasionally identical to the term UDP 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.
prefer_address (of type string?, which defaults to null): Preferred address type when resolving hostnames. One of: "system", "ipv4" or "ipv6". Defaults to global srt.prefer_connection settings when null.
read_timeout (of type float?, which defaults to 1.0): Timeout, in seconds, after which read operations are aborted if no data was received, indefinite if null.
self_sync (of type bool, which defaults to true): true if the source controls its own latency (i.e. the SRT stream is in live mode), false otherwise (i.e. the stream is in file mode.
start (of type bool, which defaults to true): Start input as soon as it is available.
streamid (of type string?, which defaults to null): Set streamid. This value can be retrieved by the listener side when connecting to it. Used in caller mode only.
write_timeout (of type float?, which defaults to 1.0): Timeout, in seconds, after which write operations are aborted if no data was received, indefinite if null.

Methods:

buffered (of type () -> [string * float]): Length of buffered data.
clear_last_metadata (of type () -> unit): Clear the last metadata from the source.
clock (of type clock): The source's clock
connect (of type () -> unit): In sender mode, connect to remote server. In listener mode, setup listening socket.
disconnect (of type () -> unit): Disconnect all connected socket.
duration (of type () -> float): Estimation of the duration of the current track.
elapsed (of type () -> float): Elapsed time in the current track.
fallible (of type bool): Indicate if a source may fail, i.e. may not be ready to stream.
generate_frame (of type () -> unit): Generate a frame from the source without consuming it. This can be useful in advanced cases where generating a frame is required to trigger some side effect like calculating some metadata before making a decision. You should make sure that the source is available before calling this function and it should only be called inside synchronous streaming loop callback such as on_frame!
id (of type () -> string): Identifier of the source.
insert_metadata (of type (?override : bool, ?new_track : bool, [string * string]) -> unit): Dynamically insert metadata in a stream. Inserts a new track with the given metadata if new_track is true. When override is false, metadata that the source provides itself takes precedence over the inserted one.
is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
is_started (of type () -> bool): true if the output or source is started.
is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
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, from 1 to 5.
register_command (of type (?usage : string?, description : string, string, ((string) -> string)) -> unit): Register a server command for this source. Command is registered under the source's id namespace when it gets up and de-registered when it gets down.
remaining (of type () -> float): Estimation of remaining time in the current track.
reset_last_metadata_on_track (of type (() -> bool).{set : (bool) -> unit}): If true, the source's last_metadata is reset on each new track. If a metadata is present along with the track mark, then it becomes the new last_metadata, otherwise, last_metadata becomes null`.
seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
self_sync_description (of type () -> string): This source uses the SRT stream as synchronization source when self_sync=true and connected.
skip (of type () -> unit): Skip to the next track.
sockets (of type () -> [string * srt_socket]): List of (connected_address, connected_socket)
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.

Callbacks:

on_collect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source is collected
on_connect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when connected.
on_disconnect (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when disconnected.
on_frame (of type (?before : bool, synchronous : bool, (() -> unit)) -> unit): Call a given handler on frame. When before is true, callback is executed before computing the frame and after otherwise
on_frame_checksum (of type (?before : ((string?) -> unit)?, synchronous : bool, ((cache : string?, string) -> unit)) -> unit): Call a given handler Register callbacks to compute frame checksums for debugging purposes. This is useful to track frame content changes through the streaming pipeline. The before callback is called before computing the frame with the checksum of the cached frame (if any, null otherwise). The main callback is called after computing the frame with the checksum of the generated frame and the remaining cache (if any).
on_metadata (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler to execute on each metadata
on_position (of type (position : {float}, ?remaining : bool, ?allow_partial : bool, synchronous : bool, ((float, [string * string]) -> unit)) -> unit): Call a given handler on track position. If remaining is false, callback is executed when position in track is more or equal to position. If remaining is true, callback is executed when remaining time in the current track is less or equal to position. Keep in mind that elapsed time is exact while remaining time is always estimated. Remaining time is usually more accurate for file-based sources. When allow_partial is true, if the current track ends before the offset position is reached, callback is still executed
on_shutdown (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called when source shuts down
on_socket (of type (synchronous : bool, ((mode : string, srt_socket) -> unit)) -> unit): Call a given handler when a new SRT socket is created to set additional options, add monitoring, etc. mode should be one of: "connect" (socket created before connecting to a remote address), "listen" (socket created before binding for receiving new incoming connections), "incoming" (socket received as incoming connection) or "close" (socket is about to closed).
on_start (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source starts
on_stop (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler when source stops
on_track (of type (synchronous : bool, (([string * string]) -> unit)) -> unit): Call a given handler on track marks
on_wake_up (of type (synchronous : bool, (() -> unit)) -> unit): Call a given handler to be called after the source is asked to get ready

Composition methods:

composition_type (of type (() -> string).{set : (string) -> unit}): This source uses live composition by default.
on_leave (of type ({source : source('A), track_sensitive : bool}) -> unit): Called after switching away from this source in a switch operator, once the transition using the ending source has completed. Receives a record with source (the source being left) and track_sensitive (true if the ending source's last frame had a track mark, i.e. it finished naturally; false if it was preempted mid-track). This function must return quickly as it runs in the streaming thread. The default depends on the active composition profile: file sources (source.composition.file) skip the source when preempted mid-track so it starts fresh on its next selection, and do nothing when it finished naturally; live sources (source.composition.live) do nothing.
on_select (of type ({ending : source('A)?, replay_metadata : bool, starting : source('A)}) -> source('A)): Called when selecting this source in a switch operator. Receives a record with starting (the incoming source) and ending (the previous source, or null when the ending source reached a track boundary). Returns the source to use. By default, both file and live profiles fade out ending when non-null (up to 1 second). The default is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
replay_metadata (of type {bool}): Whether to replay the latest metadata on this source when it is selected in a switch operator. Defaults to true. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).
single (of type bool): Forbid the selection of this source for two consecutive tracks in switch operators. Defaults to false.
track_sensitive (of type {bool}): Whether this source insists on track boundaries in switch operators: when true, it prefers not to be interrupted mid-track and not to be started mid-track. A switch may only cut into a track that is still playing when at least one of the two sources involved has track_sensitive set to false; otherwise it waits for the playing source to reach a track boundary. File-based sources default to true; live network and hardware inputs default to false. The value is looked up at runtime from the active composition profile (source.composition.file or source.composition.live depending on composition_type).

input.alsa​

input.ffmpeg​

input.harbor​

input.harbor.dynamic.regexp​

input.http​

input.jack​

input.keyboard.sdl​

input.oss​

input.portaudio​

input.pulseaudio​

input.srt​

`input.alsa`

`input.ffmpeg`

`input.harbor`

`input.harbor.dynamic.regexp`

`input.http`

`input.jack`

`input.keyboard.sdl`

`input.oss`

`input.portaudio`

`input.pulseaudio`

`input.srt`