taglib-ts
    Preparing search index...

    Audio properties for ScreamTracker III (S3M) files.

    S3M is a tracker module format; it has no defined playback duration in milliseconds. The properties describe module layout rather than a continuous audio stream.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _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 initial BPM speed (beats per minute).

      Returns number

      The BPM speed.

    • set bpmSpeed(value: number): void

      Sets the initial BPM speed.

      Parameters

      • value: number

        The BPM speed (beats per minute).

      Returns void

    • get channels(): number

      Returns the number of active channels in the module.

      Returns number

      The channel count.

    • set channels(value: number): void

      Sets the number of active channels.

      Parameters

      • value: number

        The channel count.

      Returns void

    • get fileFormatVersion(): number

      Returns the file format version byte from the S3M header.

      Returns number

      The file format version.

    • set fileFormatVersion(value: number): void

      Sets the file format version byte.

      Parameters

      • value: number

        The file format version.

      Returns void

    • get flags(): number

      Returns the raw flags word from the S3M header.

      Returns number

      The flags value.

    • set flags(value: number): void

      Sets the raw flags word.

      Parameters

      • value: number

        The flags value.

      Returns void

    • get globalVolume(): number

      Returns the global volume level (0–64).

      Returns number

      The global volume.

    • set globalVolume(value: number): void

      Sets the global volume level.

      Parameters

      • value: number

        The global volume (0–64).

      Returns void

    • get lengthInMilliseconds(): number

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

      Returns number

      0.

    • get lengthInPatterns(): number

      Returns the number of orders in the play sequence (real pattern length).

      Returns number

      The order count.

    • set lengthInPatterns(value: number): void

      Sets the number of orders in the play sequence.

      Parameters

      • value: number

        The order count.

      Returns void

    • get lengthInSeconds(): number

      Duration rounded to the nearest second.

      Returns number

    • get masterVolume(): number

      Returns the master output volume (0–127; bit 7 is the stereo flag).

      Returns number

      The master volume.

    • set masterVolume(value: number): void

      Sets the master output volume.

      Parameters

      • value: number

        The master volume (0–127).

      Returns void

    • get patternCount(): number

      Returns the total number of pattern slots in the module header.

      Returns number

      The pattern count.

    • set patternCount(value: number): void

      Sets the total number of pattern slots.

      Parameters

      • value: number

        The pattern count.

      Returns void

    • get sampleCount(): number

      Returns the total number of samples/instruments in the module.

      Returns number

      The sample count.

    • set sampleCount(value: number): void

      Sets the total number of samples/instruments.

      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 stereo(): boolean

      Returns whether the module uses stereo output.

      Returns boolean

      true for stereo, false for mono.

    • set stereo(value: boolean): void

      Sets whether the module uses stereo output.

      Parameters

      • value: boolean

        true for stereo, false for mono.

      Returns void

    • get tempo(): number

      Returns the initial tempo, expressed as rows per beat.

      Returns number

      The tempo value.

    • set tempo(value: number): void

      Sets the initial tempo.

      Parameters

      • value: number

        The tempo (rows per beat).

      Returns void

    • get trackerVersion(): number

      Returns the tracker version encoded in the S3M header.

      Returns number

      The tracker version word (e.g. 0x1320 for ST3 v3.20).

    • set trackerVersion(value: number): void

      Sets the tracker version word.

      Parameters

      • value: number

        The tracker version word.

      Returns void