A B D E F G I J M N O S T

A

adjustStart(long) - Method in class org.deepsymmetry.electro.Metronome

Adds a number of milliseconds to the start time of the metronome.

B

beatsToMilliseconds(long, double) - Static method in class org.deepsymmetry.electro.Metronome

Calculate the number of milliseconds taken by the specified number of beats at the specified tempo.

D

distanceFromBar() - Method in class org.deepsymmetry.electro.Metronome

Determine how far in time the metronome is from its closest bar boundary.

distanceFromBar() - Method in interface org.deepsymmetry.electro.Snapshot

Determine how far in time the snapshot is from its closest bar boundary.

distanceFromBeat() - Method in class org.deepsymmetry.electro.Metronome

Determine how far in time the metronome is from the closest beat.

distanceFromBeat() - Method in interface org.deepsymmetry.electro.Snapshot

Determine how far in time the snapshot is from its closest beat.

distanceFromPhrase() - Method in class org.deepsymmetry.electro.Metronome

Determine how far in time the metronome is from its closest phrase boundary.

distanceFromPhrase() - Method in interface org.deepsymmetry.electro.Snapshot

Determine how far in time the snapshot is from its closest phrase boundary.

E

enhancedPhase(long, double, double) - Static method in class org.deepsymmetry.electro.Metronome

Helper function to calculate phase with respect to multiples or fractions of a marker (beat, bar, or phrase), given the phase with respect to that marker, the marker number, and the desired ratio.

enhancedPhase(long, double, long, long) - Static method in class org.deepsymmetry.electro.Metronome

Helper function to calculate phase with respect to multiples or fractions of a marker (beat, bar, or phrase), given the phase with respect to that marker, the marker number, and the desired ratio.

F

findClosestDelta(double) - Static method in class org.deepsymmetry.electro.Metronome

Figures out the least disruptive phase shift that ends up in a target phase.

G

getBar() - Method in class org.deepsymmetry.electro.Metronome

Get the current bar being played.

getBar() - Method in interface org.deepsymmetry.electro.Snapshot

Get the metronome's bar number.

getBarInterval() - Method in class org.deepsymmetry.electro.Metronome

Get the number of milliseconds a bar lasts given the current configuration and tempo.

getBarInterval() - Method in interface org.deepsymmetry.electro.Snapshot

Get the metronome's bar length in time.

getBarPhase() - Method in class org.deepsymmetry.electro.Metronome

Determine the distance traveled into the current bar as a phase number in the range [0.0, 1.0).

getBarPhase() - Method in interface org.deepsymmetry.electro.Snapshot

Get the metronome's bar phase at the time of the snapshot, a value which starts at 0.0 at the very start of the bar, but never quite reaches 1.0, because that would be the start of the next bar.

getBarsPerPhrase() - Method in class org.deepsymmetry.electro.Metronome

Get the number of bars per phrase in the metronome's beat grid.

getBarsPerPhrase() - Method in interface org.deepsymmetry.electro.Snapshot

Get the metronome's phrase length in bars.

getBarWithinPhrase() - Method in class org.deepsymmetry.electro.Metronome

Return the current bar number relative to the start of the phrase: the phrase starts with bar 1, and the range goes up to the value of Metronome.getBarsPerPhrase().

getBarWithinPhrase() - Method in interface org.deepsymmetry.electro.Snapshot

Return the bar number of the snapshot relative to the start of the phrase: the phrase starts with bar 1, and the range goes up to the value of getBarsPerPhrase().

getBeat() - Method in class org.deepsymmetry.electro.Metronome

Get the current beat being played.

getBeat() - Method in interface org.deepsymmetry.electro.Snapshot

Get the metronome's beat number.

getBeatInterval() - Method in class org.deepsymmetry.electro.Metronome

Get the number of milliseconds a beat lasts given the current tempo.

getBeatInterval() - Method in interface org.deepsymmetry.electro.Snapshot

Get the metronome's beat length in time.

getBeatPhase() - Method in class org.deepsymmetry.electro.Metronome

Determine the distance traveled into the current beat as a phase number in the range [0.0, 1.0).

getBeatPhase() - Method in interface org.deepsymmetry.electro.Snapshot

Get the metronome's beat phase at the time of the snapshot, a value which starts at 0.0 at the very start of the beat, but never quite reaches 1.0, because that would be the start of the next beat.

getBeatsPerBar() - Method in class org.deepsymmetry.electro.Metronome

Get the number of beats per bar in the metronome's beat grid.

getBeatsPerBar() - Method in interface org.deepsymmetry.electro.Snapshot

Get the metronome's bar length in beats.

getBeatWithinBar() - Method in class org.deepsymmetry.electro.Metronome

Return the current beat number relative to the start of the bar: the down beat is 1, and the range goes up to the value of Metronome.getBeatsPerBar().

getBeatWithinBar() - Method in interface org.deepsymmetry.electro.Snapshot

Return the beat number of the snapshot relative to the start of the bar: the down beat is 1, and the range goes up to the value of getBeatsPerBar().

getBeatWithinPhrase() - Method in class org.deepsymmetry.electro.Metronome

Return the current beat number relative to the start of the phrase: the phrase starts with beat 1, and the range goes up to the value of Metronome.getBeatsPerBar() times Metronome.getBarsPerPhrase().

getBeatWithinPhrase() - Method in interface org.deepsymmetry.electro.Snapshot

Return the beat number of the snapshot relative to the start of the phrase: the phrase starts with beat 1, and the range goes up to the value of getBeatsPerBar() times getBarsPerPhrase().

getInstant() - Method in class org.deepsymmetry.electro.Metronome

Checks when a snapshot was taken; since you are working with a live metronome, always returns the current time.

getInstant() - Method in interface org.deepsymmetry.electro.Snapshot

Get the point in time with respect to which the snapshot is computed.

getMarker() - Method in class org.deepsymmetry.electro.Metronome

Returns the current count of the metronome as "phrase.bar.beat".

getMarker() - Method in interface org.deepsymmetry.electro.Snapshot

Returns the time represented by the snapshot as "phrase.bar.beat".

getPhrase() - Method in class org.deepsymmetry.electro.Metronome

Get the current phrase being played.

getPhrase() - Method in interface org.deepsymmetry.electro.Snapshot

Get the metronome's phrase number.

getPhraseInterval() - Method in class org.deepsymmetry.electro.Metronome

Get the number of milliseconds a phrase lasts given the current configuration and tempo.

getPhraseInterval() - Method in interface org.deepsymmetry.electro.Snapshot

Get the metronome's phrase length in time.

getPhrasePhase() - Method in class org.deepsymmetry.electro.Metronome

Determine the distance traveled into the current phrase as a phase number in the range [0.0, 1.0).

getPhrasePhase() - Method in interface org.deepsymmetry.electro.Snapshot

Get the metronome's phrase phase at the time of the snapshot, a value which starts at 0.0 at the very start of the phrase, but never quite reaches 1.0, because that would be the start of the next phrase.

getSnapshot() - Method in class org.deepsymmetry.electro.Metronome

Take a snapshot of the current beat, bar, phrase, and phase state, so coherent calculations about them can be performed with respect to a static point in time.

getSnapshot(long) - Method in class org.deepsymmetry.electro.Metronome

Take a snapshot of the beat, bar, phrase, and phase state that the metronome would have at the specified millisecond timestamp, so coherent calculations about them can be performed with respect to that static point in time.

getStartTime() - Method in class org.deepsymmetry.electro.Metronome

Returns the time at which this metronome was effectively started (tempo changes will shift this, as will a variety of methods which adjust the timeline).

getStartTime() - Method in interface org.deepsymmetry.electro.Snapshot

Get the metronome's timeline origin.

getTempo() - Method in class org.deepsymmetry.electro.Metronome

Get the tempo at which this metronome is running.

getTempo() - Method in interface org.deepsymmetry.electro.Snapshot

Get the metronome's tempo.

getTimeOfBar(long) - Method in class org.deepsymmetry.electro.Metronome

Determine the millisecond timestamp at which a particular bar will occur.

getTimeOfBar(long) - Method in interface org.deepsymmetry.electro.Snapshot

Determine the millisecond timestamp at which a particular bar will occur, given the metronome configuration when the snapshot was taken.

getTimeOfBeat(long) - Method in class org.deepsymmetry.electro.Metronome

Determine the millisecond timestamp at which a particular beat will occur.

getTimeOfBeat(long) - Method in interface org.deepsymmetry.electro.Snapshot

Determine the millisecond timestamp at which a particular beat will occur, given the metronome configuration when the snapshot was taken.

getTimeOfPhrase(long) - Method in class org.deepsymmetry.electro.Metronome

Determine the millisecond timestamp at which a particular phrase will occur.

getTimeOfPhrase(long) - Method in interface org.deepsymmetry.electro.Snapshot

Determine the millisecond timestamp at which a particular phrase will occur, given the metronome configuration when the snapshot was taken.

I

isDownBeat() - Method in class org.deepsymmetry.electro.Metronome

Checks whether the current beat is the first beat in its bar.

isDownBeat() - Method in interface org.deepsymmetry.electro.Snapshot

Checks whether the current beat at the time of the snapshot was the first beat in its bar.

isPhraseStart() - Method in class org.deepsymmetry.electro.Metronome

Checks whether the current beat is the first beat in its phrase.

isPhraseStart() - Method in interface org.deepsymmetry.electro.Snapshot

Checks whether the current beat at the time of the snapshot was the first beat in its phrase.

J

jumpToBar(long) - Method in class org.deepsymmetry.electro.Metronome

Restarts the metronome at the start of the specified bar, keeping the beat phase unchanged in case it is being synchronized to an external source.

jumpToBeat(long) - Method in class org.deepsymmetry.electro.Metronome

Restarts the metronome at the beginning of the specified beat number.

jumpToPhrase(long) - Method in class org.deepsymmetry.electro.Metronome

Restarts the metronome at the start of the specified phrase, keeping the beat phase unchanged in case it is being synchronized to an external source.

M

markerNumber(long, long, double) - Static method in class org.deepsymmetry.electro.Metronome

Helper function to calculate the beat, bar, or phrase number in effect at a given instant (in milliseconds) given a timeline starting point (start, also in milliseconds), and the interval (also in milliseconds) between beats, bars, or phrases.

markerPhase(long, long, double) - Static method in class org.deepsymmetry.electro.Metronome

Helper function to calculate the beat, bar, or phrase phase at a given instant (in milliseconds), given a timeline starting point (start, also in milliseconds), and the interval (also in milliseconds) between beats, bars, or phrases.

Metronome - Class in org.deepsymmetry.electro

A beat management tool.

Metronome() - Constructor for class org.deepsymmetry.electro.Metronome

N

normalizePhase(double) - Static method in class org.deepsymmetry.electro.Metronome

Ensure that a phase falls in the range [0.0, 1.0).

O

org.deepsymmetry.electro - package org.deepsymmetry.electro

A library for working with musical time.

S

setBarPhase(double) - Method in class org.deepsymmetry.electro.Metronome

Nudge the metronome so that it has reached the specified part of its current bar.

setBarsPerPhrase(int) - Method in class org.deepsymmetry.electro.Metronome

Establish a new number of bars per phrase in the metronome's beat grid.

setBeatPhase(double) - Method in class org.deepsymmetry.electro.Metronome

Nudge the metronome so that it has reached the specified part of its current beat.

setBeatsPerBar(int) - Method in class org.deepsymmetry.electro.Metronome

Establish a new number of beats per bar in the metronome's beat grid.

setPhrasePhase(double) - Method in class org.deepsymmetry.electro.Metronome

Nudge the metronome so that it has reached the specified part of its current phrase.

setTempo(double) - Method in class org.deepsymmetry.electro.Metronome

Establish a new tempo for the metronome.

Snapshot - Interface in org.deepsymmetry.electro

An interface for probing details about the timeline established by a metronome, with respect to a particular moment in time.

T

toString() - Method in class org.deepsymmetry.electro.Metronome

A B D E F G I J M N O S T