io.appium.settings 5.5.0 → 5.7.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [5.7.0](https://github.com/appium/io.appium.settings/compare/v5.6.0...v5.7.0) (2024-01-11)
+
+
+### Features
+
+* Make the index typed ([#140](https://github.com/appium/io.appium.settings/issues/140)) ([7020af0](https://github.com/appium/io.appium.settings/commit/7020af0c0ec542b2271b5e4685ff9c63a5faa4c2))
+
+## [5.6.0](https://github.com/appium/io.appium.settings/compare/v5.5.0...v5.6.0) (2024-01-10)
+
+
+### Features
+
+* Add media-projection-based video recorder ([#138](https://github.com/appium/io.appium.settings/issues/138)) ([ba357e8](https://github.com/appium/io.appium.settings/commit/ba357e8541e2f86e9db902ace4850fd04fb3ec57))
+
 ## [5.5.0](https://github.com/appium/io.appium.settings/compare/v5.4.2...v5.5.0) (2024-01-10)
 
 

package/build/lib/client.d.ts

@@ -73,6 +73,8 @@ export class SettingsApp {
     getSmsList: typeof getSmsList;
     performEditorAction: typeof performEditorAction;
     typeUnicode: typeof typeUnicode;
+    makeMediaProjectionRecorder: typeof makeMediaProjectionRecorder;
+    adjustMediaProjectionServicePermissions: typeof adjustMediaProjectionServicePermissions;
 }
 export type SettingsAppOpts = {
     adb: import('appium-adb').ADB;
@@ -91,4 +93,6 @@ import { adjustNotificationsPermissions } from './commands/notifications';
 import { getSmsList } from './commands/sms';
 import { performEditorAction } from './commands/typing';
 import { typeUnicode } from './commands/typing';
+import { makeMediaProjectionRecorder } from './commands/media-projection';
+import { adjustMediaProjectionServicePermissions } from './commands/media-projection';
 //# sourceMappingURL=client.d.ts.map

package/build/lib/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../lib/client.js"],"names":[],"mappings":"AAcA;;;GAGG;AAGH;IAOE;;OAEG;IACH,kBAFW,eAAe,EAKzB;IAZD,uCAAuC;IACvC,KADW,OAAO,YAAY,EAAE,GAAG,CAC/B;IAEJ,sCAAsC;IACtC,KADW,OAAO,QAAQ,EAAE,MAAM,CAC9B;IAUJ;;;;;;OAMG;IAEH;;;;;;;OAOG;IACH;;;;;;;;;;;oBAFa,QAAQ,WAAW,CAAC,CA4ChC;IAED;;;;;;;OAOG;IACH,yBAFa,QAAQ,OAAO,CAAC,CAY5B;IAED;;;;;;;;;;OAUG;IACH,uBAPW,MAAM,cACN,MAAM,OAgChB;IAED,4CAAsC;IAEtC,kCAA4B;IAE5B,sCAAgC;IAChC,sCAAgC;IAChC,wDAAkD;IAElD,wCAAkC;IAElC,4BAAsB;IAEtB,kCAA4B;IAC5B,kCAA4B;IAE5B,0CAAoC;IACpC,sEAAgE;IAChE,8BAAwB;IAExB,gDAA0C;IAC1C,gCAA0B;CAC3B;;SA/Ja,OAAO,YAAY,EAAE,GAAG;;kCAZJ,sBAAsB;6BAC3B,sBAAsB;+BACqB,wBAAwB;+BAAxB,wBAAwB;wCAAxB,wBAAwB;gCAChE,mBAAmB;0BACzB,kBAAkB;6BACD,oBAAoB;6BAApB,oBAAoB;iCACE,0BAA0B;+CAA1B,0BAA0B;2BAChE,gBAAgB;oCACM,mBAAmB;4BAAnB,mBAAmB"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../lib/client.js"],"names":[],"mappings":"AAkBA;;;GAGG;AAGH;IAOE;;OAEG;IACH,kBAFW,eAAe,EAKzB;IAZD,uCAAuC;IACvC,KADW,OAAO,YAAY,EAAE,GAAG,CAC/B;IAEJ,sCAAsC;IACtC,KADW,OAAO,QAAQ,EAAE,MAAM,CAC9B;IAUJ;;;;;;OAMG;IAEH;;;;;;;OAOG;IACH;;;;;;;;;;;oBAFa,QAAQ,WAAW,CAAC,CA4ChC;IAED;;;;;;;OAOG;IACH,yBAFa,QAAQ,OAAO,CAAC,CAY5B;IAED;;;;;;;;;;OAUG;IACH,uBAPW,MAAM,cACN,MAAM,OAgChB;IAED,4CAAsC;IAEtC,kCAA4B;IAE5B,sCAAgC;IAChC,sCAAgC;IAChC,wDAAkD;IAElD,wCAAkC;IAElC,4BAAsB;IAEtB,kCAA4B;IAC5B,kCAA4B;IAE5B,0CAAoC;IACpC,sEAAgE;IAChE,8BAAwB;IAExB,gDAA0C;IAC1C,gCAA0B;IAE1B,gEAA0D;IAC1D,wFAAkF;CACnF;;SAlKa,OAAO,YAAY,EAAE,GAAG;;kCAhBJ,sBAAsB;6BAC3B,sBAAsB;+BACqB,wBAAwB;+BAAxB,wBAAwB;wCAAxB,wBAAwB;gCAChE,mBAAmB;0BACzB,kBAAkB;6BACD,oBAAoB;6BAApB,oBAAoB;iCACE,0BAA0B;+CAA1B,0BAA0B;2BAChE,gBAAgB;oCACM,mBAAmB;4BAAnB,mBAAmB;4CAI7D,6BAA6B;wDAA7B,6BAA6B"}

package/build/lib/client.js

@@ -17,6 +17,7 @@ const network_1 = require("./commands/network");
 const notifications_1 = require("./commands/notifications");
 const sms_1 = require("./commands/sms");
 const typing_1 = require("./commands/typing");
+const media_projection_1 = require("./commands/media-projection");
 /**
  * @typedef {Object} SettingsAppOpts
  * @property {import('appium-adb').ADB} adb
@@ -40,6 +41,8 @@ class SettingsApp {
         this.getSmsList = sms_1.getSmsList;
         this.performEditorAction = typing_1.performEditorAction;
         this.typeUnicode = typing_1.typeUnicode;
+        this.makeMediaProjectionRecorder = media_projection_1.makeMediaProjectionRecorder;
+        this.adjustMediaProjectionServicePermissions = media_projection_1.adjustMediaProjectionServicePermissions;
         this.adb = opts.adb;
         this.log = logger_1.log;
     }

package/build/lib/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../lib/client.js"],"names":[],"mappings":";;;;;;AAAA,qCAA2C;AAC3C,oDAAuB;AACvB,uCAA4C;AAC5C,iDAAmF;AACnF,oDAAyD;AACzD,oDAAoD;AACpD,wDAAiG;AACjG,8CAAoD;AACpD,4CAA6C;AAC7C,gDAAgE;AAChE,4DAA4F;AAC5F,wCAA4C;AAC5C,8CAAqE;AAErE;;;GAGG;AAGH,MAAa,WAAW;IAOtB;;OAEG;IACH,YAAa,IAAI;QA4HjB,sBAAiB,GAAG,6BAAiB,CAAC;QAEtC,iBAAY,GAAG,wBAAY,CAAC;QAE5B,mBAAc,GAAG,4BAAc,CAAC;QAChC,mBAAc,GAAG,4BAAc,CAAC;QAChC,4BAAuB,GAAG,qCAAuB,CAAC;QAElD,oBAAe,GAAG,wBAAe,CAAC;QAElC,cAAS,GAAG,iBAAS,CAAC;QAEtB,iBAAY,GAAG,sBAAY,CAAC;QAC5B,iBAAY,GAAG,sBAAY,CAAC;QAE5B,qBAAgB,GAAG,gCAAgB,CAAC;QACpC,mCAA8B,GAAG,8CAA8B,CAAC;QAChE,eAAU,GAAG,gBAAU,CAAC;QAExB,wBAAmB,GAAG,4BAAmB,CAAC;QAC1C,gBAAW,GAAG,oBAAW,CAAC;QA/IxB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACpB,IAAI,CAAC,GAAG,GAAG,YAAG,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IAEH;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAAE,IAAI,GAAG,EAAE;QAC7B,IAAI,MAAM,IAAI,CAAC,qBAAqB,EAAE,EAAE,CAAC;YACvC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAU,EAAE,8BAA8B,CAAC,CAAC;QAC3D,MAAM,EACJ,OAAO,GAAG,IAAI,EACd,uBAAuB,GAAG,KAAK,GAChC,GAAG,IAAI,CAAC;QACT,IAAI,UAAU,CAAC;QACf,IAAI,uBAAuB,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,CAAC,EAAC,UAAU,EAAC,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,CAAC,CAAC;YACjE,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAU,EAAE,gDAAgD,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YACzF,CAAC;QACH,CAAC;QACD,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;YACtB,GAAG,EAAE,iCAAkB;YACvB,QAAQ,EAAE,4CAA6B;YACvC,MAAM,EAAE,4BAA4B;YACpC,QAAQ,EAAE,kCAAkC;YAC5C,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,KAAK;SACrB,CAAC,CAAC;QACH,IAAI,CAAC;YACH,MAAM,IAAA,2BAAgB,EAAC,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,qBAAqB,EAAE,EAAE;gBACrE,MAAM,EAAE,OAAO;gBACf,UAAU,EAAE,GAAG;aAChB,CAAC,CAAC;YACH,IAAI,uBAAuB,IAAI,UAAU,EAAE,CAAC;gBAC1C,IAAI,CAAC;oBACH,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;gBACzC,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,YAAG,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;gBACxE,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,4CAA4C,OAAO,IAAI,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,qBAAqB;QACzB,IAAI,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE,CAAC;YACtC,+DAA+D;YAC/D,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,iCAAkB,CAAC,CAAC;QAC1D,CAAC;QAED,wEAAwE;QACxE,oEAAoE;QACpE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,iCAAkB,CAAC,CAAC,CAAC;QAC7F,OAAO,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CAAE,MAAM,EAAE,UAAU;QAChC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAU,EAAE,MAAM,CAAC,CAAC;YACnC,MAAM,IAAI,KAAK,CACb,mBAAmB,UAAU,oBAAoB;gBACjD,uCAAuC,CACxC,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAU,EAAE,MAAM,CAAC,CAAC;YACnC,MAAM,IAAI,KAAK,CACb,gBAAgB,UAAU,4BAA4B;gBACtD,uCAAuC,CACxC,CAAC;QACJ,CAAC;QACD,MAAM,OAAO,GAAG,gBAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACjC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,YAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,gBAAgB,UAAU,mCAAmC;gBAC7D,uCAAuC,CACxC,CAAC;QACJ,CAAC;IACH,CAAC;CAuBF;AA3JD,kCA2JC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../lib/client.js"],"names":[],"mappings":";;;;;;AAAA,qCAA2C;AAC3C,oDAAuB;AACvB,uCAA4C;AAC5C,iDAAmF;AACnF,oDAAyD;AACzD,oDAAoD;AACpD,wDAAiG;AACjG,8CAAoD;AACpD,4CAA6C;AAC7C,gDAAgE;AAChE,4DAA4F;AAC5F,wCAA4C;AAC5C,8CAAqE;AACrE,kEAGqC;AAErC;;;GAGG;AAGH,MAAa,WAAW;IAOtB;;OAEG;IACH,YAAa,IAAI;QA4HjB,sBAAiB,GAAG,6BAAiB,CAAC;QAEtC,iBAAY,GAAG,wBAAY,CAAC;QAE5B,mBAAc,GAAG,4BAAc,CAAC;QAChC,mBAAc,GAAG,4BAAc,CAAC;QAChC,4BAAuB,GAAG,qCAAuB,CAAC;QAElD,oBAAe,GAAG,wBAAe,CAAC;QAElC,cAAS,GAAG,iBAAS,CAAC;QAEtB,iBAAY,GAAG,sBAAY,CAAC;QAC5B,iBAAY,GAAG,sBAAY,CAAC;QAE5B,qBAAgB,GAAG,gCAAgB,CAAC;QACpC,mCAA8B,GAAG,8CAA8B,CAAC;QAChE,eAAU,GAAG,gBAAU,CAAC;QAExB,wBAAmB,GAAG,4BAAmB,CAAC;QAC1C,gBAAW,GAAG,oBAAW,CAAC;QAE1B,gCAA2B,GAAG,8CAA2B,CAAC;QAC1D,4CAAuC,GAAG,0DAAuC,CAAC;QAlJhF,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACpB,IAAI,CAAC,GAAG,GAAG,YAAG,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IAEH;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAAE,IAAI,GAAG,EAAE;QAC7B,IAAI,MAAM,IAAI,CAAC,qBAAqB,EAAE,EAAE,CAAC;YACvC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAU,EAAE,8BAA8B,CAAC,CAAC;QAC3D,MAAM,EACJ,OAAO,GAAG,IAAI,EACd,uBAAuB,GAAG,KAAK,GAChC,GAAG,IAAI,CAAC;QACT,IAAI,UAAU,CAAC;QACf,IAAI,uBAAuB,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,CAAC,EAAC,UAAU,EAAC,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,CAAC,CAAC;YACjE,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAU,EAAE,gDAAgD,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YACzF,CAAC;QACH,CAAC;QACD,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;YACtB,GAAG,EAAE,iCAAkB;YACvB,QAAQ,EAAE,4CAA6B;YACvC,MAAM,EAAE,4BAA4B;YACpC,QAAQ,EAAE,kCAAkC;YAC5C,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,KAAK;SACrB,CAAC,CAAC;QACH,IAAI,CAAC;YACH,MAAM,IAAA,2BAAgB,EAAC,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,qBAAqB,EAAE,EAAE;gBACrE,MAAM,EAAE,OAAO;gBACf,UAAU,EAAE,GAAG;aAChB,CAAC,CAAC;YACH,IAAI,uBAAuB,IAAI,UAAU,EAAE,CAAC;gBAC1C,IAAI,CAAC;oBACH,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;gBACzC,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,YAAG,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;gBACxE,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,4CAA4C,OAAO,IAAI,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,qBAAqB;QACzB,IAAI,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE,CAAC;YACtC,+DAA+D;YAC/D,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,iCAAkB,CAAC,CAAC;QAC1D,CAAC;QAED,wEAAwE;QACxE,oEAAoE;QACpE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,iCAAkB,CAAC,CAAC,CAAC;QAC7F,OAAO,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CAAE,MAAM,EAAE,UAAU;QAChC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAU,EAAE,MAAM,CAAC,CAAC;YACnC,MAAM,IAAI,KAAK,CACb,mBAAmB,UAAU,oBAAoB;gBACjD,uCAAuC,CACxC,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAU,EAAE,MAAM,CAAC,CAAC;YACnC,MAAM,IAAI,KAAK,CACb,gBAAgB,UAAU,4BAA4B;gBACtD,uCAAuC,CACxC,CAAC;QACJ,CAAC;QACD,MAAM,OAAO,GAAG,gBAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACjC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,YAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,gBAAgB,UAAU,mCAAmC;gBAC7D,uCAAuC,CACxC,CAAC;QACJ,CAAC;IACH,CAAC;CA0BF;AA9JD,kCA8JC"}

package/build/lib/commands/media-projection.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Creates a new instance of the MediaProjection-based recorder
+ * The recorder only works since Android API 29+
+ *
+ * @this {import('../client').SettingsApp}
+ * @returns {MediaProjectionRecorder} The recorder instance
+ */
+export function makeMediaProjectionRecorder(this: import("../client").SettingsApp): MediaProjectionRecorder;
+/**
+ * Adjusts the necessary permissions for the
+ * Media Projection-based recording service
+ *
+ * @this {import('../client').SettingsApp}
+ * @returns {Promise<boolean>} If the permssions adjustment has actually been made
+ */
+export function adjustMediaProjectionServicePermissions(this: import("../client").SettingsApp): Promise<boolean>;
+export type StartMediaProjectionRecordingOpts = {
+    /**
+     * 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".
+     */
+    resolution?: string | undefined;
+    /**
+     * Maximum allowed duration is 15 minutes; you can increase it if your test
+     * takes longer than that.
+     */
+    maxDurationSec?: number | undefined;
+    /**
+     * Recording thread priority.
+     * If you face performance drops during testing with recording enabled, you
+     * can reduce recording priority
+     */
+    priority?: "high" | "normal" | "low" | undefined;
+    /**
+     * 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.
+     */
+    filename?: string | undefined;
+};
+export type ADB = import('appium-adb').ADB;
+/**
+ * @typedef {Object} StartMediaProjectionRecordingOpts
+ * @property {string} [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".
+ * @property {number} [maxDurationSec=900] Maximum allowed duration is 15 minutes; you can increase it if your test
+ * takes longer than that.
+ * @property {'high' | 'normal' | 'low'} [priority='high'] Recording thread priority.
+ * If you face performance drops during testing with recording enabled, you
+ * can reduce recording priority
+ * @property {string} [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.
+ */
+declare class MediaProjectionRecorder {
+    /**
+     * @param {ADB} adb
+     */
+    constructor(adb: ADB);
+    adb: import("appium-adb").default;
+    /**
+     *
+     * @returns {Promise<boolean>}
+     */
+    isRunning(): Promise<boolean>;
+    /**
+     *
+     * @param {StartMediaProjectionRecordingOpts} opts
+     * @returns {Promise<boolean>}
+     */
+    start(opts?: StartMediaProjectionRecordingOpts): Promise<boolean>;
+    /**
+     * @returns {Promise<void>}
+     */
+    cleanup(): Promise<void>;
+    /**
+     *
+     * @returns {Promise<string?>}
+     */
+    pullRecent(): Promise<string | null>;
+    /**
+     * @returns {Promise<boolean>}
+     */
+    stop(): Promise<boolean>;
+}
+export {};
+//# sourceMappingURL=media-projection.d.ts.map

package/build/lib/commands/media-projection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"media-projection.d.ts","sourceRoot":"","sources":["../../../lib/commands/media-projection.js"],"names":[],"mappings":"AAwJA;;;;;;GAMG;AACH,oFAFa,uBAAuB,CAInC;AAED;;;;;;GAMG;AACH,gGAFa,QAAQ,OAAO,CAAC,CAQ5B;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAGY,OAAO,YAAY,EAAE,GAAG;AAlKrC;;;;;;;;;;;;;;GAcG;AAEH;IACE;;OAEG;IACH,iBAFW,GAAG,EAIb;IADC,kCAAc;IAGhB;;;OAGG;IACH,aAFa,QAAQ,OAAO,CAAC,CAU5B;IAED;;;;OAIG;IACH,aAHW,iCAAiC,GAC/B,QAAQ,OAAO,CAAC,CAqC5B;IAED;;OAEG;IACH,WAFa,QAAQ,IAAI,CAAC,CAIzB;IAED;;;OAGG;IACH,cAFa,QAAQ,MAAM,QAAE,CAa5B;IAED;;OAEG;IACH,QAFa,QAAQ,OAAO,CAAC,CA2B5B;CACF"}

package/build/lib/commands/media-projection.js

@@ -0,0 +1,165 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adjustMediaProjectionServicePermissions = exports.makeMediaProjectionRecorder = void 0;
+const asyncbox_1 = require("asyncbox");
+const bluebird_1 = __importDefault(require("bluebird"));
+const lodash_1 = __importDefault(require("lodash"));
+const promises_1 = __importDefault(require("fs/promises"));
+const node_path_1 = __importDefault(require("node:path"));
+const constants_1 = require("../constants");
+const RECORDING_STARTUP_TIMEOUT_MS = 3 * 1000;
+const RECORDING_STOP_TIMEOUT_MS = 3 * 1000;
+const RECORDINGS_ROOT = `/storage/emulated/0/Android/data/${constants_1.SETTINGS_HELPER_ID}/files`;
+/**
+ * @typedef {Object} StartMediaProjectionRecordingOpts
+ * @property {string} [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".
+ * @property {number} [maxDurationSec=900] Maximum allowed duration is 15 minutes; you can increase it if your test
+ * takes longer than that.
+ * @property {'high' | 'normal' | 'low'} [priority='high'] Recording thread priority.
+ * If you face performance drops during testing with recording enabled, you
+ * can reduce recording priority
+ * @property {string} [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.
+ */
+class MediaProjectionRecorder {
+    /**
+     * @param {ADB} adb
+     */
+    constructor(adb) {
+        this.adb = adb;
+    }
+    /**
+     *
+     * @returns {Promise<boolean>}
+     */
+    async isRunning() {
+        const stdout = await this.adb.shell([
+            'dumpsys',
+            'activity',
+            'services',
+            constants_1.RECORDING_SERVICE_NAME,
+        ]);
+        return stdout.includes(constants_1.RECORDING_SERVICE_NAME);
+    }
+    /**
+     *
+     * @param {StartMediaProjectionRecordingOpts} opts
+     * @returns {Promise<boolean>}
+     */
+    async start(opts = {}) {
+        if (await this.isRunning()) {
+            return false;
+        }
+        await this.cleanup();
+        const { filename, maxDurationSec, priority, resolution } = opts;
+        const args = ['am', 'start', '-n', constants_1.RECORDING_ACTIVITY_NAME, '-a', constants_1.RECORDING_ACTION_START];
+        if (filename) {
+            args.push('--es', 'filename', filename);
+        }
+        if (maxDurationSec) {
+            args.push('--es', 'max_duration_sec', `${maxDurationSec}`);
+        }
+        if (priority) {
+            args.push('--es', 'priority', priority);
+        }
+        if (resolution) {
+            args.push('--es', 'resolution', resolution);
+        }
+        await this.adb.shell(args);
+        await new bluebird_1.default((resolve, reject) => {
+            setTimeout(async () => {
+                if (!(await this.isRunning())) {
+                    return reject(new Error(`The media projection recording is not running after ${RECORDING_STARTUP_TIMEOUT_MS}ms. ` +
+                        `Please check the logcat output for more details.`));
+                }
+                resolve();
+            }, RECORDING_STARTUP_TIMEOUT_MS);
+        });
+        return true;
+    }
+    /**
+     * @returns {Promise<void>}
+     */
+    async cleanup() {
+        await this.adb.shell([`rm -f ${RECORDINGS_ROOT}/*`]);
+    }
+    /**
+     *
+     * @returns {Promise<string?>}
+     */
+    async pullRecent() {
+        const recordings = await this.adb.ls(RECORDINGS_ROOT, ['-tr']);
+        if (lodash_1.default.isEmpty(recordings)) {
+            return null;
+        }
+        const tmpRoot = await promises_1.default.mkdtemp('recording');
+        const dstPath = node_path_1.default.join(tmpRoot, recordings[0]);
+        // increase timeout to 5 minutes because it might take a while to pull a large video file
+        await this.adb.pull(`${RECORDINGS_ROOT}/${recordings[0]}`, dstPath, { timeout: 300000 });
+        return dstPath;
+    }
+    /**
+     * @returns {Promise<boolean>}
+     */
+    async stop() {
+        if (!(await this.isRunning())) {
+            return false;
+        }
+        await this.adb.shell([
+            'am',
+            'start',
+            '-n',
+            constants_1.RECORDING_ACTIVITY_NAME,
+            '-a',
+            constants_1.RECORDING_ACTION_STOP,
+        ]);
+        try {
+            await (0, asyncbox_1.waitForCondition)(async () => !(await this.isRunning()), {
+                waitMs: RECORDING_STOP_TIMEOUT_MS,
+                intervalMs: 500,
+            });
+        }
+        catch (e) {
+            throw new Error(`The attempt to stop the current media projection recording timed out after ` +
+                `${RECORDING_STOP_TIMEOUT_MS}ms`);
+        }
+        return true;
+    }
+}
+/**
+ * Creates a new instance of the MediaProjection-based recorder
+ * The recorder only works since Android API 29+
+ *
+ * @this {import('../client').SettingsApp}
+ * @returns {MediaProjectionRecorder} The recorder instance
+ */
+function makeMediaProjectionRecorder() {
+    return new MediaProjectionRecorder(this.adb);
+}
+exports.makeMediaProjectionRecorder = makeMediaProjectionRecorder;
+/**
+ * Adjusts the necessary permissions for the
+ * Media Projection-based recording service
+ *
+ * @this {import('../client').SettingsApp}
+ * @returns {Promise<boolean>} If the permssions adjustment has actually been made
+ */
+async function adjustMediaProjectionServicePermissions() {
+    if (await this.adb.getApiLevel() >= 29) {
+        await this.adb.shell(['appops', 'set', constants_1.SETTINGS_HELPER_ID, 'PROJECT_MEDIA', 'allow']);
+        return true;
+    }
+    return false;
+}
+exports.adjustMediaProjectionServicePermissions = adjustMediaProjectionServicePermissions;
+/**
+ * @typedef {import('appium-adb').ADB} ADB
+ */
+//# sourceMappingURL=media-projection.js.map

package/build/lib/commands/media-projection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"media-projection.js","sourceRoot":"","sources":["../../../lib/commands/media-projection.js"],"names":[],"mappings":";;;;;;AAAA,uCAA0C;AAC1C,wDAAyB;AACzB,oDAAuB;AACvB,2DAA6B;AAC7B,0DAA6B;AAC7B,4CAMsB;AAEtB,MAAM,4BAA4B,GAAG,CAAC,GAAG,IAAI,CAAC;AAC9C,MAAM,yBAAyB,GAAG,CAAC,GAAG,IAAI,CAAC;AAC3C,MAAM,eAAe,GAAG,oCAAoC,8BAAkB,QAAQ,CAAC;AAEvF;;;;;;;;;;;;;;GAcG;AAEH,MAAM,uBAAuB;IAC3B;;OAEG;IACH,YAAY,GAAG;QACb,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS;QACb,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;YAClC,SAAS;YACT,UAAU;YACV,UAAU;YACV,kCAAsB;SACvB,CAAC,CAAC;QACH,OAAO,MAAM,CAAC,QAAQ,CAAC,kCAAsB,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,IAAI,GAAG,EAAE;QACnB,IAAI,MAAM,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,EAAC,QAAQ,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAC,GAAG,IAAI,CAAC;QAC9D,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,mCAAuB,EAAE,IAAI,EAAE,kCAAsB,CAAC,CAAC;QAC1F,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC1C,CAAC;QACD,IAAI,cAAc,EAAE,CAAC;YACnB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,kBAAkB,EAAE,GAAG,cAAc,EAAE,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC1C,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3B,MAAM,IAAI,kBAAC,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9B,UAAU,CAAC,KAAK,IAAI,EAAE;gBACpB,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;oBAC9B,OAAO,MAAM,CACX,IAAI,KAAK,CACP,uDAAuD,4BAA4B,MAAM;wBACvF,kDAAkD,CACrD,CACF,CAAC;gBACJ,CAAC;gBACD,OAAO,EAAE,CAAC;YACZ,CAAC,EAAE,4BAA4B,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,eAAe,IAAI,CAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/D,IAAI,gBAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,kBAAE,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,yFAAyF;QACzF,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,EAAC,OAAO,EAAE,MAAM,EAAC,CAAC,CAAC;QACvF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;YACnB,IAAI;YACJ,OAAO;YACP,IAAI;YACJ,mCAAuB;YACvB,IAAI;YACJ,iCAAqB;SACtB,CAAC,CAAC;QACH,IAAI,CAAC;YACH,MAAM,IAAA,2BAAgB,EAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE;gBAC5D,MAAM,EAAE,yBAAyB;gBACjC,UAAU,EAAE,GAAG;aAChB,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CACb,6EAA6E;gBAC3E,GAAG,yBAAyB,IAAI,CACnC,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;;;;GAMG;AACH,SAAgB,2BAA2B;IACzC,OAAO,IAAI,uBAAuB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,CAAC;AAFD,kEAEC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,uCAAuC;IAC3D,IAAI,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC;QACvC,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,8BAAkB,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;QACtF,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAND,0FAMC;AAED;;GAEG"}

package/build/lib/constants.d.ts

@@ -22,4 +22,8 @@ export const MEDIA_SCAN_RECEIVER: "io.appium.settings/.receivers.MediaScannerRec
 export const MEDIA_SCAN_ACTION: "io.appium.settings.scan_media";
 export const SETTING_NOTIFICATIONS_LISTENER_SERVICE: "io.appium.settings/.NLService";
 export const NOTIFICATIONS_RETRIEVAL_ACTION: "io.appium.settings.notifications";
+export const RECORDING_SERVICE_NAME: "io.appium.settings/.recorder.RecorderService";
+export const RECORDING_ACTIVITY_NAME: "io.appium.settings/io.appium.settings.Settings";
+export const RECORDING_ACTION_START: "io.appium.settings.recording.ACTION_START";
+export const RECORDING_ACTION_STOP: "io.appium.settings.recording.ACTION_STOP";
 //# sourceMappingURL=constants.d.ts.map

package/build/lib/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.js"],"names":[],"mappings":"AAAA,sDAAuD;AACvD,wDAAyD;AAEzD,mFAAuF;AACvF,4EAAgF;AAEhF,yDAA6D;AAC7D,2DAA+D;AAC/D,uDAA2D;AAE3D,6GAAiH;AACjH,uEAA2E;AAC3E,6GAAiH;AACjH,kFAAsF;AAEtF,kGAAsG;AACtG,sEAA0E;AAE1E,4FAAgG;AAChG,gEAAoE;AAEpE,qEAAyE;AACzE,qFAAyF;AACzF,sEAA0E;AAE1E,0EAA8E;AAC9E,sEAA0E;AAE1E,uFAA2F;AAC3F,gEAAoE;AAEpE,qFAAyF;AACzF,gFAAoF"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.js"],"names":[],"mappings":"AAAA,sDAAuD;AACvD,wDAAyD;AAEzD,mFAAuF;AACvF,4EAAgF;AAEhF,yDAA6D;AAC7D,2DAA+D;AAC/D,uDAA2D;AAE3D,6GAAiH;AACjH,uEAA2E;AAC3E,6GAAiH;AACjH,kFAAsF;AAEtF,kGAAsG;AACtG,sEAA0E;AAE1E,4FAAgG;AAChG,gEAAoE;AAEpE,qEAAyE;AACzE,qFAAyF;AACzF,sEAA0E;AAE1E,0EAA8E;AAC9E,sEAA0E;AAE1E,uFAA2F;AAC3F,gEAAoE;AAEpE,qFAAyF;AACzF,gFAAoF;AAEpF,oFAAwF;AACxF,uFAA2F;AAC3F,iFAAqF;AACrF,+EAAmF"}

package/build/lib/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NOTIFICATIONS_RETRIEVAL_ACTION = exports.SETTING_NOTIFICATIONS_LISTENER_SERVICE = exports.MEDIA_SCAN_ACTION = exports.MEDIA_SCAN_RECEIVER = exports.SMS_LIST_RETRIEVAL_ACTION = exports.SMS_LIST_RECEIVER = exports.LOCATION_RETRIEVAL_ACTION = exports.LOCATION_RECEIVER = exports.LOCATION_SERVICE = exports.LOCALE_SETTING_ACTION = exports.LOCALE_SETTING_RECEIVER = exports.ANIMATION_SETTING_ACTION = exports.ANIMATION_SETTING_RECEIVER = exports.DATA_CONNECTION_SETTING_ACTION = exports.DATA_CONNECTION_SETTING_RECEIVER = exports.WIFI_CONNECTION_SETTING_ACTION = exports.WIFI_CONNECTION_SETTING_RECEIVER = exports.EMPTY_IME = exports.UNICODE_IME = exports.APPIUM_IME = exports.CLIPBOARD_RETRIEVAL_ACTION = exports.CLIPBOARD_RECEIVER = exports.SETTINGS_HELPER_MAIN_ACTIVITY = exports.SETTINGS_HELPER_ID = void 0;
+exports.RECORDING_ACTION_STOP = exports.RECORDING_ACTION_START = exports.RECORDING_ACTIVITY_NAME = exports.RECORDING_SERVICE_NAME = exports.NOTIFICATIONS_RETRIEVAL_ACTION = exports.SETTING_NOTIFICATIONS_LISTENER_SERVICE = exports.MEDIA_SCAN_ACTION = exports.MEDIA_SCAN_RECEIVER = exports.SMS_LIST_RETRIEVAL_ACTION = exports.SMS_LIST_RECEIVER = exports.LOCATION_RETRIEVAL_ACTION = exports.LOCATION_RECEIVER = exports.LOCATION_SERVICE = exports.LOCALE_SETTING_ACTION = exports.LOCALE_SETTING_RECEIVER = exports.ANIMATION_SETTING_ACTION = exports.ANIMATION_SETTING_RECEIVER = exports.DATA_CONNECTION_SETTING_ACTION = exports.DATA_CONNECTION_SETTING_RECEIVER = exports.WIFI_CONNECTION_SETTING_ACTION = exports.WIFI_CONNECTION_SETTING_RECEIVER = exports.EMPTY_IME = exports.UNICODE_IME = exports.APPIUM_IME = exports.CLIPBOARD_RETRIEVAL_ACTION = exports.CLIPBOARD_RECEIVER = exports.SETTINGS_HELPER_MAIN_ACTIVITY = exports.SETTINGS_HELPER_ID = void 0;
 exports.SETTINGS_HELPER_ID = 'io.appium.settings';
 exports.SETTINGS_HELPER_MAIN_ACTIVITY = '.Settings';
 exports.CLIPBOARD_RECEIVER = `${exports.SETTINGS_HELPER_ID}/.receivers.ClipboardReceiver`;
@@ -25,4 +25,8 @@ exports.MEDIA_SCAN_RECEIVER = `${exports.SETTINGS_HELPER_ID}/.receivers.MediaSca
 exports.MEDIA_SCAN_ACTION = `${exports.SETTINGS_HELPER_ID}.scan_media`;
 exports.SETTING_NOTIFICATIONS_LISTENER_SERVICE = `${exports.SETTINGS_HELPER_ID}/.NLService`;
 exports.NOTIFICATIONS_RETRIEVAL_ACTION = `${exports.SETTINGS_HELPER_ID}.notifications`;
+exports.RECORDING_SERVICE_NAME = `${exports.SETTINGS_HELPER_ID}/.recorder.RecorderService`;
+exports.RECORDING_ACTIVITY_NAME = `${exports.SETTINGS_HELPER_ID}/io.appium.settings.Settings`;
+exports.RECORDING_ACTION_START = `${exports.SETTINGS_HELPER_ID}.recording.ACTION_START`;
+exports.RECORDING_ACTION_STOP = `${exports.SETTINGS_HELPER_ID}.recording.ACTION_STOP`;
 //# sourceMappingURL=constants.js.map

package/build/lib/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../lib/constants.js"],"names":[],"mappings":";;;AAAa,QAAA,kBAAkB,GAAG,oBAAoB,CAAC;AAC1C,QAAA,6BAA6B,GAAG,WAAW,CAAC;AAE5C,QAAA,kBAAkB,GAAG,GAAG,0BAAkB,+BAA+B,CAAC;AAC1E,QAAA,0BAA0B,GAAG,GAAG,0BAAkB,gBAAgB,CAAC;AAEnE,QAAA,UAAU,GAAG,GAAG,0BAAkB,aAAa,CAAC;AAChD,QAAA,WAAW,GAAG,GAAG,0BAAkB,cAAc,CAAC;AAClD,QAAA,SAAS,GAAG,GAAG,0BAAkB,YAAY,CAAC;AAE9C,QAAA,gCAAgC,GAAG,GAAG,0BAAkB,2CAA2C,CAAC;AACpG,QAAA,8BAA8B,GAAG,GAAG,0BAAkB,OAAO,CAAC;AAC9D,QAAA,gCAAgC,GAAG,GAAG,0BAAkB,2CAA2C,CAAC;AACpG,QAAA,8BAA8B,GAAG,GAAG,0BAAkB,kBAAkB,CAAC;AAEzE,QAAA,0BAA0B,GAAG,GAAG,0BAAkB,sCAAsC,CAAC;AACzF,QAAA,wBAAwB,GAAG,GAAG,0BAAkB,YAAY,CAAC;AAE7D,QAAA,uBAAuB,GAAG,GAAG,0BAAkB,mCAAmC,CAAC;AACnF,QAAA,qBAAqB,GAAG,GAAG,0BAAkB,SAAS,CAAC;AAEvD,QAAA,gBAAgB,GAAG,GAAG,0BAAkB,mBAAmB,CAAC;AAC5D,QAAA,iBAAiB,GAAG,GAAG,0BAAkB,kCAAkC,CAAC;AAC5E,QAAA,yBAAyB,GAAG,GAAG,0BAAkB,WAAW,CAAC;AAE7D,QAAA,iBAAiB,GAAG,GAAG,0BAAkB,uBAAuB,CAAC;AACjE,QAAA,yBAAyB,GAAG,GAAG,0BAAkB,WAAW,CAAC;AAE7D,QAAA,mBAAmB,GAAG,GAAG,0BAAkB,kCAAkC,CAAC;AAC9E,QAAA,iBAAiB,GAAG,GAAG,0BAAkB,aAAa,CAAC;AAEvD,QAAA,sCAAsC,GAAG,GAAG,0BAAkB,aAAa,CAAC;AAC5E,QAAA,8BAA8B,GAAG,GAAG,0BAAkB,gBAAgB,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../lib/constants.js"],"names":[],"mappings":";;;AAAa,QAAA,kBAAkB,GAAG,oBAAoB,CAAC;AAC1C,QAAA,6BAA6B,GAAG,WAAW,CAAC;AAE5C,QAAA,kBAAkB,GAAG,GAAG,0BAAkB,+BAA+B,CAAC;AAC1E,QAAA,0BAA0B,GAAG,GAAG,0BAAkB,gBAAgB,CAAC;AAEnE,QAAA,UAAU,GAAG,GAAG,0BAAkB,aAAa,CAAC;AAChD,QAAA,WAAW,GAAG,GAAG,0BAAkB,cAAc,CAAC;AAClD,QAAA,SAAS,GAAG,GAAG,0BAAkB,YAAY,CAAC;AAE9C,QAAA,gCAAgC,GAAG,GAAG,0BAAkB,2CAA2C,CAAC;AACpG,QAAA,8BAA8B,GAAG,GAAG,0BAAkB,OAAO,CAAC;AAC9D,QAAA,gCAAgC,GAAG,GAAG,0BAAkB,2CAA2C,CAAC;AACpG,QAAA,8BAA8B,GAAG,GAAG,0BAAkB,kBAAkB,CAAC;AAEzE,QAAA,0BAA0B,GAAG,GAAG,0BAAkB,sCAAsC,CAAC;AACzF,QAAA,wBAAwB,GAAG,GAAG,0BAAkB,YAAY,CAAC;AAE7D,QAAA,uBAAuB,GAAG,GAAG,0BAAkB,mCAAmC,CAAC;AACnF,QAAA,qBAAqB,GAAG,GAAG,0BAAkB,SAAS,CAAC;AAEvD,QAAA,gBAAgB,GAAG,GAAG,0BAAkB,mBAAmB,CAAC;AAC5D,QAAA,iBAAiB,GAAG,GAAG,0BAAkB,kCAAkC,CAAC;AAC5E,QAAA,yBAAyB,GAAG,GAAG,0BAAkB,WAAW,CAAC;AAE7D,QAAA,iBAAiB,GAAG,GAAG,0BAAkB,uBAAuB,CAAC;AACjE,QAAA,yBAAyB,GAAG,GAAG,0BAAkB,WAAW,CAAC;AAE7D,QAAA,mBAAmB,GAAG,GAAG,0BAAkB,kCAAkC,CAAC;AAC9E,QAAA,iBAAiB,GAAG,GAAG,0BAAkB,aAAa,CAAC;AAEvD,QAAA,sCAAsC,GAAG,GAAG,0BAAkB,aAAa,CAAC;AAC5E,QAAA,8BAA8B,GAAG,GAAG,0BAAkB,gBAAgB,CAAC;AAEvE,QAAA,sBAAsB,GAAG,GAAG,0BAAkB,4BAA4B,CAAC;AAC3E,QAAA,uBAAuB,GAAG,GAAG,0BAAkB,8BAA8B,CAAC;AAC9E,QAAA,sBAAsB,GAAG,GAAG,0BAAkB,yBAAyB,CAAC;AACxE,QAAA,qBAAqB,GAAG,GAAG,0BAAkB,wBAAwB,CAAC"}

package/build/lib/index.d.ts

@@ -0,0 +1,4 @@
+export const path: string;
+export * from "./constants";
+export { SettingsApp } from "./client";
+//# sourceMappingURL=index.d.ts.map

package/build/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.js"],"names":[],"mappings":"AAKA,0BAAyC"}

package/build/lib/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettingsApp = exports.path = void 0;
+const source_map_support_1 = require("source-map-support");
+(0, source_map_support_1.install)();
+const utils_1 = require("./utils");
+exports.path = (0, utils_1.getSettingsApkPath)();
+__exportStar(require("./constants"), exports);
+var client_1 = require("./client");
+Object.defineProperty(exports, "SettingsApp", { enumerable: true, get: function () { return client_1.SettingsApp; } });
+//# sourceMappingURL=index.js.map

package/build/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2DAA2C;AAC3C,IAAA,4BAAO,GAAE,CAAC;AAEV,mCAA6C;AAEhC,QAAA,IAAI,GAAG,IAAA,0BAAkB,GAAE,CAAC;AACzC,8CAA4B;AAC5B,mCAAuC;AAA9B,qGAAA,WAAW,OAAA"}

package/build/lib/utils.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get the full path to the Settings APK
+ *
+ * @returns {string}
+ */
+export function getSettingsApkPath(): string;
+//# sourceMappingURL=utils.d.ts.map

package/build/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../lib/utils.js"],"names":[],"mappings":"AA4BA;;;;GAIG;AACH,sCAFa,MAAM,CAIlB"}

package/build/lib/utils.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSettingsApkPath = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const MODULE_NAME = 'io.appium.settings';
+/**
+ * Tries to synchronously detect the absolute path to the folder
+ * where the given `moduleName` is located.
+ *
+ * @returns {string} Full path to the module root
+ */
+function getModuleRootSync() {
+    let currentDir = __dirname;
+    let isAtFsRoot = false;
+    while (!isAtFsRoot) {
+        const manifestPath = node_path_1.default.join(currentDir, 'package.json');
+        try {
+            if (node_fs_1.default.existsSync(manifestPath) &&
+                JSON.parse(node_fs_1.default.readFileSync(manifestPath, 'utf8')).name === MODULE_NAME) {
+                return currentDir;
+            }
+        }
+        catch (ign) { }
+        currentDir = node_path_1.default.dirname(currentDir);
+        isAtFsRoot = currentDir.length <= node_path_1.default.dirname(currentDir).length;
+    }
+    throw new Error(`Cannot find the root of the ${MODULE_NAME} Node.js module`);
+}
+/**
+ * Get the full path to the Settings APK
+ *
+ * @returns {string}
+ */
+function getSettingsApkPath() {
+    return node_path_1.default.resolve(getModuleRootSync(), 'apks', 'settings_apk-debug.apk');
+}
+exports.getSettingsApkPath = getSettingsApkPath;
+//# sourceMappingURL=utils.js.map

package/build/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../lib/utils.js"],"names":[],"mappings":";;;;;;AAAA,0DAA6B;AAC7B,sDAAyB;AAEzB,MAAM,WAAW,GAAG,oBAAoB,CAAC;AAEzC;;;;;GAKG;AACH,SAAS,iBAAiB;IACxB,IAAI,UAAU,GAAG,SAAS,CAAC;IAC3B,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,OAAO,CAAC,UAAU,EAAE,CAAC;QACnB,MAAM,YAAY,GAAG,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAC3D,IAAI,CAAC;YACH,IAAI,iBAAE,CAAC,UAAU,CAAC,YAAY,CAAC;gBAC3B,IAAI,CAAC,KAAK,CAAC,iBAAE,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBAC3E,OAAO,UAAU,CAAC;YACpB,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC,CAAA,CAAC;QAChB,UAAU,GAAG,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACtC,UAAU,GAAG,UAAU,CAAC,MAAM,IAAI,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC;IACpE,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,+BAA+B,WAAW,iBAAiB,CAAC,CAAC;AAC/E,CAAC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB;IAChC,OAAO,mBAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,MAAM,EAAE,wBAAwB,CAAC,CAAC;AAC7E,CAAC;AAFD,gDAEC"}

package/lib/client.js

@@ -11,6 +11,10 @@ import { setDataState, setWifiState } from './commands/network';
 import { getNotifications, adjustNotificationsPermissions } from './commands/notifications';
 import { getSmsList } from './commands/sms';
 import { performEditorAction, typeUnicode } from './commands/typing';
+import {
+  makeMediaProjectionRecorder,
+  adjustMediaProjectionServicePermissions,
+} from './commands/media-projection';
 
 /**
  * @typedef {Object} SettingsAppOpts
@@ -173,4 +177,7 @@ export class SettingsApp {
 
   performEditorAction = performEditorAction;
   typeUnicode = typeUnicode;
+
+  makeMediaProjectionRecorder = makeMediaProjectionRecorder;
+  adjustMediaProjectionServicePermissions = adjustMediaProjectionServicePermissions;
 }

package/lib/commands/media-projection.js

@@ -0,0 +1,181 @@
+import {waitForCondition} from 'asyncbox';
+import B from 'bluebird';
+import _ from 'lodash';
+import fs from 'fs/promises';
+import path from 'node:path';
+import {
+  SETTINGS_HELPER_ID,
+  RECORDING_ACTION_START,
+  RECORDING_ACTION_STOP,
+  RECORDING_ACTIVITY_NAME,
+  RECORDING_SERVICE_NAME,
+} from '../constants';
+
+const RECORDING_STARTUP_TIMEOUT_MS = 3 * 1000;
+const RECORDING_STOP_TIMEOUT_MS = 3 * 1000;
+const RECORDINGS_ROOT = `/storage/emulated/0/Android/data/${SETTINGS_HELPER_ID}/files`;
+
+/**
+ * @typedef {Object} StartMediaProjectionRecordingOpts
+ * @property {string} [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".
+ * @property {number} [maxDurationSec=900] Maximum allowed duration is 15 minutes; you can increase it if your test
+ * takes longer than that.
+ * @property {'high' | 'normal' | 'low'} [priority='high'] Recording thread priority.
+ * If you face performance drops during testing with recording enabled, you
+ * can reduce recording priority
+ * @property {string} [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.
+ */
+
+class MediaProjectionRecorder {
+  /**
+   * @param {ADB} adb
+   */
+  constructor(adb) {
+    this.adb = adb;
+  }
+
+  /**
+   *
+   * @returns {Promise<boolean>}
+   */
+  async isRunning() {
+    const stdout = await this.adb.shell([
+      'dumpsys',
+      'activity',
+      'services',
+      RECORDING_SERVICE_NAME,
+    ]);
+    return stdout.includes(RECORDING_SERVICE_NAME);
+  }
+
+  /**
+   *
+   * @param {StartMediaProjectionRecordingOpts} opts
+   * @returns {Promise<boolean>}
+   */
+  async start(opts = {}) {
+    if (await this.isRunning()) {
+      return false;
+    }
+
+    await this.cleanup();
+    const {filename, maxDurationSec, priority, resolution} = opts;
+    const args = ['am', 'start', '-n', RECORDING_ACTIVITY_NAME, '-a', RECORDING_ACTION_START];
+    if (filename) {
+      args.push('--es', 'filename', filename);
+    }
+    if (maxDurationSec) {
+      args.push('--es', 'max_duration_sec', `${maxDurationSec}`);
+    }
+    if (priority) {
+      args.push('--es', 'priority', priority);
+    }
+    if (resolution) {
+      args.push('--es', 'resolution', resolution);
+    }
+    await this.adb.shell(args);
+    await new B((resolve, reject) => {
+      setTimeout(async () => {
+        if (!(await this.isRunning())) {
+          return reject(
+            new Error(
+              `The media projection recording is not running after ${RECORDING_STARTUP_TIMEOUT_MS}ms. ` +
+                `Please check the logcat output for more details.`
+            )
+          );
+        }
+        resolve();
+      }, RECORDING_STARTUP_TIMEOUT_MS);
+    });
+    return true;
+  }
+
+  /**
+   * @returns {Promise<void>}
+   */
+  async cleanup() {
+    await this.adb.shell([`rm -f ${RECORDINGS_ROOT}/*`]);
+  }
+
+  /**
+   *
+   * @returns {Promise<string?>}
+   */
+  async pullRecent() {
+    const recordings = await this.adb.ls(RECORDINGS_ROOT, ['-tr']);
+    if (_.isEmpty(recordings)) {
+      return null;
+    }
+
+    const tmpRoot = await fs.mkdtemp('recording');
+    const dstPath = path.join(tmpRoot, recordings[0]);
+    // increase timeout to 5 minutes because it might take a while to pull a large video file
+    await this.adb.pull(`${RECORDINGS_ROOT}/${recordings[0]}`, dstPath, {timeout: 300000});
+    return dstPath;
+  }
+
+  /**
+   * @returns {Promise<boolean>}
+   */
+  async stop() {
+    if (!(await this.isRunning())) {
+      return false;
+    }
+
+    await this.adb.shell([
+      'am',
+      'start',
+      '-n',
+      RECORDING_ACTIVITY_NAME,
+      '-a',
+      RECORDING_ACTION_STOP,
+    ]);
+    try {
+      await waitForCondition(async () => !(await this.isRunning()), {
+        waitMs: RECORDING_STOP_TIMEOUT_MS,
+        intervalMs: 500,
+      });
+    } catch (e) {
+      throw new Error(
+        `The attempt to stop the current media projection recording timed out after ` +
+          `${RECORDING_STOP_TIMEOUT_MS}ms`
+      );
+    }
+    return true;
+  }
+}
+
+/**
+ * Creates a new instance of the MediaProjection-based recorder
+ * The recorder only works since Android API 29+
+ *
+ * @this {import('../client').SettingsApp}
+ * @returns {MediaProjectionRecorder} The recorder instance
+ */
+export function makeMediaProjectionRecorder() {
+  return new MediaProjectionRecorder(this.adb);
+}
+
+/**
+ * Adjusts the necessary permissions for the
+ * Media Projection-based recording service
+ *
+ * @this {import('../client').SettingsApp}
+ * @returns {Promise<boolean>} If the permssions adjustment has actually been made
+ */
+export async function adjustMediaProjectionServicePermissions() {
+  if (await this.adb.getApiLevel() >= 29) {
+    await this.adb.shell(['appops', 'set', SETTINGS_HELPER_ID, 'PROJECT_MEDIA', 'allow']);
+    return true;
+  }
+  return false;
+}
+
+/**
+ * @typedef {import('appium-adb').ADB} ADB
+ */

package/lib/constants.js

@@ -31,3 +31,8 @@ export const MEDIA_SCAN_ACTION = `${SETTINGS_HELPER_ID}.scan_media`;
 
 export const SETTING_NOTIFICATIONS_LISTENER_SERVICE = `${SETTINGS_HELPER_ID}/.NLService`;
 export const NOTIFICATIONS_RETRIEVAL_ACTION = `${SETTINGS_HELPER_ID}.notifications`;
+
+export const RECORDING_SERVICE_NAME = `${SETTINGS_HELPER_ID}/.recorder.RecorderService`;
+export const RECORDING_ACTIVITY_NAME = `${SETTINGS_HELPER_ID}/io.appium.settings.Settings`;
+export const RECORDING_ACTION_START = `${SETTINGS_HELPER_ID}.recording.ACTION_START`;
+export const RECORDING_ACTION_STOP = `${SETTINGS_HELPER_ID}.recording.ACTION_STOP`;

package/lib/index.js

@@ -0,0 +1,8 @@
+import {install} from 'source-map-support';
+install();
+
+import { getSettingsApkPath } from './utils';
+
+export const path = getSettingsApkPath();
+export * from './constants';
+export { SettingsApp } from './client';

package/lib/utils.js

@@ -0,0 +1,36 @@
+import path from 'node:path';
+import fs from 'node:fs';
+
+const MODULE_NAME = 'io.appium.settings';
+
+/**
+ * Tries to synchronously detect the absolute path to the folder
+ * where the given `moduleName` is located.
+ *
+ * @returns {string} Full path to the module root
+ */
+function getModuleRootSync () {
+  let currentDir = __dirname;
+  let isAtFsRoot = false;
+  while (!isAtFsRoot) {
+    const manifestPath = path.join(currentDir, 'package.json');
+    try {
+      if (fs.existsSync(manifestPath) &&
+          JSON.parse(fs.readFileSync(manifestPath, 'utf8')).name === MODULE_NAME) {
+        return currentDir;
+      }
+    } catch (ign) {}
+    currentDir = path.dirname(currentDir);
+    isAtFsRoot = currentDir.length <= path.dirname(currentDir).length;
+  }
+  throw new Error(`Cannot find the root of the ${MODULE_NAME} Node.js module`);
+}
+
+/**
+ * Get the full path to the Settings APK
+ *
+ * @returns {string}
+ */
+export function getSettingsApkPath() {
+  return path.resolve(getModuleRootSync(), 'apks', 'settings_apk-debug.apk');
+}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "io.appium.settings",
-  "version": "5.5.0",
+  "version": "5.7.0",
   "description": "App for dealing with Android settings",
-  "main": "index.js",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
   "scripts": {
     "bump-gradle-version": "node scripts/gradle-version-update.js --package-version=${npm_package_version} && git add app/build.gradle",
     "lint": "./gradlew lint",
@@ -29,7 +30,6 @@
     "settings"
   ],
   "files": [
-    "index.js",
     "lib",
     "build/lib",
     "apks",

package/index.js

@@ -1,9 +0,0 @@
-const path = require('node:path');
-const { SettingsApp } = require('./build/lib/client');
-const constants = require('./build/lib/constants');
-
-module.exports = {
-  path: path.resolve(__dirname, 'apks', 'settings_apk-debug.apk'),
-  SettingsApp,
-  ...constants,
-};