appium-uiautomator2-driver/build/lib/commands/screenshot.d.ts

UiAutomator2 integration for Appium

import type { AndroidUiautomator2Driver } from '../driver';
import type { Screenshot } from './types';
import type { StringRecord } from '@appium/types';
/**
 * Parses SurfaceFlinger display output to extract display information.
 * @param displaysInfo - The raw output from `adb shell dumpsys SurfaceFlinger --display-id`
 * @returns A record mapping display IDs to their information (without payload)
 */
export declare function parseSurfaceFlingerDisplays(displaysInfo: string): Record<string, Partial<Screenshot>>;
/**
 * Takes a screenshot of the current viewport
 */
export declare function mobileViewportScreenshot(this: AndroidUiautomator2Driver): Promise<string>;
/**
 * Gets a screenshot of the current viewport
 */
export declare function getViewportScreenshot(this: AndroidUiautomator2Driver): Promise<string>;
/**
 * Gets a screenshot of the current screen
 */
export declare function getScreenshot(this: AndroidUiautomator2Driver): Promise<string>;
/**
 * Retrieves screenshots of each display available to Android.
 * This functionality is only supported since Android 10.
 * @param displayId - Android display identifier to take a screenshot for.
 * If not provided then screenshots of all displays are going to be returned.
 * If no matches were found then an error is thrown.
 */
export declare function mobileScreenshots(this: AndroidUiautomator2Driver, displayId?: number | string): Promise<StringRecord<Screenshot>>;
//# sourceMappingURL=screenshot.d.ts.map