spessasynth_core documentation
    Preparing search index...

    Class SpessaLog

    SpessaSynth can print out additional info to the console or print nothing at all.

    This class manages the log level of spessasynth_core.

    Index
    groupEnabled: boolean = false

    If grouping of the log messages is allowed. Recommended for the info verbosity level.

    infoEnabled: boolean = false

    The most verbose log level, prints out a lot of small details. Disabled by default.

    logFunctions: {
        group: (...data: any[]) => void;
        groupCollapsed: (...data: any[]) => void;
        groupEnd: () => void;
        info: (...data: any[]) => void;
        warn: (...data: any[]) => void;
    } = ...

    The log functions that get called with the data. By default, they use console object.

    This may be overridden to capture the spessasynth log data.

    Type Declaration

    • group: (...data: any[]) => void
    • groupCollapsed: (...data: any[]) => void
    • groupEnd: () => void
    • info: (...data: any[]) => void
    • warn: (...data: any[]) => void
    warnEnabled: boolean = true

    The default log level, prints out warnings for unexpected and erroneous behavior.

    • Equivalent to console.group when groupEnabled.

      Parameters

      • ...message: unknown[]

      Returns void

    • Equivalent to console.groupCollapsed when groupEnabled.

      Parameters

      • ...message: unknown[]

      Returns void

    • Equivalent to console.groupEnd when groupEnabled.

      Returns void

    • Equivalent to console.info when infoEnabled. Disabled by default

      Parameters

      • ...message: unknown[]

      Returns void

    • Enables or disables logging at various levels. All the input variables are booleans corresponding to the things SpessaSynth logs.

      Parameters

      • enableInfo: boolean

        enables info: all general info such as parsing sound banks, MIDI files, RPN changes, etc.

      • enableWarn: boolean

        enables warning: all messages unrecognized by the synthesizer, other warnings.

      • enableGroup: boolean

        enables groups: the groups for parsing the sound banks and MIDI files.

      Returns void

    • Equivalent to console.warn when warnEnabled.

      Parameters

      • ...message: unknown[]

      Returns void