Class KSS

Hierarchy

  • KSS

Constructors

constructor

Properties

data hasMultiSongs hash obj song hashMap

Methods

getTitle release toVGM toVGMAsync createUniqueInstance releaseAll

Constructors

constructor

  • Create a new KSS object.

    Parameters

    • data: Uint8Array

      the KSS file binary.

    • filename: string

      the name of the KSS file (used only for determine file type).

    • song: number = 0

      internal song index. (0 to 255)

    Returns KSS

Properties

data

data: Uint8Array

hasMultiSongs

hasMultiSongs: boolean = false

hash

hash: string = ''

obj

obj: any

song

song: number

Static hashMap

hashMap: {
    [key: string]: KSS;
} = {}

Type declaration

  • [key: string]: KSS

Methods

getTitle

  • get title string of the KSS file. This function assumes the title string of KSS is simple ASCII or SJIS encoded.

    Returns

    The title string if exists.

    Returns string

release

  • Release the object. Without calling this method will cause memory-leak.

    Returns void

toVGM

  • Convert KSS to VGM (blocking)

    Returns

    VGM data.

    Parameters

    Returns Uint8Array

toVGMAsync

  • Convert KSS to VGM (non-blocking)

    Returns

    Promise for VGM data or null if the conversion process is aborted.

    Parameters

    Returns Promise<null | Uint8Array>

Static createUniqueInstance

  • Create a unique KSS object. If the same data is given, this function returns the same KSS instance.

    Returns

    A KSS instance.

    Parameters

    • data: Uint8Array

      the KSS file binary.

    • filename: string

      the name of the KSS file.

    • song: number = 0

    Returns KSS

Static releaseAll

  • Destory all the cached KSS instances that generated from this library.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc