Skip to content

Guide

Purpose

The guide section provides fast copy and paste solutions, intended for developers new to this library.

Install

Install with a package manager: npm, pnpm or yarn.

bash
$ npm install SoundFont3
bash
$ pnpm install SoundFont3
bash
$ yarn add SoundFont3

Import ES6

typescript
import { SoundFont3 } from 'SoundFont3'

Import CommonJS

typescript
const { SoundFont3 } = require('SoundFont3')

SoundFont3 compatability

Caution

While SoundFont2 is a standard, SoundFont3 is non-standard. The only difference is compressed audio samples. However, this is no guarantee that another library will implement this correctly.

Compatible tools

Non compatible tools

  • Polyphone - SoundFont editor with .sf2 and .sf3 support.
    • Sample needs padding so number of bytes are even as required by SoundFont 2.0.4