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

Public Member Functions

String getId ()
 
String getName ()
 
ActionCategory getCategory ()
 
String getMenuItemText ()
 
void invoke ()
 
- Public Member Functions inherited from HardwareActionBindable
HardwareActionBinding addBinding (HardwareAction action)
 

Detailed Description

Instances of this interface represent actions in Bitwig Studio, such as commands that can be launched from the main menu or via keyboard shortcuts.

To receive the list of all actions provided by Bitwig Studio call Application#getActions(). The list of actions that belong to a certain category can be queried by calling ActionCategory#getActions(). Access to specific actions is provided in Application#getAction(String).

Since
API version 1

Member Function Documentation

◆ getCategory()

ActionCategory getCategory ( )

Returns the category of this action.

Returns
the category string
Since
API version 1

◆ getId()

String getId ( )

Returns a string the identifies this action uniquely.

Returns
the identifier string
Since
API version 1

◆ getMenuItemText()

String getMenuItemText ( )

Returns the text that is displayed in menu items associated with this action.

Returns
the menu item text
Since
API version 1

◆ getName()

String getName ( )

Returns the name of this action.

Returns
the name string
Since
API version 1

◆ invoke()

void invoke ( )

Invokes the action.

Since
API version 1

Implements HardwareActionBindable.


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