CaptureObsidianScreenshotOptions

Options for captureObsidianScreenshot.

Import:

import type { CaptureObsidianScreenshotOptions } from 'obsidian-integration-testing';

Signature:

export interface CaptureObsidianScreenshotOptions

Properties

Property	Type	Description
heightInPixels?	number	The exact height in pixels the captured image should have. Desktop only, and only meaningful together with widthInPixels. Ignored on mobile, where the image is always the device's native framebuffer — size those by choosing an AVD with the wanted screen geometry.
transport?	ObsidianTransport	Override the transport. When omitted, the transport the current test context is driving is used.
vaultPath?	string	The vault path to capture. When omitted, the current test context's vault is used.
widthInPixels?	number	The exact width in pixels the captured image should have. See heightInPixels — the two are set together or not at all.

---

Links to this page:

• captureObsidianScreenshot