taglib-ts
    Preparing search index...

    Class XmProperties

    Audio properties for Extended Module (XM) files.

    XM is a tracker module format; it has no defined playback duration in milliseconds. The properties describe the module structure (channels, patterns, instruments, and tempo settings).

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _readStyle

    Accessors

    bitrate bpmSpeed channels flags instrumentCount lengthInMilliseconds lengthInPatterns lengthInSeconds patternCount restartPosition sampleCount sampleRate tempo version

    Constructors

    Properties

    Protected_readStyle

    _readStyle: ReadStyle

    The read style used when parsing the audio stream.

    Accessors

    • get bitrate(): number

      Average bitrate of the audio stream in kb/s. Returns 0 if the value is not available.

      Returns number

    • get bpmSpeed(): number

      Returns the default BPM speed (beats per minute).

      Returns number

      The BPM speed.

    • set bpmSpeed(value: number): void

      Sets the default BPM speed.

      Parameters

      • value: number

        The BPM speed (beats per minute).

      Returns void

    • get channels(): number

      Returns the number of channels used by the module.

      Returns number

      The channel count.

    • set channels(value: number): void

      Sets the number of channels.

      Parameters

      • value: number

        The channel count.

      Returns void

    • get flags(): number

      Returns the raw flags word from the XM header. Bit 0 selects between linear and Amiga frequency tables.

      Returns number

      The flags value.

    • set flags(value: number): void

      Sets the raw flags word.

      Parameters

      • value: number

        The flags value.

      Returns void

    • get instrumentCount(): number

      Returns the total number of instruments declared in the file.

      Returns number

      The instrument count.

    • set instrumentCount(value: number): void

      Sets the total number of instruments.

      Parameters

      • value: number

        The instrument count.

      Returns void

    • get lengthInMilliseconds(): number

      Returns the duration of the track in milliseconds. XM files have no defined playback duration; always returns 0.

      Returns number

      0.

    • get lengthInPatterns(): number

      Returns the number of entries in the pattern order table.

      Returns number

      The song length in patterns.

    • set lengthInPatterns(value: number): void

      Sets the number of entries in the pattern order table.

      Parameters

      • value: number

        The song length in patterns.

      Returns void

    • get lengthInSeconds(): number

      Duration rounded to the nearest second.

      Returns number

    • get patternCount(): number

      Returns the total number of patterns stored in the file.

      Returns number

      The pattern count.

    • set patternCount(value: number): void

      Sets the total number of patterns.

      Parameters

      • value: number

        The pattern count.

      Returns void

    • get restartPosition(): number

      Returns the pattern order table index at which the song restarts when looping.

      Returns number

      The restart position.

    • set restartPosition(value: number): void

      Sets the restart position.

      Parameters

      • value: number

        The pattern order table index to restart at.

      Returns void

    • get sampleCount(): number

      Returns the total number of samples across all instruments.

      Returns number

      The sample count.

    • set sampleCount(value: number): void

      Sets the total number of samples.

      Parameters

      • value: number

        The sample count.

      Returns void

    • get sampleRate(): number

      Sample rate of the audio stream in Hz. Returns 0 if the value is not available.

      Returns number

    • get tempo(): number

      Returns the default tempo in ticks per row.

      Returns number

      The tempo value.

    • set tempo(value: number): void

      Sets the default tempo.

      Parameters

      • value: number

        The tempo (ticks per row).

      Returns void

    • get version(): number

      Returns the XM format version number (e.g. 0x0104 for v1.04).

      Returns number

      The version word.

    • set version(value: number): void

      Sets the XM format version number.

      Parameters

      • value: number

        The version word.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors