taglib-ts
    Preparing search index...

    TrueAudio (TTA) file format handler.

    Supports ID3v2 (primary) and ID3v1 (secondary) tags.

    Hierarchy (View Summary)

    Index

    Properties

    _stream: IOStream

    The underlying I/O stream.

    _valid: boolean = true

    Whether the file was parsed successfully. Subclasses set this to false when a fatal parse error is encountered.

    Accessors

    • get isOpen(): boolean

      Whether the underlying stream is currently open. Synchronous.

      Returns boolean

    • get isValid(): boolean

      Whether this file was parsed successfully.

      Returns boolean

    • get name(): string

      The name (path) of the underlying stream, as reported by the stream itself. Synchronous.

      Returns string

    • get readOnly(): boolean

      Whether the underlying stream is read-only. Synchronous.

      Returns boolean

    Methods

    • Resets the stream position to the beginning (equivalent to seek(0, Position.Beginning)).

      Returns Promise<void>

      A promise that resolves when the operation is complete.

    • Returns the list of complex-property keys supported by the tag.

      Returns string[]

      An array of key strings (e.g. "PICTURE").

    • Returns the total length of the stream in bytes.

      Note: this is an async method rather than a getter because getters cannot be async.

      Returns Promise<number>

      A promise resolving to the stream length in bytes.

    • Searches the stream forward for pattern starting at fromOffset.

      The stream cursor is restored to its original position after the search. If before is provided, the search stops (returning -1) as soon as before is encountered.

      Parameters

      • pattern: ByteVector

        The byte sequence to search for.

      • fromOffset: number = 0

        Byte offset at which to start searching. Defaults to 0.

      • Optionalbefore: ByteVector

        Optional sentinel; if found before pattern, returns -1.

      Returns Promise<number>

      A promise resolving to the byte offset of the first match, or -1 if not found.

    • Get the ID3v1 tag, optionally creating one if absent.

      Parameters

      • Optionalcreate: boolean

        When true, a new empty tag is created if none exists.

      Returns ID3v1Tag | null

      The ID3v1Tag, or null if absent and create is false.

    • Get the ID3v2 tag, optionally creating one if absent.

      Parameters

      • Optionalcreate: boolean

        When true, a new empty tag is created if none exists.

      Returns Id3v2Tag | null

      The Id3v2Tag, or null if absent and create is false.

    • Inserts data into the stream at start, optionally replacing replace bytes.

      Parameters

      • data: ByteVector

        The bytes to insert.

      • start: number = 0

        Byte offset at which to insert. Defaults to 0.

      • replace: number = 0

        Number of bytes to overwrite. Defaults to 0.

      Returns Promise<void>

      A promise that resolves when the operation is complete.

    • Reads up to length bytes from the current stream position.

      Parameters

      • length: number

        The maximum number of bytes to read.

      Returns Promise<ByteVector>

      A promise resolving to the bytes read as a ByteVector.

    • Removes length bytes from the stream starting at start.

      Parameters

      • start: number = 0

        Byte offset of the first byte to remove. Defaults to 0.

      • length: number = 0

        Number of bytes to remove. Defaults to 0.

      Returns Promise<void>

      A promise that resolves when the operation is complete.

    • Removes unsupported properties from the tag.

      Parameters

      • properties: string[]

        The list of property keys to remove.

      Returns void

    • Searches the stream backward for pattern, starting at fromOffset (default: end of file).

      The stream cursor is restored to its original position after the search. If before is provided, the search stops (returning -1) as soon as before is encountered while scanning backward.

      Parameters

      • pattern: ByteVector

        The byte sequence to search for.

      • fromOffset: number = 0

        Upper bound for the search. 0 means end of file. Defaults to 0.

      • Optionalbefore: ByteVector

        Optional sentinel; if found before pattern, returns -1.

      Returns Promise<number>

      A promise resolving to the byte offset of the match, or -1 if not found.

    • Writes all pending tag changes to the file.

      Returns Promise<boolean>

      true on success, false if the file is read-only.

    • Moves the stream's read/write cursor to offset relative to position.

      Parameters

      • offset: number

        The byte offset to seek to.

      • position: Position = Position.Beginning

        The seek origin. Defaults to Position.Beginning.

      Returns Promise<void>

      A promise that resolves when the seek is complete.

    • Sets complex property values for the given key.

      Parameters

      Returns boolean

      true if the property was set, false if not supported.

    • Returns the current byte offset of the stream cursor.

      Returns Promise<number>

      A promise resolving to the cursor position.

    • Truncates (or extends) the stream to exactly length bytes.

      Parameters

      • length: number

        The desired stream length in bytes.

      Returns Promise<void>

      A promise that resolves when the truncation is complete.

    • Writes data at the current stream position.

      Parameters

      Returns Promise<void>

      A promise that resolves when the write is complete.

    • The size of the read buffer used by find and rfind, in bytes.

      Returns number

      The buffer size (1024).

    • Quick-check whether stream looks like a valid TrueAudio file. A TTA file starts with "TTA"; an ID3v2 tag may precede the signature.

      Parameters

      Returns Promise<boolean>

    • Open and parse a TrueAudio file from the given stream.

      Parameters

      • stream: IOStream

        The I/O stream to read from.

      • readProperties: boolean = true

        Whether to parse audio properties. Defaults to true.

      • readStyle: ReadStyle = ReadStyle.Average

        Level of detail for audio property parsing. Defaults to ReadStyle.Average.

      Returns Promise<TrueAudioFile>

      A fully initialised TrueAudioFile instance.