package android.emulation.control.incubating

Get desktop application:
View/edit binary Protocol Buffers messages

The AvdService can be used to inspect and retrieve general information about the running avd

• rpc getAvdInfo (google.protobuf.Empty, AvdInfo)

  avd_service.proto:36

  Get general information about the running avd.

  message AvdInfo

  avd_service.proto:58

  • bool in_android_build = 1

    for the Android build system case

  • string android_out = 2

  • string android_build_root = 3

  • string target_arch = 4

  • string target_abi = 5

  • string acpi_ini_path = 6

  • string target = 7

    The target string in rootIni.

  • string device_name = 8

    for the normal virtual device case

  • string device_id = 9

  • string sdk_root_path = 10

  • repeated string search_paths = 11

  • string content_path = 12

  • string root_ini_path = 13

    These two might not be needed.

    UNUSED?

  • map<string, string> root_ini = 14

    UNUSED?

  • map<string, string> config_ini = 15

    virtual device's config.ini, NULL if missing

  • map<string, string> skin_hardware_ini = 16

    skin-specific hardware.ini

  • int32 api_level = 17

    for both

  • int32 incremental_version = 18

  • bool is_marshmallow_or_higher = 19

    For preview releases where we don't know the exact API level this flag indicates that at least we know it's M+ (for some code that needs to select either legacy or modern operation mode.

  • bool is_google_apis = 20

  • bool is_user_build = 21

  • bool is_atd = 22

  • AvdFlavor flavor = 23

  • string skin_name = 24

    skin name

  • string skin_dir_path = 25

    skin directory

  • string core_hardware_ini_path = 26

    core hardware.ini path

  • string snapshot_lock_path = 27

    core snapshot.lock path

  • string multi_instance_lock_path = 28

  • string build_properties = 29

    build.prop file

  • string boot_properties = 30

    boot.prop file

  • repeated string image_paths = 31

    image files

  • repeated ImageState image_states = 32

  • bool no_checks = 33

    skip checks

  • string sysdir = 34

A car service is a service that forwards events to and from the android car hal

• rpc receiveCarEvents (google.protobuf.Empty, stream CarEvent)

  car_service.proto:37

  Listen for events in the service as they arive.

• rpc sendCarEvent (CarEvent, google.protobuf.Empty)

  car_service.proto:40

  Send an event to the car hal

• rpc sendCarEvents (stream CarEvent, google.protobuf.Empty)

  car_service.proto:43

  Send a series of events directly to the car hal.

A Modem service allows you to interact with the emulated modem. The emulated modem can be used to receive sms, phone calls, and to modify the cellular information. This service is supported for API > 31

• rpc createCall (Call, Call)

  modem_service.proto:49

  Creates a new call object, this usually results in the emulator receiving a new incoming call.

• rpc deleteCall (Call, google.protobuf.Empty)

  modem_service.proto:57

  Removes the active call, this will disconnect the call.

• rpc getCellInfo (google.protobuf.Empty, CellInfo)

  modem_service.proto:45

  Gets the current cell info. Note: this is not fully implemented yet.

• rpc listCalls (google.protobuf.Empty, ActiveCalls)

  modem_service.proto:60

  Lists all the calls that are currently active in the modem

• rpc receivePhoneEvents (google.protobuf.Empty, stream PhoneEvent)

  modem_service.proto:76

  Listen for events in the service as they arive.

  message PhoneEvent

  modem_service.proto:211

  • PhoneEvent.PhoneEventType type = 1

    Type of event that was received.

  • oneof event

    • ActiveCalls active = 2

      List of active calls.

• rpc receiveSms (SmsMessage, google.protobuf.Empty)

  modem_service.proto:70

  The emulator will receive an sms message. Returns: - INVALID_ARGUMENT: The text message was longer than 1024 characters - INVALID_ARGUMENT: The phone number provided was invalid. - INVALID_ARGUMENT: The text message contains invalid characters - INVALID_ARGUMENT: The encoded message contains invalid hex values - INVALID_ARGUMENT: Trying to receive both text and encoded message.

  message SmsMessage

  modem_service.proto:228

  • string number = 1

    The source number where this message came from. The adnumberdress should be a valid GSM-formatted address as specified by 3GPP 23.040 Sec 9.1.2.5. For example: +3106225412 or (650) 555-1221

  • oneof message

    • string text = 2

      A utf8 encoded text message of at most 1024 characters. You can use the following special symbols: \n for a newline \xNN where NN are two hexadecimal numbers \uNNNN where NNNN are four hexadecimal numbers \\ to send a '\' character"

    • string encodedMessage = 3

      A PDU encoded message as a hex string. See the spec: https://www.etsi.org/deliver/etsi_gts/07/0705/05.01.00_60/gsmts_0705v050100p.pdf for details on how to use this.

• rpc setCellInfo (CellInfo, CellInfo)

  modem_service.proto:41

  Set the current cell info, returning the active cell info state.

• rpc updateCall (Call, Call)

  modem_service.proto:53

  Updates the state of the given call. The unique number indentifying the call must exist.

• rpc updateClock (google.protobuf.Empty, google.protobuf.Empty)

  modem_service.proto:73

  Update the modem clock. This will likely disappear

• rpc ListRecordings (RecordingInfo, RecordingInfoList)

  screen_recording_service.proto:38

  message RecordingInfoList

  screen_recording_service.proto:83

  • repeated RecordingInfo recordings = 1

• rpc ReceiveRecordingEvents (google.protobuf.Empty, stream RecordingInfo)

  screen_recording_service.proto:40

• rpc StartRecording (RecordingInfo, RecordingInfo)

  screen_recording_service.proto:34

• rpc StopRecording (RecordingInfo, RecordingInfo)

  screen_recording_service.proto:36

This service is responsible for interacting with the sensor module of the emulator. It provides methods to set, get, and stream sensor data as well as the physical model.

• rpc getPhysicalModel (PhysicalModelValue, PhysicalModelValue)

  sensor_service.proto:55

• rpc getSensor (SensorValue, SensorValue)

  sensor_service.proto:37

  gets the sensor value.

• rpc receivePhysicalModelEvents (PhysicalModelValue, stream PhysicalModelValue)

  sensor_service.proto:59

  Receive a message whenever the physical model value subscribed to changes Note that you can receive spurious events. (i.e the same event 2x)

• rpc receivePhysicalStateEvents (google.protobuf.Empty, stream PhysicalStateEvent)

  sensor_service.proto:62

  message PhysicalStateEvent

  sensor_service.proto:66

  • PhysicalStateEvent.StateEvent event = 1

• rpc receiveSensorEvents (SensorValue, stream SensorValue)

  sensor_service.proto:46

  Receive a message whenever the sensor value subscribed to changes Note that you can receive spurious events. (i.e the same event 2x)

• rpc setPhysicalModel (PhysicalModelValue, google.protobuf.Empty)

  sensor_service.proto:54

  sets the value. The value will eventually be set, an immediate get might not read the value that has just been set. This can result in an event if it changes an existing physical value.

• rpc setSensor (SensorValue, google.protobuf.Empty)

  sensor_service.proto:42

  sets the value. The value will eventually be set, an immediate get might not read the value that has just been set. This can result in an event if it changes an existing sensor value.

• rpc getAnimationState (google.protobuf.Empty, AnimationState)

  virtual_scene_service.proto:61

  * Get the current animation state of the virtual scene. @param Empty request. @return The current animation state, including whether the TV is on or off.

• rpc listPosters (google.protobuf.Empty, PosterList)

  virtual_scene_service.proto:47

  * List all the posters currently set in the virtual scene. @param Empty request. @return The list of posters with their respective details.

  message PosterList

  virtual_scene_service.proto:87

  • repeated Poster posters = 1

• rpc setAnimationState (AnimationState, AnimationState)

  virtual_scene_service.proto:54

  * Set the animation state of the virtual scene. @param The new animation state, such as turning the TV on or off. @return The updated animation state.

• rpc setPoster (Poster, Poster)

  virtual_scene_service.proto:40

  * Set the poster for a specific position in the virtual scene. @param The poster details including name, image, filename, width, and scale. @return The updated poster details.

Used as response type in: Modem.listCalls

Used as field type in: PhoneEvent

• repeated Call calls = 1

Used as request type in: VirtualSceneService.setAnimationState

Used as response type in: VirtualSceneService.getAnimationState, VirtualSceneService.setAnimationState

• bool tvOn = 1

Used in: AvdInfo

• AVD_FLAVOR_UNSPECIFIED = 0

• AVD_FLAVOR_PHONE = 1

• AVD_FLAVOR_TV = 2

• AVD_FLAVOR_WEAR = 3

• AVD_FLAVOR_ANDROID_AUTO = 4

• AVD_FLAVOR_DESKTOP = 5

• AVD_FLAVOR_OTHER = 255

A voice call that can be made

Used as request type in: Modem.createCall, Modem.deleteCall, Modem.updateCall

Used as response type in: Modem.createCall, Modem.updateCall

Used as field type in: ActiveCalls

• Call.CallDirection direction = 1

  [Output only]

• Call.CallState state = 2

• string number = 3

  The number should be a valid GSM-formatted address as specified by 3GPP 23.040 Sec 9.1.2.5. Note that this number uniquely identifies this call.

Used in: Call

• CALL_DIRECTION_UNSPECIFIED = 0

• CALL_DIRECTION_OUTBOUND = 1

• CALL_DIRECTION_INBOUND = 2

Used in: Call

• CALL_STATE_UNSPECIFIED = 0

• CALL_STATE_ACTIVE = 1

• CALL_STATE_HELD = 2

• CALL_STATE_DIALING = 3

• CALL_STATE_ALERTING = 4

• CALL_STATE_INCOMING = 5

• CALL_STATE_WAITING = 6

• CallResult.CallStatus status = 1

Used in: CallResult

• CALL_RESULT_OK = 0

• CALL_RESULT_NUMBER_NOT_FOUND = 1

• CALL_RESULT_EXCEED_MAX_NUM = 2

• CALL_RESULT_RADIO_OFF = 3

Used as request type in: CarService.sendCarEvent, CarService.sendCarEvents

Used as response type in: CarService.receiveCarEvents

• string data = 1

CellIdentity represents the identity of a unique cell.

Used in: CellInfo

• optional google.protobuf.StringValue operatorAlphaLong = 1

  The long alpha tag associated with the current scan result (may be the operator name string or extended operator name string). May be empty (not set) if unknown.

• optional google.protobuf.StringValue operatorAlphaShort = 2

  The short alpha tag associated with the current scan result (may be the operator name string or extended operator name string). May be empty (not set) if unknown.

Used as request type in: Modem.setCellInfo

Used as response type in: Modem.getCellInfo, Modem.setCellInfo

• CellInfo.CellStandard cell_standard = 1

  The connection status of this cell. [INPUT ONLY]: Currently unable to read the active cell standard.

• optional CellIdentity cell_identity = 2

  The identity of this cell.

• CellInfo.CellStatus cell_status_voice = 3

  Voice status

• CellInfo.CellStatus cell_status_data = 4

  Data status

• optional CellSignalStrength cell_signal_strength = 5

  The signal strength of this cell [INPUT ONLY]: Currently unable to read the signal strength.

• CellInfo.CellMeterStatus cell_meter_status = 6

  Metering status

• CellInfo.CellSimStatus sim_status = 7

  Status of the sim

Used in: CellInfo

• CELL_METER_STATUS_UNKNOWN = 0

• CELL_METER_STATUS_METERED = 1

• CELL_METER_STATUS_TEMPORARILY_NOT_METERED = 2

Used in: CellInfo

• CELL_SIM_STATUS_UNKNOWN = 0

• CELL_SIM_STATUS_NOT_PRESENT = 1

• CELL_SIM_STATUS_PRESENT = 2

Used in: CellInfo

• CELL_STANDARD_UNKNOWN = 0

• CELL_STANDARD_GSM = 1

• CELL_STANDARD_HSCSD = 2

• CELL_STANDARD_GPRS = 3

• CELL_STANDARD_EDGE = 4

• CELL_STANDARD_UMTS = 5

• CELL_STANDARD_HSDPA = 6

• CELL_STANDARD_LTE = 7

• CELL_STANDARD_FULL = 8

• CELL_STANDARD_5G = 9

Used in: CellInfo

• CELL_STATUS_UNKNOWN = 0

• CELL_STATUS_HOME = 1

• CELL_STATUS_ROAMING = 2

• CELL_STATUS_SEARCHING = 3

• CELL_STATUS_DENIED = 4

• CELL_STATUS_UNREGISTERED = 5

Used in: CellInfo

• oneof message

  • int32 rssi = 2

    The rssi of the signal. (Must be between 0-31)

  • CellSignalStrength.CellSignalLevel level = 3

    The abstract level value for the overall signal quality.

Represents the general signal quality.

Used in: CellSignalStrength

• SIGNAL_STRENGTH_NONE_OR_UNKNOWN = 0

• SIGNAL_STRENGTH_POOR = 1

• SIGNAL_STRENGTH_MODERATE = 2

• SIGNAL_STRENGTH_GOOD = 3

• SIGNAL_STRENGTH_GREAT = 4

Used in: AvdInfo

• IMAGE_STATE_UNSPECIFIED = 0

• IMAGE_STATE_READONLY = 1

  unlocked

• IMAGE_STATE_MUSTLOCK = 2

  must be locked

• IMAGE_STATE_LOCKED = 3

  locked

• IMAGE_STATE_LOCKED_EMPTY = 4

  locked and empty

• IMAGE_STATE_TEMPORARY = 5

  copied to temp file (no lock needed)

Used in: PhysicalModelValue, SensorValue

• repeated float data = 1

Used in: PhoneEvent

• PHONE_EVENT_TYPE_UNKNOWN = 0

• PHONE_EVENT_TYPE_ACTIVE = 1

Used as request type in: SensorService.getPhysicalModel, SensorService.receivePhysicalModelEvents, SensorService.setPhysicalModel

Used as response type in: SensorService.getPhysicalModel, SensorService.receivePhysicalModelEvents

• PhysicalModelValue.PhysicalType target = 1

• PhysicalModelValue.PhysicalState status = 2

  [Output Only]

• optional ParameterValue value = 3

  Value interpretation depends on sensor.

• PhysicalModelValue.Interpolation interpolation = 4

• PhysicalModelValue.ParameterValueType value_type = 5

Used in: PhysicalModelValue

• INTERPOLATION_UNSPECIFIED = 0

• INTERPOLATION_SMOOTH = 1

• INTERPOLATION_STEP = 2

Used in: PhysicalModelValue

• PARAMETER_VALUE_TYPE_UNSPECIFIED = 0

• PARAMETER_VALUE_TYPE_TARGET = 1

• PARAMETER_VALUE_TYPE_CURRENT = 2

• PARAMETER_VALUE_TYPE_CURRENT_NO_AMBIENT_MOTION = 3

• PARAMETER_VALUE_TYPE_DEFAULT = 4

Used in: PhysicalModelValue

• PHYSICAL_STATE_UNSPECIFIED = 0

• PHYSICAL_STATE_VALUE_OK = 1

• PHYSICAL_STATE_UNKNOWN = 2

  Unknown sensor (should not happen)

• PHYSICAL_STATE_VALUE_NO_SERVICE = 3

  qemud service is not available/initiated.

Details on the sensors documentation can be found here: https://developer.android.com/reference/android/hardware/Sensor.html#TYPE_ The types must follow the order defined in "external/qemu/android/hw-sensors.h"

Used in: PhysicalModelValue

• PHYSICAL_TYPE_UNSPECIFIED = 0

  Indicates all in case of events.

• PHYSICAL_TYPE_POSITION = 1

• PHYSICAL_TYPE_ROTATION = 2

  All values are angles in degrees. values = [x,y,z]

• PHYSICAL_TYPE_MAGNETIC_FIELD = 3

• PHYSICAL_TYPE_TEMPERATURE = 4

  Temperature in °C

• PHYSICAL_TYPE_PROXIMITY = 5

  Proximity sensor distance measured in centimeters

• PHYSICAL_TYPE_LIGHT = 6

  Ambient light level in SI lux units

• PHYSICAL_TYPE_PRESSURE = 7

  Atmospheric pressure in hPa (millibar)

• PHYSICAL_TYPE_HUMIDITY = 8

  Relative ambient air humidity in percent

• PHYSICAL_TYPE_VELOCITY = 9

• PHYSICAL_TYPE_AMBIENT_MOTION = 10

• PHYSICAL_TYPE_HINGE_ANGLE0 = 11

  Describing a hinge angle sensor in degrees.

• PHYSICAL_TYPE_HINGE_ANGLE1 = 12

• PHYSICAL_TYPE_HINGE_ANGLE2 = 13

• PHYSICAL_TYPE_ROLLABLE0 = 14

• PHYSICAL_TYPE_ROLLABLE1 = 15

• PHYSICAL_TYPE_ROLLABLE2 = 16

• PHYSICAL_TYPE_POSTURE = 17

  Describing the device posture; the value should be an enum defined in Posture::PostureValue.

• PHYSICAL_TYPE_HEART_RATE = 18

  Heart rate in bpm

• PHYSICAL_TYPE_RGBC_LIGHT = 19

  Ambient RGBC light intensity. Values are in order (Red, Green, Blue, Clear).

• PHYSICAL_TYPE_WRIST_TILT = 20

  Wrist tilt gesture (1 = gaze, 0 = ungaze)

Used in: PhysicalStateEvent

• STATE_EVENT_UNDEFINED = 0

• STATE_TARGET_STATE_CHANGED = 1

• STATE_PHYSICAL_STATE_CHANGING = 2

• STATE_PHYSICAL_STATE_STABILIZED = 3

Used as request type in: VirtualSceneService.setPoster

Used as response type in: VirtualSceneService.setPoster

Used as field type in: PosterList

• string name = 1

  Name of the poster position, such as "wall" or "table".

• optional google.protobuf.BytesValue image = 2

  The image bytes either PNG or JPEG, or none if no new image is being loaded.

• optional google.protobuf.StringValue file_name = 3

  Optional filename.

• float minWidth = 4

  The poster position's minimum width, in meters.

• float maxWidth = 5

  The poster position's maximum width, in meters.

• float scale = 6

  The poster scale, a value between 0 and 1.

Used as request type in: ScreenRecording.ListRecordings, ScreenRecording.StartRecording, ScreenRecording.StopRecording

Used as response type in: ScreenRecording.ReceiveRecordingEvents, ScreenRecording.StartRecording, ScreenRecording.StopRecording

Used as field type in: RecordingInfoList

• RecordingInfo.RecorderState state = 1

  The current state of the recorder

• string file_name = 2

  The file_name where the recording should be written to Note: This currently needs to have the .webm extension

• uint32 width = 3

  Width of the recording, or default if not present

• uint32 height = 4

  Height of the recording, or default if not present

• uint32 bit_rate = 5

  Bit rate of the recording in bits per second, or default if not present. The bit rate should be between 100,000 - 25,000,000

• uint32 time_limit = 6

  The time limit in seconds. Defaults to 180 seconds.

• uint32 fps = 7

  The desired frame rate. Defaults to 24.

• uint32 display = 8

  The (desired) display id of the device. Setting this to 0 (or omitting) indicates the main display.

Used in: RecordingInfo

• RECORDER_STATE_UNKOWN = 0

• RECORDER_STATE_STARTING = 1

• RECORDER_STATE_START_FAILED = 2

• RECORDER_STATE_RECORDING = 4

• RECORDER_STATE_STOPPING = 5

• RECORDER_STATE_STOPPED = 6

• RECORDER_STOP_FAILED = 7

A single sensor value.

Used as request type in: SensorService.getSensor, SensorService.receiveSensorEvents, SensorService.setSensor

Used as response type in: SensorService.getSensor, SensorService.receiveSensorEvents

• SensorValue.SensorType target = 1

  Type of sensor

• SensorValue.SensorState status = 2

  [Output Only]

• optional ParameterValue value = 3

  Value interpretation depends on sensor enum.

Used in: SensorValue

• SENSOR_STATE_UNDEFINED = 0

• SENSOR_STATE_OK = 1

• SENSOR_STATE_UNKNOWN = 2

  Unknown sensor (should not happen)

• SENSOR_STATE_DISABLED = 3

  Sensor is disabled.

• SENSOR_STATE_NO_SERVICE = 4

  qemud service is not available/initiated.

These are the various sensors that can be available in an emulated devices.

Used in: SensorValue

• SENSOR_SENSOR_TYPE_UNSPECIFIED = 0

• SENSOR_SENSOR_TYPE_ACCELERATION = 1

  Measures the acceleration force in m/s2 that is applied to a device on all three physical axes (x, y, and z), including the force of gravity.

• SENSOR_SENSOR_TYPE_GYROSCOPE = 2

  Measures a device's rate of rotation in rad/s around each of the three physical axes (x, y, and z).

• SENSOR_SENSOR_TYPE_MAGNETIC_FIELD = 3

  Measures the ambient geomagnetic field for all three physical axes (x, y, z) in μT.

• SENSOR_SENSOR_TYPE_ORIENTATION = 4

  Measures degrees of rotation that a device makes around all three physical axes (x, y, z)

• SENSOR_SENSOR_TYPE_TEMPERATURE = 5

  Measures the temperature of the device in degrees Celsius (°C).

• SENSOR_SENSOR_TYPE_PROXIMITY = 6

  Measures the proximity of an object in cm relative to the view screen of a device. This sensor is typically used to determine whether a handset is being held up to a person's ear.

• SENSOR_SENSOR_TYPE_LIGHT = 7

  Measures the ambient light level (illumination) in lx.

• SENSOR_SENSOR_TYPE_PRESSURE = 8

  Measures the ambient air pressure in hPa or mbar.

• SENSOR_SENSOR_TYPE_HUMIDITY = 9

  Measures the relative ambient humidity in percent (%).

• SENSOR_SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED = 10

• SENSOR_SENSOR_TYPE_GYROSCOPE_UNCALIBRATED = 11

• SENSOR_SENSOR_TYPE_HEART_RATE = 15

  Measures the heart rate in bpm.

• SENSOR_SENSOR_TYPE_RGBC_LIGHT = 16

  Measures the ambient RGBC light intensity. Values are in order (Red, Green, Blue, Clear).

• SENSOR_SENSOR_TYPE_ACCELERATION_UNCALIBRATED = 18

  WIRST_TILT (16) is skipped; clients should use get/setPhysicalModel() instead. Measures acceleration force and provides bias data.