Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...
    • Validate and normalize a screenshot output format. Falls back to PNG if the requested format is a video container, and downgrades JPEG → PNG when transparency is required (JPEG has no alpha).

      Returns the effective format to encode and a flag indicating whether any normalization happened (for telemetry / toasts).

      Parameters

      • requested: string
      • transparentBackground: boolean

      Returns {
          format: ScreenshotImageFormat;
          warning: "video-fallback" | "jpeg-no-alpha" | null;
      }