Package com.bitwig.extension.controller.api

Interface DrumPadBank

All Superinterfaces:

Bank<DrumPad>, ChannelBank<DrumPad>, HardwareBindable, ObjectProxy, RelativeHardwarControlBindable, Scrollable, Subscribable

public interface DrumPadBank
extends ChannelBank<DrumPad>

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).

Since:

API version 1

See Also:

• Device.createDrumPadBank(int)

Method Summary

Modifier and Type	Method	Description
void	clearMutedPads()	Clears mute on all drum pads.
void	clearSoloedPads()	Clears solo on all drum pads.
BooleanValue	hasMutedPads()	True if there is one or many muted pads.
BooleanValue	hasSoloedPads()	True if there is one or many soloed pads.
void	setIndication(boolean shouldIndicate)	Specifies if the Drum Machine should visualize which pads are part of the window.

Methods inherited from interface com.bitwig.extension.controller.api.Bank

cursorIndex, getCapacityOfBank, getItemAt, getSizeOfBank, itemCount, setSizeOfBank, setSkipDisabledItems

Methods inherited from interface com.bitwig.extension.controller.api.ChannelBank

addCanScrollChannelsDownObserver, addCanScrollChannelsUpObserver, addCanScrollSendsDownObserver, addCanScrollSendsUpObserver, addChannelCountObserver, addChannelScrollPositionObserver, addSendCountObserver, canScrollChannelsDown, canScrollChannelsUp, channelCount, channelScrollPosition, getChannel, scrollChannelsDown, scrollChannelsPageDown, scrollChannelsPageUp, scrollChannelsUp, scrollSendsDown, scrollSendsPageDown, scrollSendsPageUp, scrollSendsUp, scrollToChannel, scrollToSend, setChannelScrollStepSize

Methods inherited from interface com.bitwig.extension.controller.api.ObjectProxy

createEqualsValue, exists

Methods inherited from interface com.bitwig.extension.controller.api.RelativeHardwarControlBindable

addBinding, addBindingWithSensitivity

Methods inherited from interface com.bitwig.extension.controller.api.Scrollable

canScrollBackwards, canScrollForwards, scrollBackwards, scrollBackwardsAction, scrollBy, scrollByPages, scrollForwards, scrollForwardsAction, scrollIntoView, scrollPageBackwards, scrollPageBackwardsAction, scrollPageForwards, scrollPageForwardsAction, scrollPosition

Methods inherited from interface com.bitwig.extension.controller.api.Subscribable

isSubscribed, setIsSubscribed, subscribe, unsubscribe

Method Details

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:

shouldIndicate - `true` if visual indications should be enabled, `false` otherwise

Since:

API version 1

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