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

Public Member Functions

SettableEnumValue mode ()
 
SettableIntegerValue octaves ()
 
SettableBooleanValue isEnabled ()
 
SettableBooleanValue isFreeRunning ()
 
SettableBooleanValue shuffle ()
 
SettableDoubleValue rate ()
 
SettableDoubleValue gateLength ()
 
SettableBooleanValue enableOverlappingNotes ()
 
SettableBooleanValue usePressureToVelocity ()
 
void releaseNotes ()
 
SettableDoubleValue humanize ()
 
SettableBooleanValue terminateNotesImmediately ()
 
- Public Member Functions inherited from ObjectProxy
BooleanValue exists ()
 
BooleanValue createEqualsValue (ObjectProxy other)
 
- Public Member Functions inherited from Subscribable
boolean isSubscribed ()
 
void setIsSubscribed (boolean value)
 
void subscribe ()
 
void unsubscribe ()
 

Detailed Description

Proxy to an arpeggiator component.

Since
API version 10

Member Function Documentation

◆ enableOverlappingNotes()

SettableBooleanValue enableOverlappingNotes ( )

Let the arpeggiator play overlapping notes.

Since
API version 11

◆ gateLength()

SettableDoubleValue gateLength ( )

Returns an object to configure the note length, expressed as a ratio of the period. Must be between 1/32 and 8.

Since
API version 10

◆ humanize()

SettableDoubleValue humanize ( )

Will introduce human-like errors. Between 0 and 1.

Since
API version 11

◆ isEnabled()

SettableBooleanValue isEnabled ( )

Returns an object to enable or disable the note repeat component.

Since
API version 10

◆ isFreeRunning()

SettableBooleanValue isFreeRunning ( )

If true the arpeggiator will not try to sync to the transport.

Since
API version 10

◆ mode()

Returns an object to configure the arpeggiator mode. Possible values:

  • all
  • up
  • up-down
  • up-then-down
  • down
  • down-up
  • down-then-up
  • flow
  • random
  • converge-up
  • converge-down
  • diverge-up
  • diverge-down
  • thumb-up
  • thumb-down
  • pinky-up
  • pinky-down
Since
API version 10

◆ octaves()

SettableIntegerValue octaves ( )

Returns an object to configure the range in octaves. The range is between 0 and 8.

Since
API version 10

◆ rate()

Returns an object to configure the note repeat rate in beats.

Since
API version 10

◆ releaseNotes()

void releaseNotes ( )

Release all notes being played.

Since
API version 10

◆ shuffle()

SettableBooleanValue shuffle ( )

Return an object to configure the note repeat to use shuffle or not.

Since
API version 10

◆ terminateNotesImmediately()

SettableBooleanValue terminateNotesImmediately ( )

If set to true, it will terminate the playing note as soon as it is released, otherwise it will be held until its computed note-off time.

Since
API version 11

◆ usePressureToVelocity()

SettableBooleanValue usePressureToVelocity ( )

Will use the note pressure to determine the velocity of arpeggiated notes.

Since
API version 10

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