Class KSSPlay

Hierarchy

  • KSSPlay

Constructors

  • Create a new KSS player instance.

    Parameters

    • rate: number = 44100

      playback sample rate.

    Returns KSSPlay

Properties

_buffer: number = 0
_bufferSize: number = 0
_iowrite_handler: number = 0
_kssplay: number = 0
_memwrite_handler: number = 0
_song: number = 0

Methods

  • Parameters

    • size: number

    Returns void

  • Calculate specified length of wave samples.

    Returns

    generated samples.

    Parameters

    • samples: number

      The number of samples to render.

    Returns Int16Array

  • Calculate specified length without rendering wave.

    Parameters

    • samples: number

      number of samples to calculate.

    Returns void

  • Parameters

    • buffer: number

      pointer to the sample buffer.

    • samples: number

      number of samples to render.

    Returns void

  • Starts the fade-out.

    Parameters

    • duration: number

      fade-out duration in millis.

    Returns void

  • Get progress of the fading-out.

    Returns

    0: Not started, 1: In progress, 3: Completed.

    Returns number

  • Get the number of loops of the current playing music.

    Returns

    current loop counts.

    Returns number

  • MGSDRV's MIB.JUMPCT

    Returns

    value of MIB.JUMPCT

    Returns number

  • Check the player is stopped or not.

    Returns

    0: not stopped, 1: stopped.

    Returns number

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

    Returns void

  • Resets the player.

    Parameters

    • song: null | number

      The song number to play. If null, song index stored in KSS object is used.

    • cpuSpeed: number = 0

      0:AUTO, 1:3.58MHz 2:5.38MHz 3:7.16MHz 4:14.32MHz 5:28.64MHz

    Returns void

  • Set the kss object for playing.

    Parameters

    • kss: KSS

      kss instance.

    Returns void

  • Set RC low-pass filter params.

    Parameters

    • r: number

      Registor (OM)

    • c: number

      Capacitor (nF)

    Returns null

  • Set the limit of the slient length. The player automatically stops if it detects silent longer than this limit.

    Parameters

    • time: number

      maximum silent span in millis.

    Returns void

  • Write data to VM's I/O port.

    Parameters

    • a: number

      address

    • d: number

      data

    Returns void

  • Write data to VM's memory.

    Parameters

    • a: number

      address

    • d: number

      data

    Returns void

  • Delegate of the free function on the emscripten heap.

    Parameters

    • ptr: number

      pointer to the allocated buffer.

    Returns void

  • Delegate of the malloc function on the emscripten heap.

    Returns

    pointer to the allocated buffer.

    Parameters

    • size: number

      memory size to request.

    Returns number

  • Initialize library. Must be called with await before using KSS and KSSPlay classes.

    Returns

    a Promise object.

    Returns Promise<void>

  • Make Int16Array from the pointer of the allocated memory on the emscripten heap.

    Returns

    Int16Array that contains allocated memory.

    Parameters

    • ptr: number

      pointer to the allocated buffer.

    • size: number

      buffer size

    Returns Int16Array

Generated using TypeDoc