SampleHeader

The SampleHeader object contains all the meta data for a sample.

Table of Contents

• SampleHeader.name
• SampleHeader.start
• SampleHeader.end
• SampleHeader.startLoop
• SampleHeader.endLoop
• SampleHeader.sampleRate
• SampleHeader.originalPitch
• SampleHeader.pitchCorrection
• SampleHeader.link
• SampleHeader.type

SampleHeader.name

• <string> - The name of the sample.

This name should be unique.

SampleHeader.start

• <number> - The start of the sample data in the smpl chunk.

Note that the sample data in the Sample object is already the correct sample data.

SampleHeader.end

• <number> - The end of the sample data in the smpl chunk.

Note that the sample data in the Sample object is already the correct sample data.

SampleHeader.startLoop

• <number> - The index in sample data points, where the sample should start the loop.

The startLoop index is corrected by the start value.

SampleHeader.endLoop

• <number> - The index in sample data points, where the sample should end the loop.

The endLoop index is corrected by the start value.

SampleHeader.sampleRate

• <number> - The sample rate in hertz.

SampleHeader.originalPitch

• <number> - The MIDI key number of the recorded pitch of the sample.

This is a number between 0 and 127, or 255 if the sample is unpitched.

SampleHeader.pitchCorrection

• <number> - The pitch correction in cents that should be applied to the sample on playback.

This is to compensate for any pitch errors during the recording of the sample.

SampleHeader.link

• <number> - The sample header index of the associated left or right sample.

Both samples should be played at the same time, with the pitch being controlled by the right sample's generators.

SampleHeader.type

• <SampleType> - The type of the sample.