org.jaudiolibs.pipes.graph

Class Clock

java.lang.Object

org.jaudiolibs.pipes.graph.Clock

All Implemented Interfaces:

Graph.Dependent

public final class Clock
extends Object
implements Graph.Dependent

A Clock that triggers at subdivisions of a given BPM, synchronized to the audio playback clock. All clock triggers happen at the beginning of an audio buffer, so the actual rate may be slightly different to the requested BPM to ensure a uniform clock period.

Clock provides a Linkable.Int for subscribing to triggers, maintaining a continuously rising count. It is also possible to add Runnable functions to be called on each clock trigger.

Clock fields may be annotated with Inject.

Constructor Summary

Constructors

Constructor and Description
Clock()

Method Summary

Modifier and Type	Method and Description
void	attach(Graph graph) Optional hook called when attached to the Graph.
double	bpm()
Clock	bpm(double bpm)
Clock	clearLinks() Clear all Linkables from this Trigger.
int	index() Get the current index.
Clock	index(int idx) Set the current index.
Clock	link(Runnable runnable) Run the provided Runnable each time this Trigger is triggered.
int	maxIndex() Get the current maximum index.
Clock	maxIndex(int max) Set the maximum index, at which the index will wrap back to zero.
Linkable.Int	on() Returns a new Linkable.Int for listening to each trigger.
int	subdivision()
Clock	subdivision(int subdivision)
void	update() Called before every new buffer is processed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jaudiolibs.pipes.graph.Graph.Dependent

detach

Constructor Detail

Clock

public Clock()

Method Detail

attach

public void attach(Graph graph)

Description copied from interface: Graph.Dependent

Optional hook called when attached to the Graph.

Specified by:

attach in interface Graph.Dependent

Parameters:

graph - the Graph being added to

update

public void update()

Description copied from interface: Graph.Dependent

Called before every new buffer is processed.

Specified by:

update in interface Graph.Dependent

bpm

public Clock bpm(double bpm)

bpm

public double bpm()

subdivision

public Clock subdivision(int subdivision)

subdivision

public int subdivision()

clearLinks

public Clock clearLinks()

Clear all Linkables from this Trigger.

Returns:

this

link

public Clock link(Runnable runnable)

Run the provided Runnable each time this Trigger is triggered. This method is shorthand for on().link(i -> runnable.run());.

Parameters:

runnable - function to run on trigger

Returns:

this

on

public Linkable.Int on()

Returns a new Linkable.Int for listening to each trigger. The int passed to the created linkable will be the same as index, incrementing each time, wrapping at maxIndex.

Returns:

new Linkable.Int for reacting to triggers

index

public Clock index(int idx)

Set the current index. Must not be negative.

Parameters:

idx - new index

Returns:

this

maxIndex

public Clock maxIndex(int max)

Set the maximum index, at which the index will wrap back to zero.

Parameters:

max - maximum index

Returns:

this

index

public int index()

Get the current index.

Returns:

current index

maxIndex

public int maxIndex()

Get the current maximum index.

Returns:

maximum index