appium-android-driver/build/lib/commands/media-projection.d.ts

Android UiAutomator and Chrome support for Appium

import type { HTTPMethod, StringRecord } from '@appium/types';
import type { AndroidDriver } from '../driver';
import type { FormFields } from './types';
/**
 * Starts media projection-based screen recording on the Android device.
 *
 * @param resolution Maximum supported resolution on-device (Detected automatically by the app
 * itself), which usually equals to Full HD 1920x1080 on most phones however
 * you can change it to following supported resolutions as well: "1920x1080",
 * "1280x720", "720x480", "320x240", "176x144".
 * @param priority Recording thread priority.
 * If you face performance drops during testing with recording enabled, you
 * can reduce recording priority. 'high' by default.
 * @param maxDurationSec Maximum allowed duration is 15 minutes; you can increase it if your test
 * takes longer than that. 900s by default.
 * @param filename You can type recording video file name as you want, but recording currently
 * supports only "mp4" format so your filename must end with ".mp4". An
 * invalid file name will fail to start the recording. If not provided then
 * the current timestamp will be used as file name.
 * @returns Promise that resolves to `true` if recording was started, `false` if another recording is already in progress.
 */
export declare function mobileStartMediaProjectionRecording(this: AndroidDriver, resolution?: string, priority?: 'high' | 'normal' | 'low', maxDurationSec?: number, filename?: string): Promise<boolean>;
/**
 * Checks if media projection recording is currently running.
 *
 * @returns Promise that resolves to `true` if recording is running, `false` otherwise.
 */
export declare function mobileIsMediaProjectionRecordingRunning(this: AndroidDriver): Promise<boolean>;
/**
 * Stops the media projection recording and returns the recorded video.
 *
 * @param remotePath The path to the remote location, where the resulting video should be
 * uploaded. The following protocols are supported: http/https, ftp. Null or
 * empty string value (the default setting) means the content of resulting
 * file should be encoded as Base64 and passed as the endpoint response value.
 * An exception will be thrown if the generated media file is too big to fit
 * into the available process memory.
 * @param user The name of the user for the remote authentication.
 * @param pass The password for the remote authentication.
 * @param method The http multipart upload method name. 'PUT' by default.
 * @param headers Additional headers mapping for multipart http(s) uploads.
 * @param fileFieldName The name of the form field, where the file content BLOB should be stored
 * for http(s) uploads. 'file' by default.
 * @param formFields Additional form fields for multipart http(s) uploads.
 * @param uploadTimeout The actual media upload request timeout in milliseconds.
 * Defaults to `@appium/support.net.DEFAULT_TIMEOUT_MS`.
 * @returns Promise that resolves to the recorded video as a base64-encoded string
 * if `remotePath` is not provided, or an empty string if the video was uploaded to a remote location.
 * @throws {Error} If no recent recording was found.
 */
export declare function mobileStopMediaProjectionRecording(this: AndroidDriver, remotePath?: string, user?: string, pass?: string, method?: HTTPMethod, headers?: StringRecord, fileFieldName?: string, formFields?: FormFields, uploadTimeout?: number): Promise<string>;
//# sourceMappingURL=media-projection.d.ts.map