Package com.io7m.jnoisetype.api

Interface NTSampleDescriptionType

All Superinterfaces:
NTNamedType
All Known Implementing Classes:
NTSampleDescription
@Immutable public interface NTSampleDescriptionType extends NTNamedType
Data that describes a sample.

  • Method Details

    • name

      NTSampleName name()
      Returns:
      The name of the sample

    • nameText

      default String nameText()
      Specified by:
      nameText in interface NTNamedType
      Returns:
      The name of the element as a raw string

    • linked

      default NTSampleIndex linked()
      Returns:
      The sample to which this sample is linked
      See Also:
      • "SoundFontⓡ Technical Specification 2.04, §7.10 The SHDR sub-chunk"

    • kind

      NTSampleKind kind()
      Returns:
      The kind of the sample

    • start

      long start()
      Returns:
      The index, in sample data points, from the beginning of the sample data field to the first data point of this sample

    • end

      long end()
      Returns:
      The index, in sample data points, from the beginning of the sample data field to the first of the set of 46 zero valued data points following this sample

    • loopStart

      long loopStart()
      Returns:
      The index, in sample data points, from the beginning of the sample data field to the first data point in the loop of this sample

    • loopEnd

      long loopEnd()
      Returns:
      The index, in sample data points, from the beginning of the sample data field to the first data point following the loop of this sample. Note that this is the data point “equivalent to” the first loop data point, and that to produce portable artifact free loops, the eight proximal data points surrounding both the Startloop and Endloop points should be identical.

    • sampleRate

      int sampleRate()
      Returns:
      The sample rate in hz

    • originalPitch

      NTPitch originalPitch()
      Returns:
      The original pitch of the sample

    • pitchCorrection

      int pitchCorrection()
      Returns:
      The pitch correction value for the sample

    • sampleLink

      @Default default int sampleLink()
      Returns:
      The sample link