Interaction

add_skip_command

Add a skip telnet command to a source when it does not have one by default.

Type:

(source('c)
 .{on_wake_up : (synchronous : bool, (() -> unit)) -> 'b, skip : () -> 'a}) ->
'b

Arguments:

• (unlabeled) (of type source('c) .{on_wake_up : (synchronous : bool, (() -> unit)) -> 'b, skip : () -> 'a}): The source to attach the command to.

audioscrobbler.submit

Submit songs using audioscrobbler, respecting the full protocol: First signal song as now playing when starting, and then submit song when it ends.

Type:

(username : string, password : string, ?api_key : string?,
 ?api_secret : string?, ?delay : float, ?force : bool,
 ?metadata_preprocessor : (([string * string]) -> [string * string]),
 source('a)) -> source('a)

Arguments:

• username (of type string)
• password (of type string)
• api_key (of type string?, which defaults to null)
• api_secret (of type string?, which defaults to null)
• delay (of type float, which defaults to 10.0): Submit song when there is only this delay left, in seconds.
• force (of type bool, which defaults to false): If remaining time is null, the song will be assumed to be skipped or cut, and not submitted. Set this to true to prevent this behavior
• metadata_preprocessor (of type ([string * string]) -> [string * string], which defaults to fun (m) -> ...): Metadata pre-processor callback. Can be used to change metadata on-the-fly before sending to nowPlaying/scrobble. If returning an empty metadata, nothing is sent at all.
• (unlabeled) (of type source('a))

compress.multiband.interactive

Create a multiband compressor whose parameters are interactive variables.

Type:

(?id : string?, ?bands : int, source(audio=pcm('a), 'b)) ->
source(audio=pcm('a).{gain? : never, rms? : never}, 'b)
where
  'b is a set of tracks to be muxed into a source and a set of internal tracks

Composition:

This source uses file composition by default.

Arguments:

• id (of type string?, which defaults to null): Id of the source. Variable names are prefixed with this.
• bands (of type int, which defaults to 5): Number of bands.
• (unlabeled) (of type source(audio=pcm('a), 'b) where 'b is a set of tracks to be muxed into a source and a set of internal tracks): Source to compress.

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.
• gain (of type () -> float):
• 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`.
• rms (of type () -> float):
• seek (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 file composition by default.
• on_leave (of type ( { source : source(audio=pcm('B) .{gain? : never, rms? : never }, 'A), track_sensitive : bool }) -> unit where 'A is a set of tracks to be muxed into a source and a set of internal tracks): 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('B) .{gain? : never, rms? : never }, 'A)?, replay_metadata : bool, starting : source(audio=pcm('B) .{gain? : never, rms? : never }, 'A) }) -> source(audio=pcm('B).{gain? : never, rms? : never}, 'A) where 'A is a set of tracks to be muxed into a source and a set of internal tracks): 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).

interactive.bool

Read a boolean from an interactive input.

Type:

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

Arguments:

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

Methods:

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

interactive.float

Read a float from an interactive input.

Type:

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

Arguments:

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

Methods:

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

interactive.harbor

Expose interactive variables through harbor http server. Once this is called, with default parameters, you can browse http://localhost:8000/interactive to change the value of interactive variables using sliders.

Type:

(?transport : http_transport
 .{default_port : int, name : string, protocol : string}, ?port : int,
 ?uri : string) -> unit

Arguments:

• transport (of type http_transport.{default_port : int, name : string, protocol : string}, which defaults to <unix_transport>.{default_port=80, protocol="http", name="unix"}): Http transport. Use http.transport.ssl or http.transport.secure_transport`, when available, to enable HTTPS output
• port (of type int, which defaults to 8000): Port of the server.
• uri (of type string, which defaults to "/interactive"): URI of the server.

interactive.int

Read an integer from an interactive input.

Type:

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

Arguments:

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

Methods:

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

interactive.load

Load the value of interactive variables from a file.

Type:

(string) -> unit

Arguments:

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

interactive.persistent

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

Type:

(string) -> unit

Arguments:

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

interactive.save

Save the value of all interactive variables in a file.

Type:

(string) -> unit

Arguments:

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

interactive.string

Read a string from an interactive input.

Type:

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

Arguments:

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

Methods:

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

interactive.unit

Register a callback when a unit interactive input is set.

Type:

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

Arguments:

• description (of type string, which defaults to ""): Description of the variable.
• osc (of type string, which defaults to ""): OSC address.
• (unlabeled) (of type string): Name of the variable.
• (unlabeled) (of type () -> unit): Function triggered when the value is set.

Methods:

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

spinitron.submit

Submit a track to the spinitron track system and return the parsed response

Type:

(?host : string, api_key : string, ?live : bool, ?start : string?,
 ?duration : int?, artist : string, ?release : string?, ?label : string?,
 ?genre : string?, song : string, ?composer : string?, ?isrc : string?) ->
unit

Arguments:

• host (of type string, which defaults to "https://spinitron.com/api")
• api_key (of type string): API key
• live (of type bool, which defaults to false)
• start (of type string?, which defaults to null)
• duration (of type int?, which defaults to null)
• artist (of type string)
• release (of type string?, which defaults to null)
• label (of type string?, which defaults to null)
• genre (of type string?, which defaults to null)
• song (of type string)
• composer (of type string?, which defaults to null)
• isrc (of type string?, which defaults to null)

Methods:

• artist (of type string):
• artist_custom (of type string?):
• catalog_number (of type string?):
• classical (of type bool?):
• composer (of type string?):
• conductor (of type string?):
• duration (of type int?):
• ensemble (of type string?):
• genre (of type string?):
• id (of type int):
• image (of type string?):
• isrc (of type string?):
• iswc (of type string?):
• label (of type string?):
• label_custom (of type string?):
• links (of type {playlist : {href : string}?, self : {href : string}?}?):
• local (of type bool?):
• medium (of type string?):
• new (of type bool?):
• note (of type string?):
• performers (of type string?):
• playlist_id (of type int):
• release (of type string?):
• release_custom (of type string?):
• released (of type int?):
• request (of type bool?):
• song (of type string):
• spin_end (of type string?):
• spin_start (of type string):
• timezone (of type string?):
• upc (of type string?):
• va (of type bool?):
• work (of type string?):

spinitron.submit.metadata

Submit a spin using the given metadata to the spinitron track system and return the parsed response. artist and song (or title) must be present either as metadata or as optional argument.

Type:

(?host : string, api_key : string, ?live : bool, ?start : string?,
 ?duration : int?, ?release : string?, ?label : string?, ?genre : string?,
 ?composer : string?, ?isrc : string?,
 ?mapper : (([string * string]) -> [string * string]), ?artist : string?,
 ?song : string?, [string * string]) -> unit

Arguments:

• host (of type string, which defaults to "https://spinitron.com/api")
• api_key (of type string): API key
• live (of type bool, which defaults to false)
• start (of type string?, which defaults to null)
• duration (of type int?, which defaults to null)
• release (of type string?, which defaults to null)
• label (of type string?, which defaults to null)
• genre (of type string?, which defaults to null)
• composer (of type string?, which defaults to null)
• isrc (of type string?, which defaults to null)
• mapper (of type ([string * string]) -> [string * string], which defaults to fun (m) -> ...): Metadata mapper that can be used to map metadata fields to spinitron's expected. Returned metadata are added to the submitted metadata. By default, title is mapped to song and album to release if neither of those passed otherwise.
• artist (of type string?, which defaults to null)
• song (of type string?, which defaults to null)
• (unlabeled) (of type [string * string]): Metadata to submit. Overrides optional arguments when present.

Methods:

• artist (of type string):
• artist_custom (of type string?):
• catalog_number (of type string?):
• classical (of type bool?):
• composer (of type string?):
• conductor (of type string?):
• duration (of type int?):
• ensemble (of type string?):
• genre (of type string?):
• id (of type int):
• image (of type string?):
• isrc (of type string?):
• iswc (of type string?):
• label (of type string?):
• label_custom (of type string?):
• links (of type {playlist : {href : string}?, self : {href : string}?}?):
• local (of type bool?):
• medium (of type string?):
• new (of type bool?):
• note (of type string?):
• performers (of type string?):
• playlist_id (of type int):
• release (of type string?):
• release_custom (of type string?):
• released (of type int?):
• request (of type bool?):
• song (of type string):
• spin_end (of type string?):
• spin_start (of type string):
• timezone (of type string?):
• upc (of type string?):
• va (of type bool?):
• work (of type string?):

spinitron.submit.on_metadata

Specialized version of s.on_metadata that submits spins using the source's metadata to the spinitron track system. artist and song (or title) must be present either as metadata or as optional argument.

Type:

(?host : string, api_key : string, ?live : bool, ?start : string?,
 ?duration : int?, ?release : string?, ?label : string?, ?genre : string?,
 ?composer : string?, ?isrc : string?,
 ?mapper : (([string * string]) -> [string * string]), ?artist : string?,
 ?song : string?, source('a)) -> unit

Arguments:

• host (of type string, which defaults to "https://spinitron.com/api")
• api_key (of type string): API key
• live (of type bool, which defaults to false)
• start (of type string?, which defaults to null)
• duration (of type int?, which defaults to null)
• release (of type string?, which defaults to null)
• label (of type string?, which defaults to null)
• genre (of type string?, which defaults to null)
• composer (of type string?, which defaults to null)
• isrc (of type string?, which defaults to null)
• mapper (of type ([string * string]) -> [string * string], which defaults to fun (m) -> ...)
• artist (of type string?, which defaults to null)
• song (of type string?, which defaults to null)
• (unlabeled) (of type source('a)): Metadata to submit. Overrides optional arguments when present.

spinitron.submit.raw

Submit a track to the spinitron track system and return the raw response.

Type:

(?host : string, api_key : string, ?live : bool, ?start : string?,
 ?duration : int?, artist : string, ?release : string?, ?label : string?,
 ?genre : string?, song : string, ?composer : string?, ?isrc : string?) ->
string

Arguments:

• host (of type string, which defaults to "https://spinitron.com/api")
• api_key (of type string): API key
• live (of type bool, which defaults to false)
• start (of type string?, which defaults to null)
• duration (of type int?, which defaults to null)
• artist (of type string)
• release (of type string?, which defaults to null)
• label (of type string?, which defaults to null)
• genre (of type string?, which defaults to null)
• song (of type string)
• composer (of type string?, which defaults to null)
• isrc (of type string?, which defaults to null)

Methods:

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