-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBitwigAPI20.txt
More file actions
18849 lines (15984 loc) · 539 KB
/
BitwigAPI20.txt
File metadata and controls
18849 lines (15984 loc) · 539 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Processing Extension.java...
package com.bitwig.extension;
import com.bitwig.extension.api.Host;
public abstract class Extension<HostType extends Host, DefinitionType extends ExtensionDefinition>
{
protected Extension(final DefinitionType extensionDefinition, final HostType host)
{
super();
mExtensionDefinition = extensionDefinition;
mHost = host;
}
public HostType getHost()
{
return mHost;
}
public DefinitionType getExtensionDefinition()
{
return mExtensionDefinition;
}
private final DefinitionType mExtensionDefinition;
private final HostType mHost;
}
Processing ExtensionDefinition.java...
package com.bitwig.extension;
import java.util.UUID;
/** Base class for defining any kind of extension for Bitwig Studio. */
public abstract class ExtensionDefinition
{
/** The name of the extension. */
public abstract String getName();
/** The author of the extension. */
public abstract String getAuthor();
/** The version of the extension. */
public abstract String getVersion();
/** A unique id that identifies this extension. */
public abstract UUID getId();
/** The minimum API version number that this extensions requires. */
public abstract int getRequiredAPIVersion();
/**
* Is this extension is using Beta APIs?
*
* Beta APIs are still on development and might not be available in a future version of Bitwig Studio.
*
* Turning this flag to true, will flag your extension as being a beta extension which might not work after
* updating Bitwig Studio.
*
* @return true if the extension wants to use Beta APIs.
*/
public boolean isUsingBetaAPI()
{
return false;
}
/**
* Gets a remote URI or a path within the extension's jar file where documentation for this extension can
* be found or null if there is none. If the path is not a URI then it is assumed to be a path below the directory
* "Documentation" within the extension's jar file.
*/
public String getHelpFilePath()
{
return null;
}
/**
* Gets a remote URI or a path within the extension's jar file where support files for this extension can
* be found or null if there is none. If the path is not a URI then it is assumed to be a path below the directory
* "Documentation" within the extension's jar file.
*
* Support files are for example a configuration file that one has use with a configuration software.
*
* @since API version 13
*/
public String getSupportFolderPath()
{
return null;
}
/**
* If true then this extension should fail when it calls a deprecated method in the API. This is useful
* during development.
*/
public boolean shouldFailOnDeprecatedUse()
{
return true;
}
/**
* An e-mail address that can be used to contact the author of this extension if a problem is detected with
* it or null if none.
*/
public String getErrorReportingEMail()
{
return null;
}
@Override
public String toString()
{
return "Extension[name=" + getName() + ", author=" + getAuthor() + ", version=" + getVersion() + ", id="
+ getId() + "]";
}
}
Processing HardwareDeviceMatcher.java...
package com.bitwig.extension.controller;
/** Matcher that can match a particular hardware device that is connected to the user's machine.
* Subclasses of this define how the hardware is connected.
* Currently only USB devices are supported.
* @see UsbDeviceMatcher
* @see ControllerExtensionDefinition#listHardwareDevices(HardwareDeviceMatcherList) */
public abstract class HardwareDeviceMatcher
{
protected HardwareDeviceMatcher(final String name)
{
super();
mName = name;
}
/** Human friendly name for the kinds of hardware devices this matcher matches. */
public String getName()
{
return mName;
}
private final String mName;
}
Processing UsbMatcher.java...
package com.bitwig.extension.controller;
public abstract class UsbMatcher
{
UsbMatcher(final String expression, final int matchOccurrence)
{
super();
assert matchOccurrence >= 1;
mExpression = expression;
mMatchOccurrence = matchOccurrence;
}
public final String getExpression()
{
return mExpression;
}
public final int getMatchOccurrence()
{
return mMatchOccurrence;
}
private final String mExpression;
private final int mMatchOccurrence;
}
Processing UsbEndpointMatcher.java...
package com.bitwig.extension.controller;
import com.bitwig.extension.controller.api.UsbTransferDirection;
import com.bitwig.extension.controller.api.UsbTransferType;
public class UsbEndpointMatcher extends UsbMatcher
{
public UsbEndpointMatcher(
final UsbTransferDirection direction,
final UsbTransferType transferType,
final String expression,
final int matchOccurrenceIndex)
{
super(expression, matchOccurrenceIndex);
mDirection = direction;
mTransferType = transferType;
}
public UsbEndpointMatcher(
final UsbTransferDirection direction,
final UsbTransferType transferType,
final String expression)
{
this(direction, transferType, expression, 1);
}
public UsbEndpointMatcher(final UsbTransferType transferType, final byte bEndpointAddress)
{
this(UsbTransferDirection.getForEndpointAddress(bEndpointAddress), transferType, "bEndpointAddress == " + (bEndpointAddress & 0xff));
}
public UsbTransferDirection getDirection()
{
return mDirection;
}
public UsbTransferType getTransferType()
{
return mTransferType;
}
private final UsbTransferDirection mDirection;
private final UsbTransferType mTransferType;
}
Processing ControllerExtension.java...
package com.bitwig.extension.controller;
import com.bitwig.extension.Extension;
import com.bitwig.extension.controller.api.ControllerHost;
import com.bitwig.extension.controller.api.MidiIn;
import com.bitwig.extension.controller.api.MidiOut;
/**
* Defines an extension that enabled a controller to work with Bitwig Studio.
*/
public abstract class ControllerExtension extends Extension<ControllerHost, ControllerExtensionDefinition>
{
protected ControllerExtension(final ControllerExtensionDefinition definition, final ControllerHost host)
{
super(definition, host);
}
public final MidiIn getMidiInPort(final int index)
{
return getHost().getMidiInPort(index);
}
public final MidiOut getMidiOutPort(final int index)
{
return getHost().getMidiOutPort(index);
}
/**
* Initializes this controller extension. This will be called once when the extension is started. During initialization the
* extension should call the various create methods available via the {@link ControllerHost} interface in order to
* create objects used to communicate with various parts of the Bitwig Studio application (e.g
* {@link ControllerHost#createCursorTrack(int, int)}.
*/
public abstract void init();
/**
* Called once when this controller extension is stopped.
*/
public abstract void exit();
/**
* Called when this controller extension should flush any pending updates to the controller.
*/
public abstract void flush();
}
Processing ControllerExtensionDefinition.java...
package com.bitwig.extension.controller;
import com.bitwig.extension.ExtensionDefinition;
import com.bitwig.extension.api.PlatformType;
import com.bitwig.extension.controller.api.ControllerHost;
/**
* Defines an extension that enabled a controller to work with Bitwig Studio.
*/
public abstract class ControllerExtensionDefinition extends ExtensionDefinition
{
@Override
public String toString()
{
return "ControllerExtension[name=" + getName() + ", author=" + getAuthor() + ", version=" + getVersion()
+ ", hardwareVendor=" + getHardwareVendor() + ", hardwareModel=" + getHardwareModel() + ", id="
+ getId() + "]";
}
/** The vendor of the controller that this extension is for. */
public abstract String getHardwareVendor();
/** The model name of the controller that this extension is for. */
public abstract String getHardwareModel();
/** The number of MIDI in ports that this controller extension has. */
public abstract int getNumMidiInPorts();
/** The number of MIDI out ports that this controller extension has. */
public abstract int getNumMidiOutPorts();
/**
* Obtains a {@link AutoDetectionMidiPortNamesList} that defines the names of the MIDI in and out ports
* that can be used for auto detection of the controller for the supplied platform type.
*/
public final AutoDetectionMidiPortNamesList getAutoDetectionMidiPortNamesList(
final PlatformType platformType)
{
final AutoDetectionMidiPortNamesList list = new AutoDetectionMidiPortNamesList();
listAutoDetectionMidiPortNames(list, platformType);
return list;
}
/**
* Lists the {@link AutoDetectionMidiPortNames} that defines the names of the MIDI in and out ports that
* can be used for auto detection of the controller for the supplied platform type.
*/
public abstract void listAutoDetectionMidiPortNames(
AutoDetectionMidiPortNamesList list,
PlatformType platformType);
public final HardwareDeviceMatcherList getHardwareDeviceMatcherList()
{
final HardwareDeviceMatcherList list = new HardwareDeviceMatcherList();
listHardwareDevices(list);
return list;
}
/**
* Lists the hardware devices that this controller needs to function. For each device that is listed the
* user will see a chooser in the preferences for this extension that allows them to choose a connected
* device. The {@link HardwareDeviceMatcher} will also be used during auto detection to automatically add
* and select the device if possible.
*
* @since API version 7
*/
public void listHardwareDevices(final HardwareDeviceMatcherList list)
{
}
/** Creates an instance of this extension. */
public abstract ControllerExtension createInstance(ControllerHost host);
/**
* Checks if this controller should be subscribed to objects by default.
*
* Prior to API version 10 all objects were subscribed by default. If this is overriden to return false
* then it is the controller's job to call {@link ObjectProxy#subscribe()} for the objects that the
* controller is interested in.
*
* @since API version 10
*/
// public boolean shouldBeSubscribedByDefault()
// {
// return true;
// }
}
Processing AutoDetectionMidiPortNamesList.java...
package com.bitwig.extension.controller;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
public class AutoDetectionMidiPortNamesList
{
public void add(final String[] inputNames, final String[] outputNames)
{
mList.add(new AutoDetectionMidiPortNames(inputNames, outputNames));
}
public List<AutoDetectionMidiPortNames> getPortNames()
{
return Collections.unmodifiableList(mList);
}
public int getCount()
{
return mList.size();
}
public AutoDetectionMidiPortNames getPortNamesAt(final int index)
{
return mList.get(index);
}
private final List<AutoDetectionMidiPortNames> mList = new ArrayList<>(5);
}
Processing AutoDetectionMidiPortNames.java...
package com.bitwig.extension.controller;
public class AutoDetectionMidiPortNames
{
public AutoDetectionMidiPortNames(final String[] inputNames, final String[] outputNames)
{
super();
mInputNames = inputNames;
mOutputNames = outputNames;
}
public String[] getInputNames()
{
return mInputNames;
}
public String[] getOutputNames()
{
return mOutputNames;
}
private final String[] mInputNames, mOutputNames;
}
Processing HardwareDeviceMatcherList.java...
package com.bitwig.extension.controller;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* Defines a list of all the hardware devices that a controller needs.
*
* @since API version 7
*/
public class HardwareDeviceMatcherList
{
/**
* Adds information about a hardware device that is needed and how it can be matched. The hardware device
* will need to match at least one of the supplied matchers.
*
* For each entry added to this list the user will see a device chooser that lets them select an
* appropriate device. The information added here is also used for auto detection purposes.
*/
public void add(final HardwareDeviceMatcher... deviceMatchers)
{
mList.add(deviceMatchers);
}
/** The number of hardware devices in the list. */
public int getCount()
{
return mList.size();
}
public HardwareDeviceMatcher[] getHardwareDeviceMatchersAt(final int index)
{
return mList.get(index);
}
public List<HardwareDeviceMatcher[]> getList()
{
return Collections.unmodifiableList(mList);
}
private final List<HardwareDeviceMatcher[]> mList = new ArrayList<>(2);
}
Processing UsbConfigurationMatcher.java...
package com.bitwig.extension.controller;
public class UsbConfigurationMatcher extends UsbMatcher
{
public UsbConfigurationMatcher(final String expression, final int matchOccurrenceIndex, final UsbInterfaceMatcher... interfaceMatchers)
{
super(expression, matchOccurrenceIndex);
mInterfaceMatchers = interfaceMatchers;
}
public UsbConfigurationMatcher(final String expression, final UsbInterfaceMatcher... interfaceMatchers)
{
this(expression, 1, interfaceMatchers);
}
public UsbConfigurationMatcher(final int matchOccurrenceIndex, final UsbInterfaceMatcher... interfaceMatchers)
{
this("", matchOccurrenceIndex, interfaceMatchers);
}
public UsbConfigurationMatcher(final UsbInterfaceMatcher... interfaceMatchers)
{
this(1, interfaceMatchers);
}
public UsbInterfaceMatcher[] getInterfaceMatchers()
{
return mInterfaceMatchers;
}
private final UsbInterfaceMatcher[] mInterfaceMatchers;
}
Processing UsbInterfaceMatcher.java...
package com.bitwig.extension.controller;
public class UsbInterfaceMatcher extends UsbMatcher
{
public UsbInterfaceMatcher(final String expression, final int matchOccurrence, final UsbEndpointMatcher... endpointMatchers)
{
super(expression, matchOccurrence);
mEndpointMatchers = endpointMatchers;
}
public UsbInterfaceMatcher(final String expression, final UsbEndpointMatcher... endpointMatchers)
{
this(expression, 1, endpointMatchers);
}
public UsbEndpointMatcher[] getEndpointMatchers()
{
return mEndpointMatchers;
}
private final UsbEndpointMatcher[] mEndpointMatchers;
}
Processing EnumDefinition.java...
package com.bitwig.extension.controller.api;
import com.bitwig.extension.api.opensoundcontrol.OscMethod;
import com.bitwig.extension.api.opensoundcontrol.OscNode;
/**
* Defines an enumeration.
*
* @since API version 11
*/
public interface EnumDefinition
{
/**
* Gets the number of entries in the enum, must be greater than 0.
* @since API version 11
*/
@OscMethod
int getValueCount();
/**
* Gets the {@link EnumValueDefinition} for the given index.
* @param valueIndex must be in the range 0 .. {@link #getValueCount()} - 1.
* @return null if not found
* @since API version 11
*/
@OscNode
EnumValueDefinition valueDefinitionAt(int valueIndex);
/**
* Gets the {@link EnumValueDefinition} for the given enum id.
* @return null if not found
* @since API version 11
*/
@OscNode
EnumValueDefinition valueDefinitionFor(String id);
}
Processing HardwareControlType.java...
package com.bitwig.extension.controller.api;
/**
*
*/
public enum HardwareControlType
{
KNOB, // Absolute control
SLIDER, // Absolute control
ENCODER, // Relative control (never shows takeover-indication)
}
Processing BrowserResultsItemBank.java...
package com.bitwig.extension.controller.api;
/**
* Instances of this interface are used to navigate the results column in the Bitwig Studio browser.
*
* @since API version 1
*/
public interface BrowserResultsItemBank extends BrowserItemBank<BrowserResultsItem>
{
}
Processing HardwareAction.java...
package com.bitwig.extension.controller.api;
/**
* An action that can happen on a hardware control. For example, the user touching it, pressing it, releasing
* it etc.
*
* @since API version 10
*/
public interface HardwareAction extends HardwareBindingSource<HardwareActionBinding>
{
/** Sets the {@link HardwareActionMatcher} that is used to recognize when this action happens. */
void setActionMatcher(HardwareActionMatcher actionMatcher);
/**
* Sets the {@link AbsoluteHardwareValueMatcher} that is used to recognize when this action happens and
* with what pressure.
*
* This is useful for a button press that is pressure sensitive. The pressure can be obtained by creating a
* custom action with
* {@link ControllerHost#createAction(java.util.function.DoubleConsumer, java.util.function.Supplier)} and
* then binding the created action to this {@link HardwareAction}.
*/
void setPressureActionMatcher(AbsoluteHardwareValueMatcher actionMatcher);
/**
* Checks if this action is supported (that is, it has a {@link HardwareActionMatcher} that can detect it).
*/
boolean isSupported();
/**
* Decides if this action should fire even if the hardware input that matched it was also used as note
* input. Note input is defined as input that matches a {@link NoteInput} mask and its event translations.
* Usually events should only be note input or actions but not both at the same time (this is the default
* state). However, occasionally it is useful for a note event to be played as both note input and also
* trigger some action. For example, a drum pad may play a note but in a special mode on the controller it
* should also select the pad somehow. In this case it would be both note input and the action that fires
* to select the pad.
*
* @since API version 11
*/
void setShouldFireEvenWhenUsedAsNoteInput(boolean value);
}
Processing CursorDeviceFollowMode.java...
package com.bitwig.extension.controller.api;
/**
* Mode that defines how a {@link CursorDevice} follows a device within the {@link CursorTrack} it is created
* for by default. The user can still override this on a track by track basis but this defines a default
* follow mode when the user has not done this.
*/
public enum CursorDeviceFollowMode
{
/** Follows the device selection made by the user in the track. */
FOLLOW_SELECTION,
/** Selects the first device in the track if there is one. */
FIRST_DEVICE,
/** Selects the first instrument in the track if there is one. */
FIRST_INSTRUMENT,
/** Selects the first audio effect in the track if there is one. */
FIRST_AUDIO_EFFECT,
/**
* Selects the first instrument or if there is no instrument the first device.
*
* @since API version 3
*/
FIRST_INSTRUMENT_OR_DEVICE,
/**
* Selects the last device in the track if there is one.
* @since API version 7
*/
LAST_DEVICE,
}
Processing SpecificDevice.java...
package com.bitwig.extension.controller.api;
/**
* Interface that can be used to directly access a specific device (Bitwig native device or plug-in).
*
* @since API version 12
* */
public interface SpecificDevice extends ObjectProxy
{
}
Processing ChainSelector.java...
package com.bitwig.extension.controller.api;
import com.bitwig.extension.api.opensoundcontrol.OscNode;
/**
* This interface represents a chain selector device which can be:
* - instrument selector
* - effect selector
*
* @since API version 6
*/
public interface ChainSelector extends ObjectProxy, Cursor
{
/**
* The index of the active chain in the chain selector.
* In case the chain selector has no chains or the value is not connected to the chain selector,
* then the value will be 0.
*
* @since API version 6
*/
@OscNode
SettableIntegerValue activeChainIndex();
/**
* The number of chains in the chain selector.
*
* @since API version 6
*/
IntegerValue chainCount();
/**
* The active device layer.
*
* @since API version 6
*/
@OscNode
DeviceLayer activeChain();
/**
* Cycle to the next chain.
* If the current active chain is the last one, then moves to the first one.
*
* @since API version 6
*/
void cycleNext();
/**
* Cycle to the previous chain.
* If the current active chain the first one, then moves to the last one.
*
* @since API version 6
*/
void cyclePrevious();
}
Processing ClipLauncherSlotOrScene.java...
package com.bitwig.extension.controller.api;
import com.bitwig.extension.api.opensoundcontrol.OscMethod;
import com.bitwig.extension.api.opensoundcontrol.OscNode;
public interface ClipLauncherSlotOrScene extends ObjectProxy, DeleteableObject, DuplicableObject
{
/**
* Returns an object that provides access to the name of the scene.
*
* @return a string value object that represents the scene name.
* @since API version 2
*/
@OscNode
StringValue name();
/**
* Launches the clip or scene.
*
* @since API version 1
*/
@OscMethod
void launch();
HardwareActionBindable launchAction();
/**
* Launches with alternative settings.
*
* @since API version 18
*/
@OscMethod
void launchAlt();
/**
* @since API version 18
*/
HardwareActionBindable launchAltAction();
/**
* Call it when the pad is released.
*
* @since API version 18
*/
@OscMethod
void launchRelease();
/**
* @since API version 18
*/
HardwareActionBindable launchReleaseAction();
/**
* Call it when the pad is released with alternative settings.
*
* @since API version 18
*/
@OscMethod
void launchReleaseAlt();
/**
* @since API version 18
*/
HardwareActionBindable launchReleaseAltAction();
/**
* Launches with the given options:
*
* @param quantization
* possible values are "default", "none", "8", "4", "2", "1", "1/2", "1/4", "1/8", "1/16"
* @param launchMode
* possible values are: "default", "from_start", "continue_or_from_start",
* "continue_or_synced", "synced"
*
* @since API version 16
*/
@OscMethod
void launchWithOptions(final String quantization, final String launchMode);
HardwareActionBindable launchWithOptionsAction(final String quantization, final String launchMode);
/**
* Launches the last clip with the given options:
*
* @param quantization
* possible values are "default", "none", "8", "4", "2", "1", "1/2", "1/4", "1/8", "1/16"
* @param launchMode
* possible values are: "default", "from_start", "continue_or_from_start",
* "continue_or_synced", "synced"
*
* @since API version 16
*/
@OscMethod
void launchLastClipWithOptions(final String quantization, final String launchMode);
HardwareActionBindable launchLastClipWithOptionsAction(final String quantization, final String launchMode);
/**
* Value that reports the position of the scene within the list of Bitwig Studio scenes.
*
* @since API version 2
*/
@OscNode
IntegerValue sceneIndex();
/**
* Copies the current slot or scene into the dest slot or scene.
*
* @since API version 4
* @deprecated Use {@link #replaceInsertionPoint()} instead.
*/
@Deprecated
void copyFrom(ClipLauncherSlotOrScene source);
/**
* Moves the current slot or scene into the destination slot or scene.
*
* @since API version 4
* @deprecated Use {@link #replaceInsertionPoint()} instead.
*/
@Deprecated
void moveTo(ClipLauncherSlotOrScene dest);
/**
* Value that reports the color of this slot.
*
* @since API version 7
*/
@OscNode
SettableColorValue color();
/**
* Specifies if the Bitwig Studio clip launcher should indicate which slots and scenes are part of the
* window. By default indications are disabled.
*
* @param shouldIndicate
* `true` if visual indications should be enabled, `false` otherwise
* @since API version 10
* @deprecated Clip launcher indication is now not per slot or scene but instead as a framed rectangle in
* the user interface. Use {@link SceneBank#setIndication(boolean)} or
* {@link TrackBank#setShouldShowClipLauncherFeedback(boolean)}
*/
@Deprecated
@OscMethod
void setIndication(boolean shouldIndicate);
/**
* An {@link InsertionPoint} that is used to replace the contents of this slot or scene.
*
* @since API version 7
*/
InsertionPoint replaceInsertionPoint();
/**
* An {@link InsertionPoint} that can be used to insert content in the next scene.
*
* @since API version 7
*/
InsertionPoint nextSceneInsertionPoint();
/**
* An {@link InsertionPoint} that can be used to insert content after this slot or scene.
*
* @since API version 7
*/
InsertionPoint previousSceneInsertionPoint();
}
Processing HardwareInputMatcher.java...
package com.bitwig.extension.controller.api;
/**
* Defines a means of recognizing when some kind of hardware input happens.
*
* For example, when a certain MIDI CC message happens.
*
* @see MidiIn#createActionMatcher(String)
*
* @since API version 10
*
*/
public interface HardwareInputMatcher
{
}
Processing HardwareActionBinding.java...
package com.bitwig.extension.controller.api;
/**
* Represents a binding from a hardware action (such as user pressing a button) to some target action.
*
* @since API version 10
* */
public interface HardwareActionBinding extends HardwareBinding
{
}
Processing CursorBrowserFilterItem.java...
package com.bitwig.extension.controller.api;
/**
* Instances of this interface represent entries in a browser filter column.
*
* @since API version 1
*/
public interface CursorBrowserFilterItem extends BrowserFilterItem, CursorBrowserItem
{
/**
* Select the parent item.
*
* @since API version 1
*/
void selectParent();
/**
* Select the first child item.
*
* @since API version 1
*/
void selectFirstChild();
/**