spessasynth_core documentation
    Preparing search index...

    Interface RMIDIWriteOptions

    Options for writing an RMIDI file.

    interface RMIDIWriteOptions {
        bankOffset: number;
        correctBankOffset: boolean;
        metadata: Partial<Omit<RMIDInfoData, "infoEncoding">>;
        soundBank?: BasicSoundBank;
    }
    Index
    bankOffset correctBankOffset metadata soundBank?
    bankOffset: number

    The bank offset to apply to the file. Defaults to 0. See this for more info

    correctBankOffset: boolean

    If the function should correct all program-selects and bank-selects in the MIDI file to reflect the embedded sound bank (i.e., make it self-contained). Recommended unless a specific use-case is required. Defaults to true.

    metadata: Partial<Omit<RMIDInfoData, "infoEncoding">>

    The metadata of the file. If left undefined, some basic metadata (like the song's title) will be copied from the MIDI. All properties are optional.

    soundBank?: BasicSoundBank

    The sound bank instance that soundBankBinary contains. Used for correcting bank and program changes when correctBankOffset is enabled. If omitted, bank correction may be less accurate.

    Settings
    Member Visibility

    On This Page
    Properties