Homesplat-transform API Reference - v3.0.0
    Preparing search index...

    Function readFileInfo

    • Read a splat file's structural metadata as efficiently as the format allows — from the header alone wherever possible, without decoding gaussian data, and across every LOD level.

      sog is peeked from meta.json (no WebP decode); every other format opens via readFile (header-only for the lazy readers; eager for ksplat/mjs) and reads its meta. Integrity is enforced by the readers, which throw on a size mismatch, so a returned FileInfo implies a structurally sound file — but not necessarily splat data: a permissive container (e.g. a point-cloud PLY) reads fine with gaussian: false. To test "is this a valid splat", check both: a throw means unreadable, gaussian is the data verdict.

      Parameters

      Returns Promise<FileInfo>

      The file's FileInfo.