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

Public Member Functions

void setIndication (boolean shouldIndicate)
 
void clearMutedPads ()
 
void clearSoloedPads ()
 
BooleanValue hasMutedPads ()
 
BooleanValue hasSoloedPads ()
 
- Public Member Functions inherited from ChannelBank< DrumPad >
Channel getChannel (int indexInBank)
 
void setChannelScrollStepSize (int stepSize)
 
void scrollChannelsPageUp ()
 
void scrollChannelsPageDown ()
 
void scrollChannelsUp ()
 
void scrollChannelsDown ()
 
void scrollToChannel (int position)
 
IntegerValue channelScrollPosition ()
 
void addChannelScrollPositionObserver (IntegerValueChangedCallback callback, int valueWhenUnassigned)
 
BooleanValue canScrollChannelsUp ()
 
void addCanScrollChannelsUpObserver (BooleanValueChangedCallback callback)
 
BooleanValue canScrollChannelsDown ()
 
void addCanScrollChannelsDownObserver (BooleanValueChangedCallback callback)
 
IntegerValue channelCount ()
 
void addChannelCountObserver (IntegerValueChangedCallback callback)
 
void scrollSendsPageUp ()
 
void scrollSendsPageDown ()
 
void scrollSendsUp ()
 
void scrollSendsDown ()
 
void scrollToSend (int position)
 
void addCanScrollSendsUpObserver (BooleanValueChangedCallback callback)
 
void addCanScrollSendsDownObserver (BooleanValueChangedCallback callback)
 
void addSendCountObserver (IntegerValueChangedCallback callback)
 

Detailed Description

Drum pads are features of special Bitwig Studio devices (currently only the Bitwig Drum Machine instrument), and are also shown as sub-channels in the mixer panel.

Instances of drum pad bank are configured with a fixed number of pads/channels and represent an excerpt of underlying complete list of channels. Various methods are provided for scrolling to different sections of the underlying list. It basically acts like a one-dimensional window moving over the drum pad channels.

To receive an instance of drum pad bank call Device#createDrumPadBank(int numChannels).

See also
Device#createDrumPadBank
Since
API version 1

Member Function Documentation

◆ clearMutedPads()

void clearMutedPads ( )

Clears mute on all drum pads.

Since
API version 10

◆ clearSoloedPads()

void clearSoloedPads ( )

Clears solo on all drum pads.

Since
API version 10

◆ hasMutedPads()

BooleanValue hasMutedPads ( )

True if there is one or many muted pads.

Since
API version 10

◆ hasSoloedPads()

BooleanValue hasSoloedPads ( )

True if there is one or many soloed pads.

Since
API version 10

◆ setIndication()

void setIndication ( boolean  shouldIndicate)

Specifies if the Drum Machine should visualize which pads are part of the window. By default indications are enabled.

Parameters
shouldIndicatetrue if visual indications should be enabled, false otherwise
Since
API version 1

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