renoise.SampleModulationSet

Properties

name : string

Name of the modulation set.

name_observable : renoise.Document.Observable

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

volume_input : renoise.DeviceParameter

Input value for the volume domain

panning_input : renoise.DeviceParameter

Input value for the panning domain

pitch_input : renoise.DeviceParameter

Input value for the pitch domain

cutoff_input : renoise.DeviceParameter

Input value for the cutoff domain

resonance_input : renoise.DeviceParameter

Input value for the resonance domain

drive_input : renoise.DeviceParameter

Input value for the drive domain

pitch_range : integer

Range: (1 - 96)

pitch_range_observable : renoise.Document.Observable

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

available_devices : string[]

READ-ONLY All available devices, to be used in 'insert_device_at'.

devices : renoise.SampleModulationDevice[]

READ-ONLY Device list access.

devices_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).

filter_version : 1 | 2 | 3

READ-ONLY Filter version, 3 is the latest.

filter_version_observable : renoise.Document.Observable

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

available_filter_types : FilterTypes[]

READ-ONLY List of available filter types depending on the filter_version.

filter_type : FilterTypes

The type of the filter selected for the modulation set. Songs made with previous versions of Renoise may use old filter types.

filter_type_observable : renoise.Document.Observable

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

Functions

init(self)

Reset all chain back to default initial state. Removing all devices too.

copy_from(self, other_set : renoise.SampleModulationSet)

Copy all devices from another SampleModulationSet object.

insert_device_at(self, device_path : string, target_type : renoise.SampleModulationDevice.TargetType, index : integer)

->new_sample_modulation_device : renoise.SampleModulationDevice

Insert a new device at the given position. "device_path" must be one of renoise.song().instruments[].sample_modulation_sets[].available_devices.

delete_device_at(self, index : integer)

Delete a device at the given index.

device(self, index : integer)

->renoise.SampleModulationDevice

Access a single device by index.

upgrade_filter_version(self)

Upgrade filter to the latest version. Tries to find a somewhat matching filter in the new version, but things quite likely won't sound the same.

Local Aliases

FilterTypes

FilterTypes1 | FilterTypes2 | FilterTypes3

-- Available filter types when filter_version = 3
-- Available filter types when filter_version = 3
-- Available filter types when filter_version = 2
-- Available filter types when filter_version = 1
FilterTypes:
    | "None"
    | "LP Clean"
    | "LP K35"
    | "LP Moog"
    | "LP Diode"
    | "HP Clean"
    | "HP K35"
    | "HP Moog"
    | "BP Clean"
    | "BP K35"
    | "BP Moog"
    | "BandPass"
    | "BandStop"
    | "Vowel"
    | "Comb"
    | "Decimator"
    | "Dist Shape"
    | "Dist Fold"
    | "AM Sine"
    | "AM Triangle"
    | "AM Saw"
    | "AM Pulse"
    | "None"
    | "LP 2x2 Pole"
    | "LP 2 Pole"
    | "LP Biquad"
    | "LP Moog"
    | "LP Single"
    | "HP 2x2 Pole"
    | "HP 2 Pole"
    | "HP Moog"
    | "Band Reject"
    | "Band Pass"
    | "EQ -15 dB"
    | "EQ -6 dB"
    | "EQ +6 dB"
    | "EQ +15 dB"
    | "EQ Peaking"
    | "Dist. Low"
    | "Dist. Mid"
    | "Dist. High"
    | "Dist."
    | "RingMod"
    | "None"
    | "LP -12 dB"
    | "LP -24 dB"
    | "LP -48 dB"
    | "Moog LP"
    | "Single Pole"
    | "HP -12 dB"
    | "HP -24 dB"
    | "Moog HP"
    | "Band Reject"
    | "Band Pass"
    | "EQ -15 dB"
    | "EQ -6 dB"
    | "EQ +6 dB"
    | "EQ +15 dB"
    | "Peaking EQ"
    | "Dist. Low"
    | "Dist. Mid"
    | "Dist. High"
    | "Dist."
    | "AMod"

FilterTypes1

"AMod" | "Band Pass" | "Band Reject" | "Dist. High" | "Dist. Low" | "Dist. Mid" | "Dist." | "EQ +15 dB" | "EQ +6 dB" | "EQ -15 dB" | "EQ -6 dB" | "HP -12 dB" | "HP -24 dB" | "LP -12 dB" | "LP -24 dB" | "LP -48 dB" | "Moog HP" | "Moog LP" | "None" | "Peaking EQ" | "Single Pole"

-- Available filter types when filter_version = 1
FilterTypes1:
    | "None"
    | "LP -12 dB"
    | "LP -24 dB"
    | "LP -48 dB"
    | "Moog LP"
    | "Single Pole"
    | "HP -12 dB"
    | "HP -24 dB"
    | "Moog HP"
    | "Band Reject"
    | "Band Pass"
    | "EQ -15 dB"
    | "EQ -6 dB"
    | "EQ +6 dB"
    | "EQ +15 dB"
    | "Peaking EQ"
    | "Dist. Low"
    | "Dist. Mid"
    | "Dist. High"
    | "Dist."
    | "AMod"

FilterTypes2

"Band Pass" | "Band Reject" | "Dist. High" | "Dist. Low" | "Dist. Mid" | "Dist." | "EQ +15 dB" | "EQ +6 dB" | "EQ -15 dB" | "EQ -6 dB" | "EQ Peaking" | "HP 2 Pole" | "HP 2x2 Pole" | "HP Moog" | "LP 2 Pole" | "LP 2x2 Pole" | "LP Biquad" | "LP Moog" | "LP Single" | "None" | "RingMod"

-- Available filter types when filter_version = 2
FilterTypes2:
    | "None"
    | "LP 2x2 Pole"
    | "LP 2 Pole"
    | "LP Biquad"
    | "LP Moog"
    | "LP Single"
    | "HP 2x2 Pole"
    | "HP 2 Pole"
    | "HP Moog"
    | "Band Reject"
    | "Band Pass"
    | "EQ -15 dB"
    | "EQ -6 dB"
    | "EQ +6 dB"
    | "EQ +15 dB"
    | "EQ Peaking"
    | "Dist. Low"
    | "Dist. Mid"
    | "Dist. High"
    | "Dist."
    | "RingMod"

FilterTypes3

"AM Pulse" | "AM Saw" | "AM Sine" | "AM Triangle" | "BP Clean" | "BP K35" | "BP Moog" | "BandPass" | "BandStop" | "Comb" | "Decimator" | "Dist Fold" | "Dist Shape" | "HP Clean" | "HP K35" | "HP Moog" | "LP Clean" | "LP Diode" | "LP K35" | "LP Moog" | "None" | "Vowel"

-- Available filter types when filter_version = 3
FilterTypes3:
    | "None"
    | "LP Clean"
    | "LP K35"
    | "LP Moog"
    | "LP Diode"
    | "HP Clean"
    | "HP K35"
    | "HP Moog"
    | "BP Clean"
    | "BP K35"
    | "BP Moog"
    | "BandPass"
    | "BandStop"
    | "Vowel"
    | "Comb"
    | "Decimator"
    | "Dist Shape"
    | "Dist Fold"
    | "AM Sine"
    | "AM Triangle"
    | "AM Saw"
    | "AM Pulse"