Protected_The underlying I/O stream.
Protected_Whether the file was parsed successfully. Subclasses set this to false
when a fatal parse error is encountered.
Whether the file on disk has an APE tag.
Whether the file on disk has an ID3v1 tag.
Whether the underlying stream is currently open. Synchronous.
Whether this file was parsed successfully.
The name (path) of the underlying stream, as reported by the stream itself. Synchronous.
Whether the underlying stream is read-only. Synchronous.
Get the APE tag, optionally creating one if absent.
Optionalcreate: booleanReturn the audio properties parsed from the MAC header, or null if
readProperties was false when the file was opened.
Resets the stream position to the beginning (equivalent to
seek(0, Position.Beginning)).
A promise that resolves when the operation is complete.
Returns all complex property values for the given key.
The complex property key.
An array of VariantMap objects.
Returns the list of complex-property keys supported by the tag.
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.
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.
The byte sequence to search for.
Byte offset at which to start searching. Defaults to 0.
Optionalbefore: ByteVectorOptional sentinel; if found before pattern, returns -1.
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.
Optionalcreate: booleanInserts data into the stream at start, optionally replacing replace
bytes.
The bytes to insert.
Byte offset at which to insert. Defaults to 0.
Number of bytes to overwrite. Defaults to 0.
A promise that resolves when the operation is complete.
Returns a PropertyMap containing all tag fields exposed by this file's tag. Returns an empty map if no tag is present.
The property map.
Reads up to length bytes from the current stream position.
The maximum number of bytes to read.
A promise resolving to the bytes read as a ByteVector.
Removes length bytes from the stream starting at start.
Byte offset of the first byte to remove. Defaults to 0.
Number of bytes to remove. Defaults to 0.
A promise that resolves when the operation is complete.
Removes unsupported properties from the tag.
The list of property keys to remove.
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.
The byte sequence to search for.
Upper bound for the search. 0 means end of file.
Defaults to 0.
Optionalbefore: ByteVectorOptional sentinel; if found before pattern, returns -1.
A promise resolving to the byte offset of the match, or -1 if
not found.
Persist all in-memory tags back to the underlying stream.
true on success, false if the file is read-only.
Moves the stream's read/write cursor to offset relative to position.
The byte offset to seek to.
The seek origin. Defaults to Position.Beginning.
A promise that resolves when the seek is complete.
Sets complex property values for the given key.
The complex property key.
The array of VariantMap objects to store.
true if the property was set, false if not supported.
Replaces the tag's properties with the supplied map and returns a map of properties that could not be set (unsupported keys).
The new property map to apply.
A map of properties that were not applied.
Remove the specified tag types from the in-memory representation.
Call save() afterwards to persist the changes to disk.
Return the combined tag (APE preferred over ID3v1) for this file.
The CombinedTag aggregating all present tag types.
Returns the current byte offset of the stream cursor.
A promise resolving to the cursor position.
Truncates (or extends) the stream to exactly length bytes.
The desired stream length in bytes.
A promise that resolves when the truncation is complete.
Writes data at the current stream position.
The bytes to write.
A promise that resolves when the write is complete.
StaticbufferStaticisQuick-check whether stream looks like a valid APE file.
Looks for "MAC " signature, skipping an optional ID3v2 header.
StaticopenOpen an APE file from the given stream and parse its metadata.
A fully initialised ApeFile instance.
Monkey's Audio (APE) file format handler.
Supports APE (primary) and ID3v1 (secondary) tags. ID3v2 tags are detected and skipped but not parsed — they are invalid in APE files.