AbstractProtected_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 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.
ProtectednumNumber of header packets for this OGG format. Header packets are re-rendered on save; audio pages after them are copied verbatim. Override in subclasses:
Whether the underlying stream is read-only. Synchronous.
AbstractaudioReturns the format-specific audio properties, or null if unavailable.
The audio properties object, or null.
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.
Returns the header of the first OGG page in the stream.
The first OggPageHeader, or null if the stream is empty or invalid.
Inserts 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 the header of the last OGG page in the stream. Used for computing total granule count and thus stream duration.
The last OggPageHeader, or null if the stream is empty or invalid.
Retrieve a logical packet by its zero-based index. Returns the dirty (in-memory) version if one exists, otherwise reads and reassembles from disk.
Zero-based packet index.
The packet data as a ByteVector.
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 pending packet changes to the underlying stream.
Matches C++ Ogg::File::writePacket behaviour: for each dirty packet,
find the original pages that carry it, determine which other packets
co-reside on those pages, and repaginate only that range. Unchanged
pages are copied verbatim (with adjusted sequence numbers).
Key invariant: packet 0 (BOS/identification) always occupies exactly
one page by itself. Non-BOS packets are repaginated with
SinglePagePerGroup when the combined segment count fits in one page
(≤ 255) or with Repaginate per packet otherwise — exactly mirroring
C++ Ogg::Page::paginate.
true on success, false if the file is read-only or has no pages.
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.
Mark a packet as dirty with new content to be written on the next save.
Zero-based packet index.
New packet data to store and use when saving.
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.
AbstracttagReturns 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.
Staticbuffer
Abstract base class for OGG-based file formats. Provides packet-level access to the OGG bitstream by iterating pages and reassembling packets.
On save, only header pages are re-rendered from packets. Audio pages are preserved verbatim (with updated page sequence numbers) so that granule positions, page boundaries, and audio data remain intact — producing output that is fully seekable and playable.