Inheritance diagram for Clip:

Public Member Functions
void	scrollToKey (int key)

void	scrollKeysPageUp ()

void	scrollKeysPageDown ()

void	scrollKeysStepUp ()

void	scrollKeysStepDown ()

void	scrollToStep (int step)

void	scrollStepsPageForward ()

void	scrollStepsPageBackwards ()

void	scrollStepsStepForward ()

void	scrollStepsStepBackwards ()

BooleanValue	canScrollKeysUp ()

void	addCanScrollKeysUpObserver (BooleanValueChangedCallback callback)

BooleanValue	canScrollKeysDown ()

void	addCanScrollKeysDownObserver (BooleanValueChangedCallback callback)

BooleanValue	canScrollStepsBackwards ()

void	addCanScrollStepsBackwardsObserver (BooleanValueChangedCallback callback)

BooleanValue	canScrollStepsForwards ()

void	addCanScrollStepsForwardObserver (BooleanValueChangedCallback callback)

void	toggleStep (int x, int y, int insertVelocity)

void	toggleStep (int channel, int x, int y, int insertVelocity)

void	setStep (int x, int y, int insertVelocity, double insertDuration)

void	setStep (int channel, int x, int y, int insertVelocity, double insertDuration)

void	clearStep (int x, int y)

void	clearStep (int channel, int x, int y)

void	clearStepsAtX (final int channel, int x)

void	clearSteps (int y)

void	clearStepsAtY (int channel, int y)

void	clearSteps ()

void	selectStepContents (int x, int y, boolean clearCurrentSelection)

void	selectStepContents (int channel, int x, int y, boolean clearCurrentSelection)

void	setStepSize (double lengthInBeatTime)

void	addStepDataObserver (StepDataChangedCallback callback)

void	addNoteStepObserver (NoteStepChangedCallback callback)

IntegerValue	playingStep ()

void	addPlayingStepObserver (IntegerValueChangedCallback callback)

void	setName (String name)

SettableBooleanValue	getShuffle ()

SettableRangedValue	getAccent ()

SettableBeatTimeValue	getPlayStart ()

SettableBeatTimeValue	getPlayStop ()

SettableBooleanValue	isLoopEnabled ()

SettableBeatTimeValue	getLoopStart ()

SettableBeatTimeValue	getLoopLength ()

void	addColorObserver (ColorValueChangedCallback callback)

SettableColorValue	color ()

void	duplicate ()

void	duplicateContent ()

void	transpose (int semitones)

void	quantize (double amount)

Track	getTrack ()

SettableEnumValue	launchQuantization ()

SettableBooleanValue	useLoopStartAsQuantizationReference ()

SettableBooleanValue	launchLegato ()

SettableEnumValue	launchMode ()

NoteStep	getStep (final int channel, int x, int y)

void	launch ()

ClipLauncherSlot	clipLauncherSlot ()

Public Member Functions inherited from ObjectProxy
BooleanValue	exists ()

BooleanValue	createEqualsValue (ObjectProxy other)

Public Member Functions inherited from Subscribable
boolean	isSubscribed ()

void	setIsSubscribed (boolean value)

void	subscribe ()

void	unsubscribe ()

Detailed Description

An interface that provides access to the contents of a clip in Bitwig Studio.

The note content of the clip is exposed in terms of steps and keys, mainly targeted to x-y-grid applications such as step sequencers.

Since: API version 1

Definition at line 20 of file Clip.java.

Member Function Documentation

◆ addCanScrollKeysDownObserver()

void addCanScrollKeysDownObserver ( BooleanValueChangedCallback callback )

Registers an observer that reports if the note grid keys can be scrolled further down.

Parameters

callback a callback function that receives a single boolean parameter.

Since: API version 1

Deprecated:: Use canScrollKeysDown() instead.

◆ addCanScrollKeysUpObserver()

void addCanScrollKeysUpObserver ( BooleanValueChangedCallback callback )

Registers an observer that reports if the note grid keys can be scrolled further up.

Parameters

callback a callback function that receives a single boolean parameter.

Since: API version 1

Deprecated:: Use canScrollKeysUp() instead.

◆ addCanScrollStepsBackwardsObserver()

void addCanScrollStepsBackwardsObserver ( BooleanValueChangedCallback callback )

Registers an observer that reports if the note grid steps can be scrolled backwards.

Parameters

callback a callback function that receives a single boolean parameter.

Since: API version 1

Deprecated:: Use canScrollStepsBackwards() instead.

◆ addCanScrollStepsForwardObserver()

void addCanScrollStepsForwardObserver ( BooleanValueChangedCallback callback )

Registers an observer that reports if the note grid keys can be scrolled forward.

Parameters

callback a callback function that receives a single boolean parameter.

Since: API version 1

Deprecated:: Use canScrollStepsForwards() instead.

◆ addColorObserver()

void addColorObserver ( ColorValueChangedCallback callback )

Registers an observer that reports the clip color.

Parameters

callback a callback function that receives three parameters: 1. the red coordinate of the RBG color value, 2. the green coordinate of the RBG color value, and 3. the blue coordinate of the RBG color value

Since: API version 1

Deprecated:: use color() instead.

◆ addNoteStepObserver()

void addNoteStepObserver ( NoteStepChangedCallback callback )

Registers an observer that reports which note grid steps/keys contain notes.

Parameters

callback A callback function that receives the StepInfo.

Since: API version 10

◆ addPlayingStepObserver()

void addPlayingStepObserver ( IntegerValueChangedCallback callback )

Registers an observer that reports note grid cells as they get played by the sequencer.

Parameters

callback A callback function that receives a single integer parameter, which reflects the step coordinate that is played, or -1 if no step is associated with the current playback position.

Since: API version 1

Deprecated:: Use playingStep() instead.

◆ addStepDataObserver()

void addStepDataObserver ( StepDataChangedCallback callback )

Registers an observer that reports which note grid steps/keys contain notes.

Parameters

callback A callback function that receives three parameters: 1. the x (step) coordinate within the note grid (integer), 2. the y (key) coordinate within the note grid (integer), and 3. an integer value that indicates if the step is empty (0) or if a note continues playing (1) or starts playing (2).

Since: API version 1

See also: addNoteStepObserver(NoteStepChangedCallback) which will provide more details.

◆ canScrollKeysDown()

BooleanValue canScrollKeysDown ( )

Value that reports if the note grid keys can be scrolled further down.

Since: API version 2

◆ canScrollKeysUp()

BooleanValue canScrollKeysUp ( )

Value that reports if the note grid keys can be scrolled further up.

Since: API version 2

◆ canScrollStepsBackwards()

BooleanValue canScrollStepsBackwards ( )

Value that reports if the note grid if the note grid steps can be scrolled backwards.

Since: API version 2

◆ canScrollStepsForwards()

BooleanValue canScrollStepsForwards ( )

Value that reports if the note grid if the note grid steps can be scrolled forwards.

Since: API version 2

◆ clearStep() [1/2]

void clearStep	(	int	x,
		int	y
	)

See also: clearStep(int, int, int)

Since: API version 1

◆ clearStep() [2/2]

void clearStep	(	int	channel,
		int	x,
		int	y
	)

Removes the note in the grid cell specified by the given x and y arguments. Calling this method does nothing in case no note exists at the given x-y-coordinates.

Parameters

channel	MIDI channel, from 0 to 15.
x	the x position within the note grid, defining the step/time of the target note
y	the y position within the note grid, defining the key of the target note

Since: API version 10

◆ clearSteps() [1/2]

void clearSteps ( int y )

See also: clearStepsAtY(int, int) channel will be 0.

Since: API version 1

Deprecated:: Use clearStepsAtY(int, int) instead.

◆ clearSteps() [2/2]

void clearSteps ( )

Removes all notes in the grid.

Since: API version 1

◆ clearStepsAtX()

void clearStepsAtX	(	final int	channel,
		int	x
	)

Removes all notes in the grid started on the step x.

Since: API version 10

◆ clearStepsAtY()

void clearStepsAtY	(	int	channel,
		int	y
	)

Removes all notes in the grid row specified by the given y argument.

Parameters

channel	MIDI channel, from 0 to 15.
y	the y position within the note grid, defining the key of the target note

Since: API version 10

◆ clipLauncherSlot()

ClipLauncherSlot clipLauncherSlot ( )

Get the clip launcher slot containing the clip.

Since: API version 10

◆ color()

SettableColorValue color ( )

Get the color of the clip.

Since: API version 2

◆ duplicate()

void duplicate ( )

Duplicates the clip.

Since: API version 1

◆ duplicateContent()

void duplicateContent ( )

Duplicates the content of the clip.

Since: API version 1

◆ getAccent()

SettableRangedValue getAccent ( )

Returns accent setting of the clip.

Returns: the ranged value object that represents the clips accent setting.

Since: API version 1

◆ getLoopLength()

SettableBeatTimeValue getLoopLength ( )

Returns the loop length of the clip in beat time.

Returns: the beat time object that represents the clips loop length.

Since: API version 1

◆ getLoopStart()

SettableBeatTimeValue getLoopStart ( )

Returns the loop start time of the clip in beat time.

Returns: the beat time object that represents the clips loop start time.

Since: API version 1

◆ getPlayStart()

SettableBeatTimeValue getPlayStart ( )

Returns the start of the clip in beat time.

Returns: the beat time object that represents the clips start time.

Since: API version 1

◆ getPlayStop()

SettableBeatTimeValue getPlayStop ( )

Returns the length of the clip in beat time.

Returns: the beat time object that represents the duration of the clip.

Since: API version 1

◆ getShuffle()

SettableBooleanValue getShuffle ( )

Returns shuffle settings of the clip.

Returns: the value object that represents the clips shuffle setting.

Since: API version 1

◆ getStep()

NoteStep getStep	(	final int	channel,
		int	x,
		int	y
	)

Get step info

Since: API version 10

◆ getTrack()

Track getTrack ( )

Gets the track that contains the clip.

Returns: a track object that represents the track which contains the clip.

Since: API version 1

◆ isLoopEnabled()

SettableBooleanValue isLoopEnabled ( )

Returns an object that provides access to the loop enabled state of the clip.

Returns: a boolean value object.

Since: API version 1

◆ launch()

void launch ( )

Launches the clip.

Since: API version 10

◆ launchLegato()

SettableBooleanValue launchLegato ( )

Setting "Legato" from the inspector.

Since: API version 8

Deprecated:: Use launchMode() instead.

◆ launchMode()

SettableEnumValue launchMode ( )

Setting "Launch Mode" from the inspector. Possible values are:

play_with_quantization
continue_immediately
continue_with_quantization

Since: API version 9

◆ launchQuantization()

SettableEnumValue launchQuantization ( )

Setting for the default launch quantization.

Possible values are "default", "none", "8", "4", "2", "1", "1/2", "1/4", "1/8", "1/16".

Since: API version 8

◆ playingStep()

IntegerValue playingStep ( )

Value that reports note grid cells as they get played by the sequencer.

Since: API version 2

◆ quantize()

void quantize ( double amount )

Quantize the start time of all notes in the clip according to the given amount. The note lengths remain the same as before.

Parameters

amount a factor between 0 and 1 that allows to morph between the original note start and the quantized note start.

Since: API version 1

◆ scrollKeysPageDown()

void scrollKeysPageDown ( )

Scrolls the note grid keys one page down. For example if the note grid is configured to show 12 keys and is currently showing keys [36..47], calling this method would scroll the note grid to key range [48..59].

Since: API version 1

◆ scrollKeysPageUp()

void scrollKeysPageUp ( )

Scrolls the note grid keys one page up. For example if the note grid is configured to show 12 keys and is currently showing keys [36..47], calling this method would scroll the note grid to key range [48..59].

Since: API version 1

◆ scrollKeysStepDown()

void scrollKeysStepDown ( )

Scrolls the note grid keys one key down. For example if the note grid is configured to show 12 keys and is currently showing keys [36..47], calling this method would scroll the note grid to key range [35..46].

Since: API version 1

◆ scrollKeysStepUp()

void scrollKeysStepUp ( )

Scrolls the note grid keys one key up. For example if the note grid is configured to show 12 keys and is currently showing keys [36..47], calling this method would scroll the note grid to key range [37..48].

Since: API version 1

◆ scrollStepsPageBackwards()

void scrollStepsPageBackwards ( )

Scrolls the note grid steps one page backwards. For example if the note grid is configured to show 16 steps and is currently showing keys [16..31], calling this method would scroll the note grid to key range [0..16].

Since: API version 1

◆ scrollStepsPageForward()

void scrollStepsPageForward ( )

Scrolls the note grid steps one page forward. For example if the note grid is configured to show 16 steps and is currently showing keys [0..15], calling this method would scroll the note grid to key range [16..31].

Since: API version 1

◆ scrollStepsStepBackwards()

void scrollStepsStepBackwards ( )

Scrolls the note grid steps one step backwards. For example if the note grid is configured to show 16 steps and is currently showing keys [1..16], calling this method would scroll the note grid to key range [0..15].

Since: API version 1

◆ scrollStepsStepForward()

void scrollStepsStepForward ( )

Scrolls the note grid steps one step forward. For example if the note grid is configured to show 16 steps and is currently showing keys [0..15], calling this method would scroll the note grid to key range [1..16].

Since: API version 1

◆ scrollToKey()

void scrollToKey ( int key )

Scroll the note grid so that the given key becomes the key with y position of 0.

Note: This can cause some parts of the grid to represent invalid keys as there is no clipping

Parameters

key	the key that should be the new key with a y position of 0. This must be a value in the range 0...127.

Since: API version 1

◆ scrollToStep()

void scrollToStep ( int step )

Scroll the note grid so that the given step becomes visible.

Parameters

step	the step that should become visible

Since: API version 1

◆ selectStepContents() [1/2]

void selectStepContents	(	int	x,
		int	y,
		boolean	clearCurrentSelection
	)

See also: selectStepContents(int, int, int, boolean) channel will be 0.

Since: API version 1

◆ selectStepContents() [2/2]

void selectStepContents	(	int	channel,
		int	x,
		int	y,
		boolean	clearCurrentSelection
	)

Selects the note in the grid cell specified by the given x and y arguments, in case there actually is a note at the given x-y-coordinates.

Parameters

channel	MIDI channel, from 0 to 15.
x	the x position within the note grid, defining the step/time of the target note
y	the y position within the note grid, defining the key of the target note
clearCurrentSelection	`true` if the existing selection should be cleared, {} if the note should be added to the current selection.

Since: API version 10

◆ setName()

void setName ( String name )

Updates the name of the clip.

Parameters

name	the new clip name

Since: API version 1

◆ setStep() [1/2]

void setStep	(	int	x,
		int	y,
		int	insertVelocity,
		double	insertDuration
	)

See also: setStep(int, int, int, int, double) channel will be 0.

Since: API version 1

◆ setStep() [2/2]

void setStep	(	int	channel,
		int	x,
		int	y,
		int	insertVelocity,
		double	insertDuration
	)

Creates a note in the grid cell specified by the given x and y arguments. Existing notes are overwritten.

Parameters

x	the x position within the note grid, defining the step/time of the new note
y	the y position within the note grid, defining the key of the new note
insertVelocity	the velocity of the new note
insertDuration	the duration of the new note

Since: API version 1

◆ setStepSize()

void setStepSize ( double lengthInBeatTime )

Sets the beat time duration that is represented by one note grid step.

Parameters

lengthInBeatTime the length of one note grid step in beat time.

Since: API version 1

◆ toggleStep() [1/2]

void toggleStep	(	int	x,
		int	y,
		int	insertVelocity
	)

See also: toggleStep(int, int, int, int) channel will be 0.

Since: API version 1

◆ toggleStep() [2/2]

void toggleStep	(	int	channel,
		int	x,
		int	y,
		int	insertVelocity
	)

Toggles the existence of a note in the note grid cell specified by the given x and y arguments.

Parameters

channel	the MIDI channel, between 0 and 15.
x	the x position within the note grid, defining the step/time of the target note
y	the y position within the note grid, defining the key of the target note
insertVelocity	the velocity of the target note in case a new note gets inserted

Since: API version 10

◆ transpose()

void transpose ( int semitones )

Transposes all notes in the clip by the given number of semitones.

Parameters

semitones the amount of semitones to transpose, can be a positive or negative integer value.

Since: API version 1

◆ useLoopStartAsQuantizationReference()

SettableBooleanValue useLoopStartAsQuantizationReference ( )

Setting "Q to loop" in the inspector.

Since: API version 8

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

Clip.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ addCanScrollKeysDownObserver()

◆ addCanScrollKeysUpObserver()

◆ addCanScrollStepsBackwardsObserver()

◆ addCanScrollStepsForwardObserver()

◆ addColorObserver()

◆ addNoteStepObserver()

◆ addPlayingStepObserver()

◆ addStepDataObserver()

◆ canScrollKeysDown()

◆ canScrollKeysUp()

◆ canScrollStepsBackwards()

◆ canScrollStepsForwards()

◆ clearStep() [1/2]

◆ clearStep() [2/2]

◆ clearSteps() [1/2]

◆ clearSteps() [2/2]

◆ clearStepsAtX()

◆ clearStepsAtY()

◆ clipLauncherSlot()

◆ color()

◆ duplicate()

◆ duplicateContent()

◆ getAccent()

◆ getLoopLength()

◆ getLoopStart()

◆ getPlayStart()

◆ getPlayStop()

◆ getShuffle()

◆ getStep()

◆ getTrack()

◆ isLoopEnabled()

◆ launch()

◆ launchLegato()

◆ launchMode()

◆ launchQuantization()

◆ playingStep()

◆ quantize()

◆ scrollKeysPageDown()

◆ scrollKeysPageUp()

◆ scrollKeysStepDown()

◆ scrollKeysStepUp()

◆ scrollStepsPageBackwards()

◆ scrollStepsPageForward()

◆ scrollStepsStepBackwards()

◆ scrollStepsStepForward()

◆ scrollToKey()

◆ scrollToStep()

◆ selectStepContents() [1/2]

◆ selectStepContents() [2/2]

◆ setName()

◆ setStep() [1/2]

◆ setStep() [2/2]

◆ setStepSize()

◆ toggleStep() [1/2]

◆ toggleStep() [2/2]

◆ transpose()

◆ useLoopStartAsQuantizationReference()