appium-android-driver 9.15.0 → 10.0.0

package/lib/commands/streamscreen.js

@@ -35,24 +35,48 @@ const ADB_SCREEN_STREAMING_FEATURE = 'adb_screen_streaming';
 
 /**
  * @this {import('../driver').AndroidDriver}
- * @param {import('./types').StartScreenStreamingOpts} [options={}]
+ * @param {number} [width] The scaled width of the device's screen.
+ * If unset then the script will assign it to the actual screen width measured
+ * in pixels.
+ * @param {number} [height] The scaled height of the device's screen.
+ * If unset then the script will assign it to the actual screen height
+ * measured in pixels.
+ * @param {number} [bitRate=4000000] The video bit rate for the video, in bits per second.
+ * The default value is 4 Mb/s. You can increase the bit rate to improve video
+ * quality, but doing so results in larger movie files.
+ * @param {string} [host='127.0.0.1'] The IP address/host name to start the MJPEG server on.
+ * You can set it to `0.0.0.0` to trigger the broadcast on all available
+ * network interfaces.
+ * @param {number} [port=8093] The port number to start the MJPEG server on.
+ * @param {number} [tcpPort=8094] The port number to start the internal TCP MJPEG broadcast on.
+ * @param {string} [pathname] The HTTP request path the MJPEG server should be available on.
+ * If unset, then any pathname on the given `host`/`port` combination will
+ * work. Note that the value should always start with a single slash: `/`
+ * @param {number} [quality=70] The quality value for the streamed JPEG images.
+ * This number should be in range `[1,100]`, where `100` is the best quality.
+ * @param {boolean} [considerRotation=false] If set to `true` then GStreamer pipeline will increase the dimensions of
+ * the resulting images to properly fit images in both landscape and portrait
+ * orientations.
+ * Set it to `true` if the device rotation is not going to be the same during
+ * the broadcasting session.
+ * @param {boolean} [logPipelineDetails=false] Whether to log GStreamer pipeline events into the standard log output.
+ * Might be useful for debugging purposes.
  * @returns {Promise<void>}
- */
-export async function mobileStartScreenStreaming(options = {}) {
+*/
+export async function mobileStartScreenStreaming(
+  width,
+  height,
+  bitRate,
+  host = DEFAULT_HOST,
+  port = DEFAULT_PORT,
+  pathname,
+  tcpPort = DEFAULT_PORT + 1,
+  quality = DEFAULT_QUALITY,
+  considerRotation = false,
+  logPipelineDetails = false,
+) {
   this.assertFeatureEnabled(ADB_SCREEN_STREAMING_FEATURE);
 
-  const {
-    width,
-    height,
-    bitRate,
-    host = DEFAULT_HOST,
-    port = DEFAULT_PORT,
-    pathname,
-    tcpPort = DEFAULT_PORT + 1,
-    quality = DEFAULT_QUALITY,
-    considerRotation = false,
-    logPipelineDetails = false,
-  } = options;
   if (_.isUndefined(this._screenStreamingProps)) {
     await verifyStreamingRequirements(this.adb);
   }

package/lib/commands/system-bars.js

@@ -1,8 +1,5 @@
-// @ts-check
-
 import {errors} from 'appium/driver';
 import _ from 'lodash';
-import {requireArgs} from '../utils';
 
 const WINDOW_TITLE_PATTERN = /^\s+Window\s#\d+\sWindow\{[0-9a-f]+\s\w+\s([\w-]+)\}:$/;
 const FRAME_PATTERN = /\bm?[Ff]rame=\[([0-9.-]+),([0-9.-]+)\]\[([0-9.-]+),([0-9.-]+)\]/;
@@ -38,12 +35,14 @@ export async function getSystemBars() {
 
 /**
  * @this {import('../driver').AndroidDriver}
- * @param {import('./types').StatusBarCommandOpts} opts
+ * @param {import('./types').StatusBarCommand} command Each list
+ * item must separated with a new line (`\n`) character.
+ * @param {string} [component] The name of the tile component.
+ * It is only required for `(add|remove|click)Tile` commands.
+ * Example value: `com.package.name/.service.QuickSettingsTileComponent`
  * @returns {Promise<string>}
  */
-export async function mobilePerformStatusBarCommand(opts) {
-  const {command} = requireArgs('command', opts);
-
+export async function mobilePerformStatusBarCommand(command, component) {
   /**
    *
    * @param {string} cmd
@@ -57,8 +56,7 @@ export async function mobilePerformStatusBarCommand(opts) {
       cmd,
       ...(argsCallable ? _.castArray(argsCallable()) : []),
     ]);
-  const tileCommandArgsCallable = () =>
-    /** @type {string} */ (requireArgs('component', opts).component);
+  const tileCommandArgsCallable = () => /** @type {string} */ (component);
   const statusBarCommands = _.fromPairs(
     /** @type {const} */ ([
       ['expandNotifications', ['expand-notifications']],

package/lib/commands/time.js

@@ -24,11 +24,11 @@ export async function getDeviceTime(format = MOMENT_FORMAT_ISO8601) {
 
 /**
  * @this {AndroidDriver}
- * @param {import('./types').DeviceTimeOpts} [opts={}]
+ * @param {string} [format='YYYY-MM-DDTHH:mm:ssZ']
  * @returns {Promise<string>}
  */
-export async function mobileGetDeviceTime(opts = {}) {
-  return await this.getDeviceTime(opts.format);
+export async function mobileGetDeviceTime(format) {
+  return await this.getDeviceTime(format);
 }
 
 /**