Class SfzSampler

Namespace

NAudio.Sampler

Assembly

NAudio.Sampler.dll

A polyphonic software sampler that plays an SFZ instrument, rendering 32-bit float stereo through the ISampleProvider pull model. Built on the shared SamplerEngine, so it gets the same voice engine as SoundFontSampler (pitch, looping, DAHDSR envelope, resonant filter, pan, voice stealing, exclusive groups, reverb/chorus sends).

An SFZ file is a single instrument (no banks/programs), so every channel plays the same region set. Regions whose sample is missing are dropped at load time. Note-on selection (keyswitches, round-robin, random layers, CC gating) and the Tier-1 opcode coverage are applied by the engine and NAudio.Sampler.SfzRegionProjector.

public sealed class SfzSampler : SamplerEngine, IMidiInstrument, ISampleProvider

Inheritance

object

SamplerEngine

SfzSampler

Implements

IMidiInstrument

ISampleProvider

Inherited Members

SamplerEngine.WaveFormat

SamplerEngine.Reverb

SamplerEngine.Chorus

SamplerEngine.MasterGain

SamplerEngine.ActiveVoiceCount

SamplerEngine.GetActivePlaybackPositions(double[])

SamplerEngine.ProcessMidiEvent(MidiEvent)

SamplerEngine.NoteOn(int, int, int)

SamplerEngine.NoteOff(int, int)

SamplerEngine.AllSoundOff()

SamplerEngine.AllNotesOff()

SamplerEngine.Read(Span<float>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

WaveExtensionMethods.FollowedBy(ISampleProvider, TimeSpan, ISampleProvider)

WaveExtensionMethods.Skip(ISampleProvider, TimeSpan)

WaveExtensionMethods.Take(ISampleProvider, TimeSpan)

WaveExtensionMethods.ToMono(ISampleProvider, float, float)

WaveExtensionMethods.ToStereo(ISampleProvider, float, float)

WaveExtensionMethods.ToWaveProvider(ISampleProvider)

WaveExtensionMethods.ToWaveProvider16(ISampleProvider)

Constructors

SfzSampler(SfzInstrument, ISfzSampleLoader, int, int)

Creates a sampler for a parsed SFZ instrument, loading its samples via loader.

public SfzSampler(SfzInstrument instrument, ISfzSampleLoader loader, int sampleRate = 44100, int maxVoices = 64)

Parameters

instrument SfzInstrument

loader ISfzSampleLoader

sampleRate int

maxVoices int

Properties

RegionCount

The number of playable regions loaded.

public int RegionCount { get; }

Property Value

int

Methods

FromFile(string, int, int)

Loads and parses an .sfz file and its samples, resolving relative paths against the file's directory.

public static SfzSampler FromFile(string path, int sampleRate = 44100, int maxVoices = 64)

Parameters

path string

sampleRate int

maxVoices int

Returns

SfzSampler