Class

IBXM

IBXM(filename, buffersizeopt)

Constructor

# new IBXM(filename, buffersizeopt)

load MOD, S3M or XM module for sound playback.

Note: IBXM module must be loaded by calling LoadLibrary("ibxm") before using!

Parameters:
Name Type Attributes Description
filename string

file name of the soundfile to load.

buffersize number <optional>

playback buffer size, default is 16KiB.

See:
  • LoadLibrary()

Members

number

# channels

number of channels.

number

# duration

MOD file duration

string

# filename

name of file

number

# instruments

number of instruments

number

# patterns

number of patterns

number

# samplerate

sample rate.

Methods

# Close()

Close MOD after use.

# Play()

must be called periodically (e.g. every Loop()) to update the playback buffer.

# Rewind()

rewind to the start of the MOD.

# Seek(idx)

move audio to specified sample index.

Parameters:
Name Type Description
idx number

new play index