Interface ClipSetProperties

ClipSetProperties

interface ClipSetProperties {
    color: number;
    color_index: number;
    end_marker: number;
    gain: number;
    is_playing: boolean;
    launch_mode: LaunchMode;
    launch_quantization: LaunchQuantization;
    legato: boolean;
    loop_end: number;
    loop_start: number;
    looping: boolean;
    muted: boolean;
    name: string;
    pitch_coarse: number;
    pitch_fine: number;
    position: number;
    ram_mode: boolean;
    signature_denominator: number;
    signature_numerator: number;
    start_marker: number;
    velocity_amount: number;
    warp_mode: WarpMode;
    warping: boolean;
}

Properties

color: number

The RGB value of the scene's color in the form 0x00rrggbb or (2^16 * red) + (2^8) * green + blue, where red, green and blue are values from 0 (dark) to 255 (light).
When setting the RGB value, the nearest color from the Scene color chooser is taken.

color_index: number

The color index of the scene.

end_marker: number

The end marker of the clip in beats, independent of the loop state. Cannot be set before the start marker.

gain: number

The gain of the clip (range is 0.0 to 1.0)

is_playing: boolean

true = clip is playing or recording.

launch_mode: LaunchMode

The end marker of the clip in beats, independent of the loop state. Cannot be set before the start marker.

launch_quantization: LaunchQuantization

The end marker of the clip in beats, independent of the loop state. Cannot be set before the start marker.

legato: boolean

true = Legato Mode switch in the Clip's Launch settings is on.

loop_end: number

For looped clips: loop end. For unlooped clips: clip end.

loop_start: number

For looped clips: loop start.
For unlooped clips: clip start.

loop_start and loop_end are in absolute clip beat time if clip is MIDI or warped. The 1.1.1 position has beat time 0. If the clip is unwarped audio, they are given in seconds, 0 is the time of the first sample in the audio material.

looping: boolean

true = clip is looped. Unwarped audio cannot be looped.

muted: boolean

true = muted (i.e. the Clip Activator button of the clip is off).

name: string
pitch_coarse: number

Pitch shift in semitones ("Transpose"), -48 ... 48. Available for audio clips only.

pitch_fine: number

Extra pitch shift in cents ("Detune"), -50 ... 49. Available for audio clips only.

position: number

Get and set the clip's loop position. The value will always equal loop_start, however setting this property, unlike setting loop_start, preserves the loop length.

ram_mode: boolean

true1 = an audio clip’s RAM switch is enabled.

signature_denominator: number

Inherit Doc: ClipGetProperties.signature_denominator

signature_numerator: number

Inherit Doc: ClipGetProperties.signature_numerator

start_marker: number

The start marker of the clip in beats, independent of the loop state. Cannot be set behind the end marker.

velocity_amount: number

How much the velocity of the note that triggers the clip affects its volume, 0 = no effect, 1 = full effect.

warp_mode: WarpMode

Inherit Doc: ClipGetProperties.warp_mode

warping: boolean

true = Warp switch is on.