io.appium.settings/lib/commands/animation.ts

App for dealing with Android settings

import type { SettingsApp } from '../client';

/**
 * Change the state of animation on the device under test via adb settings command for API level 26+.
 * Animation on the device is controlled by the following global properties:
 * [ANIMATOR_DURATION_SCALE]{@link https://developer.android.com/reference/android/provider/Settings.Global.html#ANIMATOR_DURATION_SCALE},
 * [TRANSITION_ANIMATION_SCALE]{@link https://developer.android.com/reference/android/provider/Settings.Global.html#TRANSITION_ANIMATION_SCALE},
 * [WINDOW_ANIMATION_SCALE]{@link https://developer.android.com/reference/android/provider/Settings.Global.html#WINDOW_ANIMATION_SCALE}.
 * This method sets all this properties to 0.0 to disable (1.0 to enable) animation.
 *
 * Turning off animation might be useful to improve stability
 * and reduce tests execution time.
 *
 * @param on - True to enable and false to disable it
 */
export async function setAnimationState(this: SettingsApp, on: boolean): Promise<void> {
  await this.adb.setAnimationScale(Number(on));
}