@limrun/appium-xcuitest-driver 10.4.3-lim.1

package/build/lib/commands/record-audio.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Records the given hardware audio input and saves it into an `.mp4` file.
+ *
+ * **To use this command, the `audio_record` security feature must be enabled _and_ [FFMpeg](https://ffmpeg.org/) must be installed on the Appium server.**
+ *
+ * @param {string|number} audioInput - The name of the corresponding audio input device to use for the capture. The full list of capture devices could be shown by executing `ffmpeg -f avfoundation -list_devices true -i ""`
+ * @param {string|number} timeLimit - The maximum recording time, in seconds.
+ * @param {string} audioCodec - The name of the audio codec.
+ * @param {string} audioBitrate - The bitrate of the resulting audio stream.
+ * @param {string|number} audioChannels - The count of audio channels in the resulting stream. Setting it to `1` will create a single channel (mono) audio stream.
+ * @param {string|number} audioRate - The sampling rate of the resulting audio stream (in Hz).
+ * @param {boolean} forceRestart - Whether to restart audio capture process forcefully when `mobile: startRecordingAudio` is called (`true`) or ignore the call until the current audio recording is completed (`false`).
+ * @group Real Device Only
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
+ * @privateRemarks Using string literals for the default parameters makes better documentation.
+ */
+export function startAudioRecording(this: import("../driver").XCUITestDriver, audioInput: string | number, timeLimit?: string | number, audioCodec?: string, audioBitrate?: string, audioChannels?: string | number, audioRate?: string | number, forceRestart?: boolean): Promise<void>;
+export class startAudioRecording {
+    /**
+     * Records the given hardware audio input and saves it into an `.mp4` file.
+     *
+     * **To use this command, the `audio_record` security feature must be enabled _and_ [FFMpeg](https://ffmpeg.org/) must be installed on the Appium server.**
+     *
+     * @param {string|number} audioInput - The name of the corresponding audio input device to use for the capture. The full list of capture devices could be shown by executing `ffmpeg -f avfoundation -list_devices true -i ""`
+     * @param {string|number} timeLimit - The maximum recording time, in seconds.
+     * @param {string} audioCodec - The name of the audio codec.
+     * @param {string} audioBitrate - The bitrate of the resulting audio stream.
+     * @param {string|number} audioChannels - The count of audio channels in the resulting stream. Setting it to `1` will create a single channel (mono) audio stream.
+     * @param {string|number} audioRate - The sampling rate of the resulting audio stream (in Hz).
+     * @param {boolean} forceRestart - Whether to restart audio capture process forcefully when `mobile: startRecordingAudio` is called (`true`) or ignore the call until the current audio recording is completed (`false`).
+     * @group Real Device Only
+     * @this {XCUITestDriver}
+     * @returns {Promise<void>}
+     * @privateRemarks Using string literals for the default parameters makes better documentation.
+     */
+    constructor(this: import("../driver").XCUITestDriver, audioInput: string | number, timeLimit?: string | number, audioCodec?: string, audioBitrate?: string, audioChannels?: string | number, audioRate?: string | number, forceRestart?: boolean);
+    _audioRecorder: AudioRecorder;
+}
+/**
+ * Stop recording of the audio input. If no audio recording process is running then
+ * the endpoint will try to get the recently recorded file.
+ * If no previously recorded file is found and no active audio recording
+ * processes are running then the method returns an empty string.
+ *
+ * @returns {Promise<string>} Base64-encoded content of the recorded media file or an
+ * empty string if no audio recording has been started before.
+ * @throws {Error} If there was an error while getting the recorded file.
+ * @this {XCUITestDriver}
+ */
+export function stopAudioRecording(this: import("../driver").XCUITestDriver): Promise<string>;
+export class stopAudioRecording {
+    _audioRecorder: any;
+}
+export class AudioRecorder {
+    constructor(input: any, log: any, audioPath: any, opts?: {});
+    input: any;
+    log: any;
+    audioPath: any;
+    opts: {};
+    mainProcess: any;
+    start(timeoutSeconds: any): Promise<void>;
+    isRecording(): boolean;
+    interrupt(force?: boolean): Promise<boolean>;
+    finish(): Promise<any>;
+    cleanup(): Promise<void>;
+}
+export type XCUITestDriver = import("../driver").XCUITestDriver;
+//# sourceMappingURL=record-audio.d.ts.map

package/build/lib/commands/record-audio.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-audio.d.ts","sourceRoot":"","sources":["../../../lib/commands/record-audio.js"],"names":[],"mappings":"AAyIA;;;;;;;;;;;;;;;;GAgBG;AACH,0FAZW,MAAM,GAAC,MAAM,cACb,MAAM,GAAC,MAAM,eACb,MAAM,iBACN,MAAM,kBACN,MAAM,GAAC,MAAM,cACb,MAAM,GAAC,MAAM,iBACb,OAAO,GAGL,OAAO,CAAC,IAAI,CAAC,CA0EzB;;IAxFD;;;;;;;;;;;;;;;;OAgBG;IACH,kEAZW,MAAM,GAAC,MAAM,cACb,MAAM,GAAC,MAAM,eACb,MAAM,iBACN,MAAM,kBACN,MAAM,GAAC,MAAM,cACb,MAAM,GAAC,MAAM,iBACb,OAAO,EA6EjB;IAhCG,8BAA0B;;AAkC9B;;;;;;;;;;GAUG;AACH,8EALa,OAAO,CAAC,MAAM,CAAC,CA0B3B;;IAJG,oBAA0B;;AAjP9B;IACE,6DAMC;IALC,WAAkB;IAClB,SAAc;IACd,eAA0B;IAC1B,SAAgB;IAChB,iBAAuB;IAGzB,0CA8EC;IAED,uBAEC;IAED,6CAgBC;IAED,uBAGC;IAED,yBAIC;CACF;6BA+HY,OAAO,WAAW,EAAE,cAAc"}

package/build/lib/commands/record-audio.js

@@ -0,0 +1,228 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AudioRecorder = void 0;
+exports.startAudioRecording = startAudioRecording;
+exports.stopAudioRecording = stopAudioRecording;
+const support_1 = require("appium/support");
+const teen_process_1 = require("teen_process");
+const utils_1 = require("../utils");
+const asyncbox_1 = require("asyncbox");
+const MAX_RECORDING_TIME_SEC = 43200;
+const AUDIO_RECORD_FEAT_NAME = 'audio_record';
+const DEFAULT_SOURCE = 'avfoundation';
+const PROCESS_STARTUP_TIMEOUT_MS = 5000;
+const DEFAULT_EXT = '.mp4';
+const FFMPEG_BINARY = 'ffmpeg';
+const ffmpegLogger = support_1.logger.getLogger(FFMPEG_BINARY);
+class AudioRecorder {
+    constructor(input, log, audioPath, opts = {}) {
+        this.input = input;
+        this.log = log;
+        this.audioPath = audioPath;
+        this.opts = opts;
+        this.mainProcess = null;
+    }
+    async start(timeoutSeconds) {
+        try {
+            await support_1.fs.which(FFMPEG_BINARY);
+        }
+        catch {
+            throw new Error(`'${FFMPEG_BINARY}' binary is not found in PATH. Install it using 'brew install ffmpeg'. ` +
+                `Check https://www.ffmpeg.org/download.html for more details.`);
+        }
+        const { audioSource, audioCodec, audioBitrate, audioChannels, audioRate } = this.opts;
+        const args = [
+            '-t',
+            `${timeoutSeconds}`,
+            '-f',
+            audioSource,
+            '-i',
+            this.input,
+            '-c:a',
+            audioCodec,
+            '-b:a',
+            audioBitrate,
+            '-ac',
+            `${audioChannels}`,
+            '-ar',
+            `${audioRate}`,
+            this.audioPath,
+        ];
+        this.mainProcess = new teen_process_1.SubProcess(FFMPEG_BINARY, args);
+        let isCaptureStarted = false;
+        this.mainProcess.on('output', (stdout, stderr) => {
+            if (stderr) {
+                if (stderr.trim().startsWith('size=')) {
+                    if (!isCaptureStarted) {
+                        isCaptureStarted = true;
+                    }
+                }
+                else {
+                    ffmpegLogger.info(`${stderr}`);
+                }
+            }
+        });
+        await this.mainProcess.start(0);
+        try {
+            await (0, asyncbox_1.waitForCondition)(() => isCaptureStarted, {
+                waitMs: PROCESS_STARTUP_TIMEOUT_MS,
+                intervalMs: 300,
+            });
+        }
+        catch {
+            this.log.warn(`Audio recording process did not start within ${PROCESS_STARTUP_TIMEOUT_MS}ms. Continuing anyway`);
+        }
+        if (!this.mainProcess.isRunning) {
+            this.mainProcess = null;
+            throw new Error(`The audio recording process '${FFMPEG_BINARY}' died unexpectedly. ` +
+                `Check server logs for more details`);
+        }
+        this.log.info(`Starting capture on audio input '${this.input}' with command: '${support_1.util.quote([
+            FFMPEG_BINARY,
+            ...args,
+        ])}'. ` + `Will timeout in ${timeoutSeconds}s`);
+        this.mainProcess.once('exit', (code, signal) => {
+            // ffmpeg returns code 255 if SIGINT arrives
+            if ([0, 255].includes(code)) {
+                this.log.info(`The recording session on audio input '${this.input}' has been finished`);
+            }
+            else {
+                this.log.debug(`The recording session on audio input '${this.input}' has exited ` +
+                    `with code ${code}, signal ${signal}`);
+            }
+        });
+    }
+    isRecording() {
+        return !!this.mainProcess?.isRunning;
+    }
+    async interrupt(force = false) {
+        if (this.isRecording()) {
+            const interruptPromise = this.mainProcess?.stop(force ? 'SIGTERM' : 'SIGINT');
+            this.mainProcess = null;
+            try {
+                await interruptPromise;
+            }
+            catch (e) {
+                this.log.warn(`Cannot ${force ? 'terminate' : 'interrupt'} ${FFMPEG_BINARY}. ` +
+                    `Original error: ${e.message}`);
+                return false;
+            }
+        }
+        return true;
+    }
+    async finish() {
+        await this.interrupt();
+        return this.audioPath;
+    }
+    async cleanup() {
+        if (await support_1.fs.exists(this.audioPath)) {
+            await support_1.fs.rimraf(this.audioPath);
+        }
+    }
+}
+exports.AudioRecorder = AudioRecorder;
+/**
+ * Records the given hardware audio input and saves it into an `.mp4` file.
+ *
+ * **To use this command, the `audio_record` security feature must be enabled _and_ [FFMpeg](https://ffmpeg.org/) must be installed on the Appium server.**
+ *
+ * @param {string|number} audioInput - The name of the corresponding audio input device to use for the capture. The full list of capture devices could be shown by executing `ffmpeg -f avfoundation -list_devices true -i ""`
+ * @param {string|number} timeLimit - The maximum recording time, in seconds.
+ * @param {string} audioCodec - The name of the audio codec.
+ * @param {string} audioBitrate - The bitrate of the resulting audio stream.
+ * @param {string|number} audioChannels - The count of audio channels in the resulting stream. Setting it to `1` will create a single channel (mono) audio stream.
+ * @param {string|number} audioRate - The sampling rate of the resulting audio stream (in Hz).
+ * @param {boolean} forceRestart - Whether to restart audio capture process forcefully when `mobile: startRecordingAudio` is called (`true`) or ignore the call until the current audio recording is completed (`false`).
+ * @group Real Device Only
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
+ * @privateRemarks Using string literals for the default parameters makes better documentation.
+ */
+async function startAudioRecording(audioInput, timeLimit = 180, audioCodec = 'aac', audioBitrate = '128k', audioChannels = 2, audioRate = 44100, forceRestart = false) {
+    if (!this.isFeatureEnabled(AUDIO_RECORD_FEAT_NAME)) {
+        throw this.log.errorWithException(`Audio capture feature must be enabled on the server side. ` +
+            `Please set '--relaxed-security' or '--allow-insecure' with '${AUDIO_RECORD_FEAT_NAME}' option. ` +
+            `Read https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/security.md for more details.`);
+    }
+    if (!audioInput) {
+        throw this.log.errorWithException(`The mandatory audioInput option is not provided. Please set it ` +
+            `to a correct value (e. g. ':1'). Use 'ffmpeg -f avfoundation -list_devices true -i ""' ` +
+            `command to list available input sources`);
+    }
+    if (this._audioRecorder?.isRecording()) {
+        this.log.info(`There is an active audio recording process`);
+        if (forceRestart) {
+            this.log.info(`Stopping it because 'forceRestart' option is set to true`);
+            await this._audioRecorder.interrupt(true);
+        }
+        else {
+            this.log.info(`Doing nothing. ` +
+                `Set 'forceRestart' option to true if you'd like to start a new audio recording session`);
+            return;
+        }
+    }
+    if (this._audioRecorder) {
+        await this._audioRecorder.cleanup();
+        this._audioRecorder = null;
+    }
+    const audioPath = await support_1.tempDir.path({
+        prefix: `appium_${support_1.util.uuidV4().substring(0, 8)}`,
+        suffix: DEFAULT_EXT,
+    });
+    const audioRecorder = new AudioRecorder(audioInput, this.log, audioPath, {
+        audioSource: DEFAULT_SOURCE,
+        audioCodec,
+        audioBitrate,
+        audioChannels,
+        audioRate,
+    });
+    const timeoutSeconds = parseInt(String(timeLimit), 10);
+    if (isNaN(timeoutSeconds) || timeoutSeconds > MAX_RECORDING_TIME_SEC || timeoutSeconds <= 0) {
+        throw this.log.errorWithException(`The timeLimit value must be in range [1, ${MAX_RECORDING_TIME_SEC}] seconds. ` +
+            `The value of '${timeLimit}' has been passed instead.`);
+    }
+    try {
+        await audioRecorder.start(timeoutSeconds);
+    }
+    catch (e) {
+        await audioRecorder.interrupt(true);
+        await audioRecorder.cleanup();
+        throw e;
+    }
+    this._audioRecorder = audioRecorder;
+}
+/**
+ * Stop recording of the audio input. If no audio recording process is running then
+ * the endpoint will try to get the recently recorded file.
+ * If no previously recorded file is found and no active audio recording
+ * processes are running then the method returns an empty string.
+ *
+ * @returns {Promise<string>} Base64-encoded content of the recorded media file or an
+ * empty string if no audio recording has been started before.
+ * @throws {Error} If there was an error while getting the recorded file.
+ * @this {XCUITestDriver}
+ */
+async function stopAudioRecording() {
+    if (!this._audioRecorder) {
+        this.log.info('Audio recording has not been started. There is nothing to stop');
+        return '';
+    }
+    let resultPath;
+    try {
+        resultPath = await this._audioRecorder.finish();
+        if (!(await support_1.fs.exists(resultPath))) {
+            throw this.log.errorWithException(`${FFMPEG_BINARY} has failed ` + `to store the actual audio recording at '${resultPath}'`);
+        }
+    }
+    catch (e) {
+        await this._audioRecorder.interrupt(true);
+        await this._audioRecorder.cleanup();
+        this._audioRecorder = null;
+        throw e;
+    }
+    return await (0, utils_1.encodeBase64OrUpload)(resultPath);
+}
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ */
+//# sourceMappingURL=record-audio.js.map

package/build/lib/commands/record-audio.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-audio.js","sourceRoot":"","sources":["../../../lib/commands/record-audio.js"],"names":[],"mappings":";;;AA0JA,kDAuEC;AAaD,gDAqBC;AAnQD,4CAAyD;AACzD,+CAAwC;AACxC,oCAA8C;AAC9C,uCAA0C;AAE1C,MAAM,sBAAsB,GAAG,KAAK,CAAC;AACrC,MAAM,sBAAsB,GAAG,cAAc,CAAC;AAC9C,MAAM,cAAc,GAAG,cAAc,CAAC;AACtC,MAAM,0BAA0B,GAAG,IAAI,CAAC;AAExC,MAAM,WAAW,GAAG,MAAM,CAAC;AAC3B,MAAM,aAAa,GAAG,QAAQ,CAAC;AAC/B,MAAM,YAAY,GAAG,gBAAM,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;AAErD,MAAa,aAAa;IACxB,YAAY,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,GAAG,EAAE;QAC1C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,cAAc;QACxB,IAAI,CAAC;YACH,MAAM,YAAE,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAChC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CACb,IAAI,aAAa,yEAAyE;gBACxF,8DAA8D,CACjE,CAAC;QACJ,CAAC;QAED,MAAM,EAAC,WAAW,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAC,GAAG,IAAI,CAAC,IAAI,CAAC;QAEpF,MAAM,IAAI,GAAG;YACX,IAAI;YACJ,GAAG,cAAc,EAAE;YACnB,IAAI;YACJ,WAAW;YACX,IAAI;YACJ,IAAI,CAAC,KAAK;YACV,MAAM;YACN,UAAU;YACV,MAAM;YACN,YAAY;YACZ,KAAK;YACL,GAAG,aAAa,EAAE;YAClB,KAAK;YACL,GAAG,SAAS,EAAE;YACd,IAAI,CAAC,SAAS;SACf,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,IAAI,yBAAU,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QACvD,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;YAC/C,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;oBACtC,IAAI,CAAC,gBAAgB,EAAE,CAAC;wBACtB,gBAAgB,GAAG,IAAI,CAAC;oBAC1B,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,YAAY,CAAC,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC,CAAC;gBACjC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI,CAAC;YACH,MAAM,IAAA,2BAAgB,EAAC,GAAG,EAAE,CAAC,gBAAgB,EAAE;gBAC7C,MAAM,EAAE,0BAA0B;gBAClC,UAAU,EAAE,GAAG;aAChB,CAAC,CAAC;QACL,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,gDAAgD,0BAA0B,uBAAuB,CAClG,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,gCAAgC,aAAa,uBAAuB;gBAClE,oCAAoC,CACvC,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,oCAAoC,IAAI,CAAC,KAAK,oBAAoB,cAAI,CAAC,KAAK,CAAC;YAC3E,aAAa;YACb,GAAG,IAAI;SACR,CAAC,KAAK,GAAG,mBAAmB,cAAc,GAAG,CAC/C,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;YAC7C,4CAA4C;YAC5C,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC5B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,yCAAyC,IAAI,CAAC,KAAK,qBAAqB,CAAC,CAAC;YAC1F,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,yCAAyC,IAAI,CAAC,KAAK,eAAe;oBAChE,aAAa,IAAI,YAAY,MAAM,EAAE,CACxC,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,WAAW;QACT,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAK,GAAG,KAAK;QAC3B,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;YAC9E,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;YACxB,IAAI,CAAC;gBACH,MAAM,gBAAgB,CAAC;YACzB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,UAAU,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,IAAI,aAAa,IAAI;oBAC9D,mBAAmB,CAAC,CAAC,OAAO,EAAE,CACjC,CAAC;gBACF,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,MAAM,YAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACpC,MAAM,YAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;CACF;AAzHD,sCAyHC;AAED;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,mBAAmB,CACvC,UAAU,EACV,SAAS,GAAG,GAAG,EACf,UAAU,GAAG,KAAK,EAClB,YAAY,GAAG,MAAM,EACrB,aAAa,GAAG,CAAC,EACjB,SAAS,GAAG,KAAK,EACjB,YAAY,GAAG,KAAK;IAEpB,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,EAAE,CAAC;QACnD,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAC/B,4DAA4D;YAC1D,+DAA+D,sBAAsB,YAAY;YACjG,gHAAgH,CACnH,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAC/B,iEAAiE;YAC/D,yFAAyF;YACzF,yCAAyC,CAC5C,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,CAAC,cAAc,EAAE,WAAW,EAAE,EAAE,CAAC;QACvC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;QAC5D,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;YAC1E,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,iBAAiB;gBACf,wFAAwF,CAC3F,CAAC;YACF,OAAO;QACT,CAAC;IACH,CAAC;IACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAC7B,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,iBAAO,CAAC,IAAI,CAAC;QACnC,MAAM,EAAE,UAAU,cAAI,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;QACjD,MAAM,EAAE,WAAW;KACpB,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE;QACvE,WAAW,EAAE,cAAc;QAC3B,UAAU;QACV,YAAY;QACZ,aAAa;QACb,SAAS;KACV,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;IACvD,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,cAAc,GAAG,sBAAsB,IAAI,cAAc,IAAI,CAAC,EAAE,CAAC;QAC5F,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAC/B,4CAA4C,sBAAsB,aAAa;YAC7E,iBAAiB,SAAS,4BAA4B,CACzD,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,aAAa,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAC5C,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,aAAa,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,CAAC,CAAC;IACV,CAAC;IACD,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;AACtC,CAAC;AAED;;;;;;;;;;GAUG;AACI,KAAK,UAAU,kBAAkB;IACtC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;QACzB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAC;QAChF,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,UAAU,CAAC;IACf,IAAI,CAAC;QACH,UAAU,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAChD,IAAI,CAAC,CAAC,MAAM,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAC/B,GAAG,aAAa,cAAc,GAAG,2CAA2C,UAAU,GAAG,CAC1F,CAAC;QACJ,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC1C,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,MAAM,CAAC,CAAC;IACV,CAAC;IACD,OAAO,MAAM,IAAA,4BAAoB,EAAC,UAAU,CAAC,CAAC;AAChD,CAAC;AAED;;GAEG"}

package/build/lib/commands/recordscreen.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Direct Appium to start recording the device screen
+ *
+ * Record the display of devices running iOS Simulator since Xcode 9 or real devices since iOS 11
+ * (ffmpeg utility is required: 'brew install ffmpeg').
+ * It records screen activity to a MPEG-4 file. Audio is not recorded with the video file.
+ * If screen recording has been already started then the command will stop it forcefully and start a new one.
+ * The previously recorded video file will be deleted.
+ *
+ * @param {import('./types').StartRecordingScreenOptions} [options] - The available options.
+ * @returns {Promise<string>} Base64-encoded content of the recorded media file if
+ *                   any screen recording is currently running or an empty string.
+ * @throws {Error} If screen recording has failed to start.
+ * @this {XCUITestDriver}
+ */
+export function startRecordingScreen(this: import("../driver").XCUITestDriver, options?: import("./types").StartRecordingScreenOptions): Promise<string>;
+export class startRecordingScreen {
+    /**
+     * Direct Appium to start recording the device screen
+     *
+     * Record the display of devices running iOS Simulator since Xcode 9 or real devices since iOS 11
+     * (ffmpeg utility is required: 'brew install ffmpeg').
+     * It records screen activity to a MPEG-4 file. Audio is not recorded with the video file.
+     * If screen recording has been already started then the command will stop it forcefully and start a new one.
+     * The previously recorded video file will be deleted.
+     *
+     * @param {import('./types').StartRecordingScreenOptions} [options] - The available options.
+     * @returns {Promise<string>} Base64-encoded content of the recorded media file if
+     *                   any screen recording is currently running or an empty string.
+     * @throws {Error} If screen recording has failed to start.
+     * @this {XCUITestDriver}
+     */
+    constructor(this: import("../driver").XCUITestDriver, options?: import("./types").StartRecordingScreenOptions);
+    _recentScreenRecorder: ScreenRecorder;
+}
+/**
+ * Direct Appium to stop screen recording and return the video
+ *
+ * If no screen recording process is running then the endpoint will try to get
+ * the recently recorded file. If no previously recorded file is found and no
+ * active screen recording processes are running then the method returns an
+ * empty string.
+ *
+ * @param {import('./types').StopRecordingScreenOptions} options - The available
+ * options.
+ * @returns {Promise<string?>} Base64-encoded content of the recorded media
+ * file if `remotePath` parameter is empty or null or an empty string.
+ * @throws {Error} If there was an error while getting the name of a media
+ *                 file or the file content cannot be uploaded to the remote
+ *                 location.
+ * @this {XCUITestDriver}
+ */
+export function stopRecordingScreen(this: import("../driver").XCUITestDriver, options?: import("./types").StopRecordingScreenOptions): Promise<string | null>;
+export class stopRecordingScreen {
+    /**
+     * Direct Appium to stop screen recording and return the video
+     *
+     * If no screen recording process is running then the endpoint will try to get
+     * the recently recorded file. If no previously recorded file is found and no
+     * active screen recording processes are running then the method returns an
+     * empty string.
+     *
+     * @param {import('./types').StopRecordingScreenOptions} options - The available
+     * options.
+     * @returns {Promise<string?>} Base64-encoded content of the recorded media
+     * file if `remotePath` parameter is empty or null or an empty string.
+     * @throws {Error} If there was an error while getting the name of a media
+     *                 file or the file content cannot be uploaded to the remote
+     *                 location.
+     * @this {XCUITestDriver}
+     */
+    constructor(this: import("../driver").XCUITestDriver, options?: import("./types").StopRecordingScreenOptions);
+    _recentScreenRecorder: any;
+}
+export class ScreenRecorder {
+    constructor(udid: any, log: any, videoPath: any, opts?: {});
+    videoPath: any;
+    log: any;
+    opts: {};
+    udid: any;
+    mainProcess: any;
+    timeoutHandler: NodeJS.Timeout | null;
+    start(timeoutMs: any): Promise<void>;
+    interrupt(force?: boolean): Promise<boolean>;
+    finish(): Promise<any>;
+    cleanup(): Promise<void>;
+}
+export type XCUITestDriver = import("../driver").XCUITestDriver;
+//# sourceMappingURL=recordscreen.d.ts.map

package/build/lib/commands/recordscreen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recordscreen.d.ts","sourceRoot":"","sources":["../../../lib/commands/recordscreen.js"],"names":[],"mappings":"AAoOA;;;;;;;;;;;;;;GAcG;AACH,yFANW,OAAO,SAAS,EAAE,2BAA2B,GAC3C,OAAO,CAAC,MAAM,CAAC,CA6G3B;;IAvHD;;;;;;;;;;;;;;OAcG;IACH,gEANW,OAAO,SAAS,EAAE,2BAA2B,EA8GvD;IA7DG,sCAAiC;;AA+DrC;;;;;;;;;;;;;;;;GAgBG;AACH,wFATW,OAAO,SAAS,EAAE,0BAA0B,GAE1C,OAAO,CAAC,MAAM,OAAC,CAAC,CA2B5B;;IArCD;;;;;;;;;;;;;;;;OAgBG;IACH,gEATW,OAAO,SAAS,EAAE,0BAA0B,EA6BtD;IAFG,2BAAiC;;AA3TrC;IACE,4DAOC;IANC,eAA0B;IAC1B,SAAc;IACd,SAAgB;IAChB,UAAgB;IAChB,iBAAuB;IACvB,sCAA0B;IAG5B,qCA8GC;IAED,6CAuBC;IAED,uBAGC;IAED,yBAIC;CACF;6BAmKY,OAAO,WAAW,EAAE,cAAc"}