Bitwig Studio Control Surface API  5.0.11
BeatTimeValue Interface Reference
+ Inheritance diagram for BeatTimeValue:

Public Member Functions

void addRawValueObserver (DoubleValueChangedCallback callback)
 
String getFormatted (BeatTimeFormatter formatter)
 
String getFormatted ()
 
void addTimeObserver (String separator, int barsLen, int beatsLen, int subdivisionLen, int ticksLen, StringValueChangedCallback callback)
 
- Public Member Functions inherited from DoubleValue
double get ()
 
default double getAsDouble ()
 
- Public Member Functions inherited from Value< DoubleValueChangedCallback >
void markInterested ()
 
void addValueObserver (ObserverType callback)
 

Detailed Description

Instances of this interface represent beat time values.

Beat time values are double-precision number representing the number of quarter notes, regardless of time-signature.

Since
API version 1

Member Function Documentation

◆ addRawValueObserver()

void addRawValueObserver ( DoubleValueChangedCallback  callback)

Add an observer which receives the internal raw of the parameter as floating point.

Parameters
callbacka callback function that receives a single numeric parameter with double precision.
Since
API version 1
Deprecated:
This exists for backwards compatibility. Use addValueObserver(DoubleValueChangedCallback) instead.

◆ addTimeObserver()

void addTimeObserver ( String  separator,
int  barsLen,
int  beatsLen,
int  subdivisionLen,
int  ticksLen,
StringValueChangedCallback  callback 
)

Registers an observer that reports the internal beat time value as formatted text, for example "012:03:00:01".

Parameters
separatorthe character used to separate the segments of the formatted beat time, typically ":", "." or "-"
barsLenthe number of digits reserved for bars
beatsLenthe number of digits reserved for beats
subdivisionLenthe number of digits reserved for beat subdivisions
ticksLenthe number of digits reserved for ticks
callbacka callback function that receives a single string parameter
Since
API version 1
Deprecated:
Use getFormatted(BeatTimeFormatter) instead.

◆ getFormatted() [1/2]

String getFormatted ( )

Gets the current beat time formatted according to the default beat time formatter.

See also
ControllerHost::setDefaultBeatTimeFormatter(BeatTimeFormatter)
Since
API version 2

◆ getFormatted() [2/2]

String getFormatted ( BeatTimeFormatter  formatter)

Gets the current beat time formatted according to the supplied formatter.

Since
API version 2

The documentation for this interface was generated from the following file: