Bitwig Studio Control Surface API  5.0.11
Mixer Interface Reference

Public Member Functions

SettableBooleanValue isMeterSectionVisible ()
 
SettableBooleanValue isIoSectionVisible ()
 
SettableBooleanValue isSendSectionVisible ()
 
SettableBooleanValue isClipLauncherSectionVisible ()
 
SettableBooleanValue isDeviceSectionVisible ()
 
SettableBooleanValue isCrossFadeSectionVisible ()
 
HardwareActionBindable zoomInTrackWidthsAllAction ()
 
void zoomInTrackWidthsAll ()
 
HardwareActionBindable zoomOutTrackWidthsAllAction ()
 
void zoomOutTrackWidthsAll ()
 
RelativeHardwarControlBindable zoomTrackWidthsAllStepper ()
 
HardwareActionBindable zoomInTrackWidthsSelectedAction ()
 
void zoomInTrackWidthsSelected ()
 
HardwareActionBindable zoomOutTrackWidthsSelectedAction ()
 
void zoomOutTrackWidthsSelected ()
 
RelativeHardwarControlBindable zoomTrackWidthsSelectedStepper ()
 
void addMeterSectionVisibilityObserver (final BooleanValueChangedCallback callback)
 
void addIoSectionVisibilityObserver (final BooleanValueChangedCallback callback)
 
void addSendsSectionVisibilityObserver (final BooleanValueChangedCallback callback)
 
void addClipLauncherSectionVisibilityObserver (final BooleanValueChangedCallback callback)
 
void addDeviceSectionVisibilityObserver (final BooleanValueChangedCallback callback)
 
void addCrossFadeSectionVisibilityObserver (final BooleanValueChangedCallback callback)
 
void toggleMeterSectionVisibility ()
 
void toggleIoSectionVisibility ()
 
void toggleSendsSectionVisibility ()
 
void toggleClipLauncherSectionVisibility ()
 
void toggleDeviceSectionVisibility ()
 
void toggleCrossFadeSectionVisibility ()
 

Detailed Description

An interface used to access various commands that can be performed on the Bitwig Studio mixer panel.

To get an instance of the mixer interface call ControllerHost#createMixer.

Since
API version 1

Member Function Documentation

◆ addClipLauncherSectionVisibilityObserver()

void addClipLauncherSectionVisibilityObserver ( final BooleanValueChangedCallback  callback)

Registers an observer that reports if the clip launcher section is visible (callback argument is true) in the mixer panel or not (callback argument is false).

Parameters
callbacka callback function that receives a single boolean parameter.
See also
isClipLauncherSectionVisible()
Deprecated:
call isClipLauncherSectionVisible().addValueObserver instead
Since
API version 1

◆ addCrossFadeSectionVisibilityObserver()

void addCrossFadeSectionVisibilityObserver ( final BooleanValueChangedCallback  callback)

Registers an observer that reports if the cross-fade section is visible (callback argument is true) in the mixer panel or not (callback argument is false).

Parameters
callbacka callback function that receives a single boolean parameter.
See also
isCrossFadeSectionVisible()
Deprecated:
call isCrossFadeSectionVisible().addValueObserver instead
Since
API version 1

◆ addDeviceSectionVisibilityObserver()

void addDeviceSectionVisibilityObserver ( final BooleanValueChangedCallback  callback)

Registers an observer that reports if the device section is visible (callback argument is true) in the mixer panel or not (callback argument is false).

Parameters
callbacka callback function that receives a single boolean parameter.
See also
isDeviceSectionVisible()
Deprecated:
call isDeviceSectionVisible().addValueObserver instead
Since
API version 1

◆ addIoSectionVisibilityObserver()

void addIoSectionVisibilityObserver ( final BooleanValueChangedCallback  callback)

Registers an observer that reports if the IO section is visible (callback argument is true) in the mixer panel or not (callback argument is false).

Parameters
callbacka callback function that receives a single boolean parameter.
See also
isIoSectionVisible()
Deprecated:
call isIoSectionVisible().addValueObserver instead
Since
API version 1

◆ addMeterSectionVisibilityObserver()

void addMeterSectionVisibilityObserver ( final BooleanValueChangedCallback  callback)

Registers an observer that reports if the meter section is visible (callback argument is true) in the mixer panel or not (callback argument is false).

Parameters
callbacka callback function that receives a single boolean parameter.
See also
isMeterSectionVisible()
Deprecated:
call isMeterSectionVisible().addValueObserver instead
Since
API version 1

◆ addSendsSectionVisibilityObserver()

void addSendsSectionVisibilityObserver ( final BooleanValueChangedCallback  callback)

Registers an observer that reports if the send control section is visible (callback argument is true) in the mixer panel or not (callback argument is false).

Parameters
callbacka callback function that receives a single boolean parameter.
See also
isSendSectionVisible()
Deprecated:
call isSendSectionVisible().addValueObserver instead
Since
API version 1

◆ isClipLauncherSectionVisible()

SettableBooleanValue isClipLauncherSectionVisible ( )

Gets an object that allows to show/hide the clip launcher section of the mixer panel. Observers can be registered on the returned object for receiving notifications when the clip launcher section switches between shown and hidden state.

Returns
a boolean value object that represents the clip launcher section visibility
Since
API version 1

◆ isCrossFadeSectionVisible()

SettableBooleanValue isCrossFadeSectionVisible ( )

Gets an object that allows to show/hide the cross-fade section of the mixer panel. Observers can be registered on the returned object for receiving notifications when the cross-fade section switches between shown and hidden state.

Returns
a boolean value object that represents the cross-fade section visibility
Since
API version 1

◆ isDeviceSectionVisible()

SettableBooleanValue isDeviceSectionVisible ( )

Gets an object that allows to show/hide the devices section of the mixer panel. Observers can be registered on the returned object for receiving notifications when the devices section switches between shown and hidden state.

Returns
a boolean value object that represents the devices section visibility
Since
API version 1

◆ isIoSectionVisible()

SettableBooleanValue isIoSectionVisible ( )

Gets an object that allows to show/hide the io section of the mixer panel. Observers can be registered on the returned object for receiving notifications when the io section switches between shown and hidden state.

Returns
a boolean value object that represents the io section visibility
Since
API version 1

◆ isMeterSectionVisible()

SettableBooleanValue isMeterSectionVisible ( )

Gets an object that allows to show/hide the meter section of the mixer panel. Observers can be registered on the returned object for receiving notifications when the meter section switches between shown and hidden state.

Returns
a boolean value object that represents the meter section visibility
Since
API version 1

◆ isSendSectionVisible()

SettableBooleanValue isSendSectionVisible ( )

Gets an object that allows to show/hide the sends section of the mixer panel. Observers can be registered on the returned object for receiving notifications when the sends section switches between shown and hidden state.

Returns
a boolean value object that represents the sends section visibility
Since
API version 1

◆ toggleClipLauncherSectionVisibility()

void toggleClipLauncherSectionVisibility ( )

Toggles the visibility of the clip launcher section in the mixer panel.

See also
isClipLauncherSectionVisible()
Deprecated:
call isClipLauncherSectionVisible().toggle() instead
Since
API version 1

◆ toggleCrossFadeSectionVisibility()

void toggleCrossFadeSectionVisibility ( )

Toggles the visibility of the cross-fade section in the mixer panel.

See also
isCrossFadeSectionVisible()
Deprecated:
call isCrossFadeSectionVisible().toggle() instead
Since
API version 1

◆ toggleDeviceSectionVisibility()

void toggleDeviceSectionVisibility ( )

Toggles the visibility of the device section in the mixer panel.

See also
isDeviceSectionVisible()
Deprecated:
call isDeviceSectionVisible().toggle() instead
Since
API version 1

◆ toggleIoSectionVisibility()

void toggleIoSectionVisibility ( )

Toggles the visibility of the IO section in the mixer panel.

See also
isIoSectionVisible()
Deprecated:
call isIoSectionVisible().toggle() instead
Since
API version 1

◆ toggleMeterSectionVisibility()

void toggleMeterSectionVisibility ( )

Toggles the visibility of the meter section in the mixer panel.

See also
isMeterSectionVisible()
Deprecated:
call isMeterSectionVisible().toggle() instead
Since
API version 1

◆ toggleSendsSectionVisibility()

void toggleSendsSectionVisibility ( )

Toggles the visibility of the send control section in the mixer panel.

See also
isSendSectionVisible()
Deprecated:
call isSendSectionVisible().toggle() instead
Since
API version 1

◆ zoomInTrackWidthsAllAction()

HardwareActionBindable zoomInTrackWidthsAllAction ( )

Zooms in all mixer tracks, if it the mixer is visible.

Since
API version 14

◆ zoomInTrackWidthsSelectedAction()

HardwareActionBindable zoomInTrackWidthsSelectedAction ( )

Zooms in selected mixer tracks, if it the mixer is visible.

Since
API version 14

◆ zoomOutTrackWidthsAllAction()

HardwareActionBindable zoomOutTrackWidthsAllAction ( )

Zooms out all mixer tracks, if it the mixer is visible.

Since
API version 14

◆ zoomOutTrackWidthsSelectedAction()

HardwareActionBindable zoomOutTrackWidthsSelectedAction ( )

Zooms out selected mixer tracks, if it the mixer is visible.

Since
API version 14

◆ zoomTrackWidthsAllStepper()

RelativeHardwarControlBindable zoomTrackWidthsAllStepper ( )

Same as zoomInTrackWidthsAllAction/zoomOutTrackWidthsAllAction, but as a stepper

Since
API version 14

◆ zoomTrackWidthsSelectedStepper()

RelativeHardwarControlBindable zoomTrackWidthsSelectedStepper ( )

Same as zoomInTrackWidthsSelectedAction/zoomOutTrackWidthsSelectedAction, but as a stepper

Since
API version 14

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