Struct EmulatorTools

pub struct EmulatorTools { /* private fields */ }

Implementations

impl EmulatorTools

pub fn new() -> Self

pub fn list_avds(&mut self, list_avds: bool) -> &mut Self

List available AVDs

pub fn sysdir(&mut self, sysdir: &Path) -> &mut Self

Search for system disk images in

pub fn system(&mut self, system: &Path) -> &mut Self

Read initial system image from

pub fn vendor(&mut self, vendor: &Path) -> &mut Self

Read initial vendor image from

pub fn writable_system(&mut self, writable_system: bool) -> &mut Self

Make system & vendor image writable after adb remount

pub fn delay_adb(&mut self, delay_adb: bool) -> &mut Self

Delay adb communication till boot completes

pub fn datadir(&mut self, datadir: &Path) -> &mut Self

Write user data into

pub fn kernel(&mut self, kernel: &Path) -> &mut Self

Use specific emulated kernel

pub fn ramdisk(&mut self, ramdisk: &Path) -> &mut Self

Ramdisk image (default /ramdisk.img)

pub fn image(&mut self, image: &Path) -> &mut Self

Obsolete, use -system instead

pub fn initdata(&mut self, initdata: &Path) -> &mut Self

Same as -init-data <file>

pub fn data(&mut self, data: &Path) -> &mut Self

Data image (default /userdata-qemu.img)

pub fn encryption_key(&mut self, encryption_key: &Path) -> &mut Self

Read initial encryption key image from

pub fn logcat_output(&mut self, logcat_output: &Path) -> &mut Self

Output file of logcat(default none)

pub fn partition_size(&mut self, partition_size: u32) -> &mut Self

System/data partition size in MBs

pub fn cache(&mut self, cache: &Path) -> &mut Self

Cache partition image (default is temporary file)

pub fn cache_size(&mut self, cache_size: u32) -> &mut Self

Cache partition size in MBs

pub fn no_cache(&mut self, no_cache: bool) -> &mut Self

Disable the cache partition

pub fn nocache(&mut self, nocache: bool) -> &mut Self

Same as -no-cache

pub fn sdcard(&mut self, sdcard: &Path) -> &mut Self

SD card image (default /sdcard.img)

pub fn quit_after_boot(&mut self, quit_after_boot: u32) -> &mut Self

Qeuit emulator after guest boots completely, or after timeout in seconds

pub fn qemu_top_dir(&mut self, qemu_top_dir: &Path) -> &mut Self

Use the emulator in the specified dir (relative or absolute path)v

pub fn monitor_adb(&mut self, monitor_adb: bool) -> &mut Self

Monitor the adb messages between guest and host, default not

pub fn snapstorage(&mut self, snapstorage: &Path) -> &mut Self

File that contains all state snapshots (default /snapshots.img)

pub fn no_snapstorage(&mut self, no_snapstorage: bool) -> &mut Self

Do not mount a snapshot storage file (this disables all snapshot functionality)

pub fn snapshot(&mut self, snapshot: String) -> &mut Self

Name of snapshot within storage file for auto-start and auto-save (default ‘default-boot’)

pub fn no_snapshot(&mut self, no_snapshot: bool) -> &mut Self

Perform a full boot and do not auto-save, but qemu vmload and vmsave operate on snapstorage

pub fn no_snapshot_save(&mut self, no_snapshot_save: bool) -> &mut Self

Do not auto-save to snapshot on exit: abandon changed state

pub fn no_snapshot_load(&mut self, no_snapshot_load: bool) -> &mut Self

Do not auto-start from snapshot: perform a full boot

pub fn snapshot_list(&mut self, snapshot_list: bool) -> &mut Self

Show a list of available snapshots

pub fn no_snapshot_update_time( &mut self, no_snapshot_update_time: bool, ) -> &mut Self

Do not try to correct snapshot time on restore

pub fn wipe_data(&mut self, wipe_data: bool) -> &mut Self

Reset the user data image (copy it from initdata)

pub fn avd(&mut self, avd: String) -> &mut Self

Use a specific android virtual device

pub fn avd_arch(&mut self, avd_arch: String) -> &mut Self

Use a specific target architecture

pub fn skindir(&mut self, skindir: &Path) -> &mut Self

Search skins in

(default /skins)

pub fn skin(&mut self, skin: String) -> &mut Self

Select a given skin

pub fn no_skin(&mut self, no_skin: bool) -> &mut Self

Deprecated: create an AVD with no skin instead

pub fn noskin(&mut self, noskin: bool) -> &mut Self

Same as -no-skin

pub fn memory(&mut self, memory: u32) -> &mut Self

Physical RAM size in MBs

pub fn ui_only(&mut self, ui_only: String) -> &mut Self

Run only the UI feature requested

pub fn id(&mut self, id: String) -> &mut Self

Assign an id to this virtual device (separate from the avd name)

pub fn cores(&mut self, cores: u32) -> &mut Self

Set number of CPU cores to emulator

pub fn accel(&mut self, accel: AccelMode) -> &mut Self

Configure emulation acceleration

pub fn no_accel(&mut self, no_accel: bool) -> &mut Self

Same as ‘-accel off’

pub fn ranchu(&mut self, ranchu: bool) -> &mut Self

Use new emulator backend instead of the classic one

pub fn engine(&mut self, engine: Engine) -> &mut Self

Select engine. auto|classic|qemu2

pub fn netspeed(&mut self, netspeed: Netspeed) -> &mut Self

Maximum network download/upload speeds

pub fn netdelay(&mut self, netdelay: String) -> &mut Self

Network latency emulation

pub fn netfast(&mut self, netfast: bool) -> &mut Self

Disable network shaping

pub fn code_profile(&mut self, code_profile: String) -> &mut Self

Enable code profiling

pub fn show_kernel(&mut self, show_kernel: bool) -> &mut Self

Display kernel messages

pub fn shell(&mut self, shell: bool) -> &mut Self

Enable root shell on current terminal

pub fn no_jni(&mut self, no_jni: bool) -> &mut Self

Deprecated, see dalvik_vm_checkjni

pub fn nojni(&mut self, nojni: bool) -> &mut Self

Deprecated, see dalvik_vm_checkjni

pub fn dalvik_vm_checkjni(&mut self, dalvik_vm_checkjni: bool) -> &mut Self

Enable dalvik.vm.checkjni

pub fn logcat(&mut self, logcat: String) -> &mut Self

Enable logcat output with given tags

pub fn no_audio(&mut self, no_audio: bool) -> &mut Self

Disable audio support

pub fn noaudio(&mut self, noaudio: bool) -> &mut Self

Same as -no-audio

pub fn audio(&mut self, audio: String) -> &mut Self

Use specific audio backend

pub fn radio(&mut self, radio: String) -> &mut Self

Redirect radio modem interface to character device

pub fn port(&mut self, port: String) -> &mut Self

TCP port that will be used for the console

pub fn ports(&mut self, ports: Vec<String>) -> &mut Self

TCP ports used for the console and adb bridge

pub fn onion(&mut self, onion: &Path) -> &mut Self

Use overlay PNG image over screen

pub fn onion_alph(&mut self, onion_alph: String) -> &mut Self

Specify onion-skin translucency

pub fn onion_rotation(&mut self, onion_rotation: String) -> &mut Self

specify onion-skin rotation

pub fn dpi_device(&mut self, dpi_device: String) -> &mut Self

Specify device’s resolution in dpi (default DEFAULT_DEVICE_DPI)

pub fn scale(&mut self, scale: String) -> &mut Self

Scale emulator window (deprecated)

pub fn wifi_client_port(&mut self, wifi_client_port: String) -> &mut Self

Connect to other emulator for WiFi forwarding

pub fn wifi_server_port(&mut self, wifi_server_port: String) -> &mut Self

Listen to other emulator for WiFi forwarding

pub fn http_proxy(&mut self, http_proxy: String) -> &mut Self

Make TCP connections through a HTTP/HTTPS proxy

pub fn timezone(&mut self, timezone: String) -> &mut Self

Use this timezone instead of the host’s default

pub fn change_language(&mut self, change_language: String) -> &mut Self

Use this language instead of the current one. Restarts the framework

pub fn change_country(&mut self, change_country: String) -> &mut Self

Use this country instead of the current one. Restarts the framework

pub fn change_locale(&mut self, change_locale: String) -> &mut Self

Use this locale instead of the current one. Restarts the framework

pub fn dns_server(&mut self, dns_server: String) -> &mut Self

Use this DNS server(s) in the emulated system

pub fn net_tap(&mut self, net_tap: String) -> &mut Self

Use this TAP interface for networking

pub fn net_tap_script_up(&mut self, net_tap_script_up: String) -> &mut Self

Script to run when the TAP interface goes up

pub fn net_tap_script_down(&mut self, net_tap_script_down: String) -> &mut Self

Script to run when the TAP interface goes down

pub fn cpu_delay(&mut self, cpu_delay: String) -> &mut Self

Throttle CPU emulation

pub fn no_boot_anim(&mut self, no_boot_anim: bool) -> &mut Self

Disable animation for faster boot

pub fn no_window(&mut self, no_window: bool) -> &mut Self

Disable graphical window display

pub fn qt_hide_window(&mut self, qt_hide_window: bool) -> &mut Self

Start QT window but hide window display

pub fn no_sim(&mut self, no_sim: bool) -> &mut Self

Device has no SIM card

pub fn lowram(&mut self, lowram: bool) -> &mut Self

Device is a low ram device

pub fn version(&mut self, version: bool) -> &mut Self

Display emulator version number

pub fn no_passive_gps(&mut self, no_passive_gps: bool) -> &mut Self

Disable passive gps updates

pub fn gnss_file_path(&mut self, gnss_file_path: &Path) -> &mut Self

Use the specified filepath to read gnss data

pub fn gnss_grpc_port(&mut self, gnss_grpc_port: String) -> &mut Self

Use the specified port number to start grpc service to receive gnss data

pub fn virtio_console(&mut self, virtio_console: bool) -> &mut Self

Using virtio console as console

pub fn read_only(&mut self, read_only: bool) -> &mut Self

Allow running multiple instances of emulators on the same AVD, but cannot save snapshot

pub fn is_restart(&mut self, is_restart: String) -> &mut Self

Specifies that this emulator was a restart, and to wait out before proceeding

pub fn report_console(&mut self, report_console: String) -> &mut Self

Report console port to remote socket

pub fn gps(&mut self, gps: String) -> &mut Self

Redirect NMEA GPS to character device

pub fn shell_serial(&mut self, shell_serial: String) -> &mut Self

Specific character device for root shell

pub fn tcpdump(&mut self, tcpdump: &Path) -> &mut Self

Capture network packets to file

pub fn bootchart(&mut self, bootchart: String) -> &mut Self

Enable bootcharting

pub fn charmap(&mut self, charmap: &Path) -> &mut Self

Use specific key character map

pub fn studio_params(&mut self, studio_params: &Path) -> &mut Self

Used by Android Studio to provide parameters

pub fn prop(&mut self, prop: String) -> &mut Self

Set system property on boot

pub fn shared_net_id(&mut self, shared_net_id: String) -> &mut Self

Join the shared network, using IP address 10.1.2.

pub fn gpu(&mut self, gpu: String) -> &mut Self

Set hardware OpenGLES emulation mode

pub fn use_host_vulkan(&mut self, use_host_vulkan: bool) -> &mut Self

Use host for vulkan emulation regardless of ‘gpu’ mode

pub fn camera_back(&mut self, camera_back: CameraMode) -> &mut Self

Set emulation mode for a camera facing back

pub fn camera_front(&mut self, camera_front: CameraMode) -> &mut Self

Set emulation mode for a camera facing front

pub fn webcam_list(&mut self, webcam_list: bool) -> &mut Self

Lists web cameras available for emulation

pub fn virtualscene_poster(&mut self, virtualscene_poster: String) -> &mut Self

Load a png or jpeg image as a poster in the virtual scene

pub fn screen(&mut self, screen: ScreenMode) -> &mut Self

Set emulated screen mode

pub fn force_32bit(&mut self, force_32bit: bool) -> &mut Self

Always use 32-bit emulator

pub fn selinux(&mut self, selinux: SELinux) -> &mut Self

Set SELinux to either disabled or permissive mode

pub fn unix_pipe(&mut self, unix_pipe: &Path) -> &mut Self

Add to the list of allowed Unix pipes

pub fn fixed_scale(&mut self, fixed_scale: bool) -> &mut Self

Use fixed 1:1 scale for the initial emulator window

pub fn wait_for_debugger(&mut self, wait_for_debugger: bool) -> &mut Self

Pause on launch and wait for a debugger process to attach before resuming

pub fn skip_adb_auth(&mut self, skip_adb_auth: bool) -> &mut Self

Skip adb authentication dialogue

pub fn metrics_to_console(&mut self, metrics_to_console: bool) -> &mut Self

Enable usage metrics and print the messages to stdout

pub fn metrics_collection(&mut self, metrics_collection: bool) -> &mut Self

Enable usage metrics and send them to google play

pub fn metrics_to_file(&mut self, metrics_to_file: &Path) -> &mut Self

Enable usage metrics and write the messages into specified file

pub fn detect_image_hang(&mut self, detect_image_hang: bool) -> &mut Self

Enable the detection of system image hangs

pub fn feature(&mut self, feature: String) -> &mut Self

Force-enable or disable (-name) the features

pub fn icc_profile(&mut self, icc_profile: &Path) -> &mut Self

Use icc profile from specified file

pub fn sim_access_rules_file( &mut self, sim_access_rules_file: &Path, ) -> &mut Self

Use SIM access rules from specified file

pub fn phone_number(&mut self, phone_number: String) -> &mut Self

Sets the phone number of the emulated device

pub fn acpi_config(&mut self, acpi_config: &Path) -> &mut Self

Specify acpi device proprerties (hierarchical key=value pair)

pub fn fuchsia(&mut self, fuchsia: bool) -> &mut Self

Run Fuchsia image. Bypasses android-specific setup; args after are treated as standard QEMU args

pub fn window_size(&mut self, window_size: String) -> &mut Self

Set window size for when bypassing android-specific setup

pub fn allow_host_audio(&mut self, allow_host_audio: bool) -> &mut Self

Allows sending of audio from audio input devices. Otherwise, zeroes out audio

pub fn restart_when_stalled(&mut self, restart_when_stalled: bool) -> &mut Self

Allows restarting guest when it is stalled

pub fn perf_stat(&mut self, perf_stat: &Path) -> &mut Self

Run periodic perf stat reporter in the background and write output to specified file

pub fn share_vid(&mut self, share_vid: bool) -> &mut Self

Share current video state in shared memory region

pub fn grpc(&mut self, grpc: String) -> &mut Self

TCP ports used for the gRPC bridge

pub fn grpc_tls_key(&mut self, grpc_tls_key: &Path) -> &mut Self

File with the private key used to enable gRPC TLS

pub fn grpc_tls_cer(&mut self, grpc_tls_cer: &Path) -> &mut Self

File with the public X509 certificate used to enable gRPC TLS

pub fn grpc_tls_ca(&mut self, grpc_tls_ca: &Path) -> &mut Self

File with the Certificate Authorities used to validate client certificates

pub fn grpc_use_token(&mut self, grpc_use_token: bool) -> &mut Self

Use the emulator console token for gRPC authentication

pub fn idle_grpc_timeout(&mut self, idle_grpc_timeout: u32) -> &mut Self

Terminate the emulator if there is no gRPC activity within seconds

pub fn waterfall(&mut self, waterfall: String) -> &mut Self

Mode in which to run waterfall

pub fn multidisplay(&mut self, multidisplay: String) -> &mut Self

Config multiple displays

pub fn google_maps_key(&mut self, google_maps_key: String) -> &mut Self

API key to use with the Google Maps GUI

pub fn no_location_ui(&mut self, no_location_ui: bool) -> &mut Self

Disable the location UI in the extended window

pub fn use_keycode_forwarding( &mut self, use_keycode_forwarding: bool, ) -> &mut Self

Use keycode forwarding instead of host charmap translation

pub fn record_session(&mut self, record_session: &Path) -> &mut Self

Screen record the emulator session

pub fn legacy_fake_camera(&mut self, legacy_fake_camera: bool) -> &mut Self

Use legacy camera HAL for the emulated fake camera

pub fn no_camera_hq_edge(&mut self, no_camera_hq_edge: bool) -> &mut Self

Disable high qualify edge processing for emulated camera

pub fn no_direct_adb(&mut self, no_direct_adb: bool) -> &mut Self

Use external adb executable for internal communication

pub fn check_snapshot_loadable( &mut self, check_snapshot_loadable: String, ) -> &mut Self

Check if a snasphot is loadable

pub fn no_hidpi_scaling(&mut self, no_hidpi_scaling: bool) -> &mut Self

Disable HiDPI scaling of guest display on macOS devices

pub fn no_mouse_reposition(&mut self, no_mouse_reposition: bool) -> &mut Self

Do not reposition the mouse to emulator window center if mouse pointer gets out of the window

pub fn guest_angle(&mut self, guest_angle: bool) -> &mut Self

Enable guest ANGLE as system driver

pub fn qemu(&mut self, qemu: bool) -> &mut Self

Pass arguments to qemu

pub fn verbose(&mut self, verbose: bool) -> &mut Self

Same as ‘-debug-init’

pub fn debug(&mut self, debug: DebugTags) -> &mut Self

Enable/disable debug messages

pub fn debug_no(&mut self, debug_no: DebugTags) -> &mut Self

pub fn help(&mut self, help: bool) -> &mut Self

Print this help

pub fn help_disk_images(&mut self, help_disk_images: bool) -> &mut Self

About disk images

pub fn help_debug_tags(&mut self, help_debug_tags: bool) -> &mut Self

Debug tags for -debug

pub fn help_char_devices(&mut self, help_char_devices: bool) -> &mut Self

Character specification

pub fn help_environment(&mut self, help_environment: bool) -> &mut Self

Environment variables

pub fn help_virtual_device(&mut self, help_virtual_device: bool) -> &mut Self

Virtual device management

pub fn help_sdk_images(&mut self, help_sdk_images: bool) -> &mut Self

About disk images when using the SDK

pub fn help_build_images(&mut self, help_build_images: bool) -> &mut Self

About disk images when building Android

pub fn help_all(&mut self, help_all: bool) -> &mut Self

Prints all help content

pub fn run(&self) -> Result<()>

Runs emulator commands and initialize emulator

Trait Implementations

impl Clone for EmulatorTools

fn clone(&self) -> EmulatorTools

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for EmulatorTools

fn default() -> EmulatorTools

Returns the “default value” for a type.