renoise.Sample

Constants
Properties
Functions

Constants

BeatSyncMode

{
    BEAT_SYNC_REPITCH: integer = 1,
    BEAT_SYNC_PERCUSSION: integer = 2,
    BEAT_SYNC_TEXTURE: integer = 3,
}

InterpolationMode

{
    INTERPOLATE_NONE: integer = 1,
    INTERPOLATE_LINEAR: integer = 2,
    INTERPOLATE_CUBIC: integer = 3,
    INTERPOLATE_SINC: integer = 4,
}

LoopMode

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

NewNoteActionMode

{
    NEW_NOTE_ACTION_NOTE_CUT: integer = 1,
    NEW_NOTE_ACTION_NOTE_OFF: integer = 2,
    NEW_NOTE_ACTION_SUSTAIN: integer = 3,
}

Properties

autofade : `boolean`

autofade_observable : `renoise.Document.Observable`

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

autoseek : `boolean`

autoseek_observable : `renoise.Document.Observable`

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

beat_sync_enabled : `boolean`

Beat sync.

beat_sync_enabled_observable : `renoise.Document.Observable`

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

beat_sync_lines : `integer`

Range: (1 - 512)

beat_sync_lines_observable : `renoise.Document.Observable`

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

beat_sync_mode : `renoise.Sample.BeatSyncMode`

beat_sync_mode_observable : `renoise.Document.Observable`

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

device_chain_index : `integer`

The linked instrument device chain. 0 when disable, else a valid index for the renoise.Instrument.sample_device_chain table

device_chain_index_observable : `renoise.Document.Observable`

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

fine_tune : `integer`

Range: (-127 - 127)

fine_tune_observable : `renoise.Document.Observable`

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

interpolation_mode : `renoise.Sample.InterpolationMode`

Interpolation, new note action, oneshot, mute_group, autoseek, autofade.

interpolation_mode_observable : `renoise.Document.Observable`

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

is_slice_alias : `boolean`

READ-ONLY True, when the sample slot is an alias to a sliced master sample. Such sample slots are read-only and automatically managed with the master samples slice list.

loop_end : `integer`

Range: (1 - num_sample_frames)

loop_end_observable : `renoise.Document.Observable`

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

loop_mode : `renoise.Sample.LoopMode`

Loops.

loop_mode_observable : `renoise.Document.Observable`

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

loop_release : `boolean`

loop_release_observable : `renoise.Document.Observable`

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

loop_start : `integer`

Range: (1 - num_sample_frames)

loop_start_observable : `renoise.Document.Observable`

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

modulation_set_index : `integer`

The linked modulation set. 0 when disable, else a valid index for the renoise.Instrument.sample_modulation_sets table

modulation_set_index_observable : `renoise.Document.Observable`

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

mute_group : `integer`

Range: (0 - 15) where 0 means no group

mute_group_observable : `renoise.Document.Observable`

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

name : `string`

Name.

name_observable : `renoise.Document.Observable`

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

new_note_action : `renoise.Sample.NewNoteActionMode`

new_note_action_observable : `renoise.Document.Observable`

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

oneshot : `boolean`

oneshot_observable : `renoise.Document.Observable`

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

oversample_enabled : `boolean`

oversample_enabled_observable : `renoise.Document.Observable`

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

panning : `number`

Range: (0.0 - 1.0)

panning_observable : `renoise.Document.Observable`

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

sample_buffer : `renoise.SampleBuffer`

READ-ONLY

sample_buffer_observable : `renoise.Document.Observable`

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

sample_mapping : `renoise.SampleMapping`

READ-ONLY Keyboard Note/velocity mapping

slice_markers : `integer`[]

Read/write access to the slice marker list of a sample. When new markers are set or existing ones unset, existing 0S effects or notes to existing slices will NOT be remapped (unlike its done with the insert/remove/move_slice_marker functions). See function insert_slice_marker for info about marker limitations and preconditions.

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

transpose : `integer`

Range: (-120 - 120)

transpose_observable : `renoise.Document.Observable`

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

volume : `number`

Range: (0.0 - 4.0)

volume_observable : `renoise.Document.Observable`

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

Functions

clear(self)

Reset, clear all sample settings and sample data.

copy_from(self, sample : `renoise.Sample`)

Copy all settings, including sample data from another sample.

delete_slice_marker(self, marker_sample_pos : `integer`)

Delete an existing slice marker. marker_sample_pos must point to an existing marker. See also property 'samples[].slice_markers'. Existing 0S effects or notes will be updated to ensure that the old slices are played back just as before.

insert_slice_marker(self, marker_sample_pos : `integer`)

Insert a new slice marker at the given sample position. Only samples in the first sample slot may use slices. Creating slices will automatically create sample aliases in the following slots: read-only sample slots that play the sample slice and are mapped to notes. Sliced sample lists can not be modified manually then. To update such aliases, modify the slice marker list instead. Existing 0S effects or notes will be updated to ensure that the old slices are played back just as before.

move_slice_marker(self, old_marker_pos : `integer`, new_marker_pos : `integer`)

Change the sample position of an existing slice marker. see also property 'samples[].slice_markers'. When moving a marker behind or before an existing other marker, existing 0S effects or notes will automatically be updated to ensure that the old slices are played back just as before.

Renoise Scripting

slice_markers : integer[]

clear(self)

copy_from(self, sample : renoise.Sample)

delete_slice_marker(self, marker_sample_pos : integer)

insert_slice_marker(self, marker_sample_pos : integer)

move_slice_marker(self, old_marker_pos : integer, new_marker_pos : integer)

slice_markers : `integer`[]

copy_from(self, sample : `renoise.Sample`)

delete_slice_marker(self, marker_sample_pos : `integer`)

insert_slice_marker(self, marker_sample_pos : `integer`)

move_slice_marker(self, old_marker_pos : `integer`, new_marker_pos : `integer`)