Source / Testing

sleeper

Sleep regularly, thus inducing delays in the sound production. This is mainly useful for emulating network delays or sources which are slow to produce data, and thus test bufferization and robustness of scripts.

Type:

(?every : float, ?delay : float, ?delay_random : float,
 ?on_delay : ((float) -> unit), source('a)) -> source('a)

Arguments:

• every (of type float, which defaults to 1.): How often we should sleep (in seconds, 0 means every frame).
• delay (of type float, which defaults to 1.1): Delay introduced (in seconds).
• delay_random (of type float, which defaults to 0.): Maximum amount of time randomly added to the delay (in seconds).
• on_delay (of type (float) -> unit, which defaults to fun (_) -> ()): Function called when a delay is introduced, with the delay as argument.
• (unlabeled) (of type source('a)): Source in which the delays should be introduced.

Methods:

• buffered (of type () -> [string * float]): Length of buffered data.
• 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.
• frozen (of type (() -> bool).{set : (bool) -> unit}): The stream production is frozen while set to true.
• id (of type () -> string): Identifier of the source.
• is_active (of type () -> bool): true if the source is active, i.e. it is continuously animated by its own clock whenever it is ready. Typically, true for outputs and sources such as input.http.
• is_ready (of type () -> bool): Indicate if a source is ready to stream. This does not mean that the source is currently streaming, just that its resources are all properly initialized.
• is_up (of type () -> bool): Indicate that the source can be asked to produce some data at any time. This is true when the source is currently being used or if it could be used at any time, typically inside a switch or fallback.
• 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.
• on_metadata (of type ((([string * string]) -> unit)) -> unit): Call a given handler on metadata packets.
• on_shutdown (of type ((() -> unit)) -> unit): Register a function to be called when source shuts down.
• on_track (of type ((([string * string]) -> unit)) -> unit): Call a given handler on new tracks.
• on_wake_up (of type ((() -> unit)) -> unit): Register a function to be called after the source is asked to get ready. This is when, for instance, the source's final ID is set.
• remaining (of type () -> float): Estimation of remaining time in the current track.
• seek (of type (float) -> float): Seek forward, in seconds (returns the amount of time effectively seeked).
• self_sync (of type () -> bool): Is the source currently controlling its own real-time loop.
• skip (of type () -> unit): Skip to the next track.
• time (of type () -> float): Get a source's time, based on its assigned clock.

This function is experimental.