Documents
Writing Docs Gigedit SFZ Instrument Scripts NKSP Language NKSP Reference

sample Opcode

This is the most fundamental opcode of the SFZ file format. It allows you to load and assign a certain audio sample file. A variety of audio file formats are supported.

Opcode Prototype

sample=path

Parameter

The mandatory path parameter usually defines the file system path of the sample file that shall be loaded and assigned, which may either be an absolute path or a relative path. A relative path is always interpreted relative to the sfz file's location.

Alternatively built-in samples may be used, which can be distinguished from regular samples by a star character as first character. Built-in samples are not covered by the standard, but are common among several sfz players.

Built-in Sample Name Description Availability
*silence Don't play any sound. Since LinuxSampler 2.1.0.svn7

Allowed Sections

May be used in sections <global>, <region>, ... TODO.

Examples

Loads the WAV file "organ_c3.wav" from the subdirectory "mysamples" and assigns it to the entire key range of the instrument.

Availability

Since LinuxSampler 2.0.0

Conforms to SFZ v1 Standard.

Document Updated:  2019-03-10  |  Author:  Christian Schoenebeck