Type Alias SetSampleFormatOptions

Type Declaration

• OptionalprogressFunction?: ProgressFunction

  A function to show progress for compressing. It can be undefined.

• { format: "pcm" }

  • format: "pcm"

    The sample format to use.

    • pcm - decompresses the sound bank and changes its version to 2.04 (SF2)
    • compressed - compresses the sound bank with a given function and changes its version to 3.0 (SF3)

    Note that decompressing usually results in permanent sample quality loss!

• { compressionFunction: SampleEncodingFunction; format: "compressed" }

  • compressionFunction: SampleEncodingFunction

    The function for compressing samples. It must be provided if compressed format is chosen.

  • format: "compressed"

    The sample format to use.

    • pcm - decompresses the sound bank and changes its version to 2.04 (SF2)
    • compressed - compresses the sound bank with a given function and changes its version to 3.0 (SF3)

    Note that decompressing usually results in permanent sample quality loss!