Documents
Writing Docs Gigedit SFZ Instrument Scripts NKSP Language NKSP Reference

note_off()

Releases a note by passing the note's event ID to this function. This is almost like sending a MIDI note off event programmatically, however a call to this function will only release one single note instead, a call to this function does not cause a release event handler to be executed, nor will any MIDI specific note-off handling be done (i.e. it will have no effect on the status of built-in array variable %KEY_DOWN[]).

Function Prototype

note_off(event-id, [velocity])

Arguments

Argument Name Data Type Description
event-id Event ID Number or Event ID Array Note ID(s) of the note(s) to be released.
[required]
velocity Integer Number MIDI note off velocity value.
[optional, default: 127]

Return Value

None.

Examples

None yet.

See also

ignore_event(), play_note(), set_controller()

Availability

Since LinuxSampler 2.0.0

Passing an array of event IDs is only supported by NKSP. If you want to keep compatibility to KSP, then you should only pass a single event ID to this function. The second argument of this function velocity is only supported by NKSP. If you want to keep compatibility with KSP, then you should only pass one argument to this function.

Document Updated:  2017-05-30  |  Author:  Christian Schoenebeck