renoise.SampleEnvelopeModulationDevice

Constants
Properties
Functions
Local Structs
SampleEnvelopeModulationDevice.Point
- Properties

Constants

PlayMode

{
    PLAYMODE_POINTS: integer = 1,
    PLAYMODE_LINES: integer = 2,
    PLAYMODE_CURVES: integer = 3,
}

LoopMode

{
    LOOP_MODE_OFF: integer = 1,
    LOOP_MODE_FORWARD: integer = 2,
    LOOP_MODE_REVERSE: integer = 3,
    LOOP_MODE_PING_PONG: integer = 4,
}

MIN_NUMBER_OF_POINTS : `integer`

MAX_NUMBER_OF_POINTS : `integer`

Properties

name : `string`

READ-ONLY Fixed name of the device.

short_name : `string`

READ-ONLY

display_name : `string`

Configurable device display name.

display_name_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

enabled : `boolean`

enabled_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

is_active : `boolean`

not active = bypassed

is_active_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

is_maximized : `boolean`

Maximize state in modulation chain.

is_maximized_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

target : `renoise.SampleModulationDevice.TargetType`

READ-ONLY Where the modulation gets applied (Volume, Pan, Pitch, Cutoff, Resonance).

operator : `renoise.SampleModulationDevice.OperatorType`

Modulation operator: how the device applies.

operator_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

bipolar : `boolean`

Modulation polarity: when bipolar, the device applies it's values in a -1 to 1 range, when unipolar in a 0 to 1 range.

bipolar_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

tempo_sync_switching_allowed : `boolean`

READ-ONLY When true, the device has one of more time parameters, which can be switched to operate in synced or unsynced mode. see also field tempo_synced.

tempo_synced : `boolean`

When true and the device supports sync switching the device operates in wall-clock (ms) instead of beat times. see also property 'tempo_sync_switching_allowed'

tempo_synced_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

is_active_parameter : `renoise.DeviceParameter`

READ-ONLY Generic access to all parameters of this device.

parameters : `renoise.DeviceParameter`[]

READ-ONLY

external_editor_visible : `boolean`

External editor visibility. set to true to show the editor, false to close it

play_mode : `renoise.SampleEnvelopeModulationDevice.PlayMode`

Play mode (interpolation mode).

play_mode_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

length : `integer`

Range: (6 - 1000)

length_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

loop_mode : `renoise.SampleEnvelopeModulationDevice.LoopMode`

Loop.

loop_mode_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

loop_start : `integer`

Range: (1 - envelope.length)

loop_start_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

loop_end : `integer`

Range: (1 - envelope.length)

loop_end_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

sustain_enabled : `boolean`

Sustain.

sustain_enabled_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

sustain_position : `integer`

Range: (1 - envelope.length)

sustain_position_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

fade_amount : `integer`

Range: (0 - 4095)

fade_amount_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

points : `SampleEnvelopeModulationDevice.Point`[]

Get all points of the envelope. When setting a new list of points, items may be unsorted by time, but there may not be multiple points for the same time. Returns a copy of the list, so changing points[1].value will not do anything. Instead, change them via points = { something } instead.

points_observable : `renoise.Document.ObservableList`

Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists layout (items got added, removed, swapped).