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

Public Member Functions

StringArrayValue pageNames ()
 
void selectNextPage (boolean shouldCycle)
 
void selectPreviousPage (boolean shouldCycle)
 
void selectNextPageMatching (String expression, boolean shouldCycle)
 
void selectPreviousPageMatching (String expression, boolean shouldCycle)
 
SettableIntegerValue selectedPageIndex ()
 
IntegerValue pageCount ()
 
void createPresetPage ()
 
HardwareActionBindable createPresetPageAction ()
 
- Public Member Functions inherited from Cursor
void selectPrevious ()
 
HardwareActionBindable selectPreviousAction ()
 
void selectNext ()
 
HardwareActionBindable selectNextAction ()
 
void selectFirst ()
 
void selectLast ()
 
BooleanValue hasNext ()
 
BooleanValue hasPrevious ()
 
void addCanSelectPreviousObserver (BooleanValueChangedCallback callback)
 
void addCanSelectNextObserver (BooleanValueChangedCallback callback)
 
- Public Member Functions inherited from RelativeHardwarControlBindable
default RelativeHardwareControlBinding addBinding (RelativeHardwareControl hardwareControl)
 
RelativeHardwareControlBinding addBindingWithSensitivity (RelativeHardwareControl hardwareControl, double sensitivity)
 
- Public Member Functions inherited from RemoteControlsPage
RemoteControl getParameter (int indexInBank)
 
StringValue getName ()
 
- Public Member Functions inherited from ParameterBank
int getParameterCount ()
 
void setHardwareLayout (HardwareControlType type, int columns)
 

Detailed Description

Represents a cursor that looks at a RemoteControlsPage.

Since
API version 2

Member Function Documentation

◆ createPresetPage()

void createPresetPage ( )

Creates a new preset page.

Since
API version 16

◆ createPresetPageAction()

HardwareActionBindable createPresetPageAction ( )

◆ pageCount()

IntegerValue pageCount ( )

Value that represents the number of pages.

Since
API version 7

◆ pageNames()

StringArrayValue pageNames ( )

Value that reports the names of the devices parameter pages.

◆ selectedPageIndex()

SettableIntegerValue selectedPageIndex ( )

Value that reports the currently selected parameter page index.

Since
API version 2

◆ selectNextPage()

void selectNextPage ( boolean  shouldCycle)

Selects the next page.

Parameters
shouldCycleIf true then when the end is reached and there is no next page it selects the first page
Since
API version 2

◆ selectNextPageMatching()

void selectNextPageMatching ( String  expression,
boolean  shouldCycle 
)

Selects the next page that matches the given expression.

Parameters
expressionAn expression that can match a page based on how it has been tagged. For now this can only be the name of a single tag that you would like to match.
shouldCycleIf true then when the end is reached and there is no next page it selects the first page
Since
API version 2

◆ selectPreviousPage()

void selectPreviousPage ( boolean  shouldCycle)

Selects the previous page.

Parameters
shouldCycleIf true then when the end is reached and there is no next page it selects the first page
Since
API version 2

◆ selectPreviousPageMatching()

void selectPreviousPageMatching ( String  expression,
boolean  shouldCycle 
)

Selects the previous page that matches the given expression.

Parameters
expressionAn expression that can match a page based on how it has been tagged. For now this can only be the name of a single tag that you would like to match.
shouldCycleIf true then when the end is reached and there is no next page it selects the first page
Since
API version 2

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