Sets the policy for how the display should show IME. #5703

Mr-JingShi · 2024-12-25T07:39:30Z

Hi，bro.
Scrcpy is very good, I like it.

I want to display IME in virtualdisplay。

Possible values are "local", "fallback_display" and "hide".

rom1v

Thank you for your PR. After a quick glance, it looks very good and clean (with all details implemented) 👍

As a French speaker, I have never needed to use an IME, so I'm not very familiar with IME policies. I'd like to get opinions from IME users 🙂

There are 3 options (local, fallback, hide), is it absolutely necessary to expose them? (Maybe yes, I'm just asking.)
Or isn't there an "obvious" default option to set without asking the user?

For example, are there cases where you need to use an IME on your main display if you're mirroring a virtual display?

Wouldn't it be sufficient to call unconditionnally in NewDisplayCapture:

ServiceManager.getWindowManager().setDisplayImePolicy(virtualDisplayId, DISPLAY_IME_POLICY_LOCAL)`

rom1v · 2024-12-26T11:23:17Z

server/src/main/java/com/genymobile/scrcpy/CleanUp.java

@@ -100,15 +101,27 @@ private void runCleanUp(Options options) {
        boolean powerOffScreen = options.getPowerOffScreenOnClose();
        int displayId = options.getDisplayId();

+        int restoreDisplayImePolicy = -1;
+        if (displayId > 0) {


This is only for secondary displays? (not the main display?)

Yes, the main display must be able to display IME normally.
I think We shouldn't modify the main display settings。

(nitpick: maybe we should still allow --display-ime-policy for display 0, and let the user not pass the option for the main display if he does not want to?)

rom1v · 2024-12-26T11:29:41Z

server/src/main/java/com/genymobile/scrcpy/wrappers/WindowManager.java

+        if (setDisplayImePolicyMethod == null) {
+            try {
+                setDisplayImePolicyMethod = manager.getClass().getMethod("setDisplayImePolicy", int.class, int.class);
+            } catch (NoSuchMethodException e) {


The change between shouldShowIme() and getDisplayImePolicy() was performed by this commit introduced in Android 12, so it can be checked directly with Build.VERSION.SDK_INT < AndroidVersions.API_31_ANDROID_12.

Mr-JingShi · 2024-12-27T07:35:49Z

Thank you for your PR. After a quick glance, it looks very good and clean (with all details implemented) 👍

As a French speaker, I have never needed to use an IME, so I'm not very familiar with IME policies. I'd like to get opinions from IME users 🙂

There are 3 options (local, fallback, hide), is it absolutely necessary to expose them? (Maybe yes, I'm just asking.) Or isn't there an "obvious" default option to set without asking the user?

For example, are there cases where you need to use an IME on your main display if you're mirroring a virtual display?

Wouldn't it be sufficient to call unconditionnally in NewDisplayCapture:
ServiceManager.getWindowManager().setDisplayImePolicy(virtualDisplayId, DISPLAY_IME_POLICY_LOCAL)`

Thank you for your replay.

I have a project about Huawei electric car，the project sometimes needs to input text then search on secondary display, and then notify the main driver（main display）.Huawei electric cars are very expensive, and not every developer can have one.
so we developed an app named secondaryscreen instead of Huawei electric cars.

The secondary display is TYPE_HDMI on Huawei electric car, IME show in secondary display.
Android Studio-Add seconday display is TYPE_VIRTUAL, IME show in secondary display.
Developer options-Simulate secondary displays is TYPE_OVERLAY, IME show in main display.
we create a virtualdisplay in my app, the virtualdisplay is TYPE_VIRTUAL, But IME show in main display.

I'm very confused, then I find Developer options-Force desktop mode, it can show IME in secondary display.
But Some phones don't have this feature.

We know，the main display must be able to display IME normally，so，I just want to display IME in secondary display when I touch in secondary display such as Huawei electric car and Android Studio‘s secondary display。

/**
 * Virtual display flag: Indicates that the display should support system decorations. Virtual
 * displays without this flag shouldn't show home, navigation bar or wallpaper.
 * <p>This flag doesn't work without {@link #VIRTUAL_DISPLAY_FLAG_TRUSTED}</p>
 *
 * @see #createVirtualDisplay
 * @see #VIRTUAL_DISPLAY_FLAG_TRUSTED
 * @hide
 */
@TestApi
public static final int VIRTUAL_DISPLAY_FLAG_SHOULD_SHOW_SYSTEM_DECORATIONS = 1 << 9;

/**
 * Virtual display flags: Indicates that the display is trusted to show system decorations and
 * receive inputs without users' touch.
 *
 * @see #createVirtualDisplay
 * @see #VIRTUAL_DISPLAY_FLAG_SHOULD_SHOW_SYSTEM_DECORATIONS
 * @hide
 */
@SystemApi
public static final int VIRTUAL_DISPLAY_FLAG_TRUSTED = 1 << 10;

If the secondary screen wants to display IME, it must has the VIRTUAL_DISPLAY_FLAG_TRUSTED and VIRTUAL_DISPLAY_FLAG_SHOULD_SHOW_SYSTEM_DECORATIONS flag, otherwise it will report a permission problem.

java.lang.SecurityException: Attempted to set IME flag to an untrusted virtual display: 1

The virtualdisplay that created by my app does not have VIRTUAL_DISPLAY_FLAG_TRUSTED in Android 11 、12.

/**
 * @return {@code true} if the display is non-system created virtual display.
 */
boolean isUntrustedVirtualDisplay() {
    return mDisplay.getType() == Display.TYPE_VIRTUAL
            && mDisplay.getOwnerUid() != Process.SYSTEM_UID;
}

Although Android 10 does not have a VIRTUAL_DISPLAY_FLAG_TRUSTED flag, But Android 10 will check OwnerUid.
So, Not all virtual display can be set up successfully. then the default value will be meaningless(local、fallback or hide).
I think it is better to let users choose the IME display strategy, If virtualdisplay don't have permission, report an error to the user.

…ShowIme and getDisplayImePolicy

rom1v · 2025-01-09T17:11:06Z

app/src/cli.c

+    } else {
+        if (!opts->new_display
+             && opts->display_ime_policy != SC_DISPLAY_IME_POLICY_UNDEFINDED) {
+            LOGE("--display-ime-policy not supported if display_id == 0 and new_display == NULL");


--display-ime-policy=hide would not make sense for the main display?

I try "setDisplayImePolicy(0, 2)", it doest not work, the main display always show IME. I don't know why until now.
Testing Machine List：

brand model api-level abi

HUAWEI AGS5-W00 31 arm64-v8a

google Pixel 3a 32 arm64-v8a

Lenovo TB331FC 33 arm64-v8a

Xiaomi 23073RPBFC 34 arm64-v8a

code:

int displayImePolicy = ServiceManager.getWindowManager().getDisplayImePolicy(0); Ln.d("displayImePolicy:" + displayImePolicy + " before setDisplayImePolicy"); ServiceManager.getWindowManager().setDisplayImePolicy(0, 2); displayImePolicy = ServiceManager.getWindowManager().getDisplayImePolicy(0); Ln.d("displayImePolicy:" + displayImePolicy + " after setDisplayImePolicy");

print:
[server] DEBUG: displayImePolicy:0 before setDisplayImePolicy
[server] DEBUG: displayImePolicy:0 after setDisplayImePolicy

rom1v · 2025-01-09T17:15:41Z

server/src/main/java/com/genymobile/scrcpy/CleanUp.java

@@ -100,15 +101,27 @@ private void runCleanUp(Options options) {
        boolean powerOffScreen = options.getPowerOffScreenOnClose();
        int displayId = options.getDisplayId();

+        int restoreDisplayImePolicy = -1;
+        if (displayId > 0) {


(nitpick: maybe we should still allow --display-ime-policy for display 0, and let the user not pass the option for the main display if he does not want to?)

rom1v · 2025-01-11T13:50:17Z

One more question:

The display IME policy is set at two different places:

one for the virtual display created by --new-display
one for the case --display=<secondary_display>

For the second case, does it work if you apply the IME policy to the mirroring virtual display instead of using the "clean up" mechanism?

Something like:

diff --git server/src/main/java/com/genymobile/scrcpy/video/ScreenCapture.java server/src/main/java/com/genymobile/scrcpy/video/ScreenCapture.java
index 5f4e1803f..e9ab32534 100644
--- server/src/main/java/com/genymobile/scrcpy/video/ScreenCapture.java
+++ server/src/main/java/com/genymobile/scrcpy/video/ScreenCapture.java
@@ -127,6 +127,8 @@ public class ScreenCapture extends SurfaceCapture {
         try {
             virtualDisplay = ServiceManager.getDisplayManager()
                     .createVirtualDisplay("scrcpy", inputSize.getWidth(), inputSize.getHeight(), displayId, surface);
+            int virtualDisplayId = virtualDisplay.getDisplay().getDisplayId();
+            ServiceManager.getWindowManager().setDisplayImePolicy(virtualDisplayId, displayImePolicy);
             Ln.d("Display: using DisplayManager API");
         } catch (Exception displayManagerException) {
             try {

Mr-JingShi · 2025-01-14T02:23:00Z

One more question:

The display IME policy is set at two different places:

one for the virtual display created by --new-display
one for the case --display=<secondary_display>

For the second case, does it work if you apply the IME policy to the mirroring virtual display instead of using the "clean up" mechanism?

Something like:

diff --git server/src/main/java/com/genymobile/scrcpy/video/ScreenCapture.java server/src/main/java/com/genymobile/scrcpy/video/ScreenCapture.java
index 5f4e1803f..e9ab32534 100644
--- server/src/main/java/com/genymobile/scrcpy/video/ScreenCapture.java
+++ server/src/main/java/com/genymobile/scrcpy/video/ScreenCapture.java
@@ -127,6 +127,8 @@ public class ScreenCapture extends SurfaceCapture {
         try {
             virtualDisplay = ServiceManager.getDisplayManager()
                     .createVirtualDisplay("scrcpy", inputSize.getWidth(), inputSize.getHeight(), displayId, surface);
+            int virtualDisplayId = virtualDisplay.getDisplay().getDisplayId();
+            ServiceManager.getWindowManager().setDisplayImePolicy(virtualDisplayId, displayImePolicy);
             Ln.d("Display: using DisplayManager API");
         } catch (Exception displayManagerException) {
             try {

The virtualdiplay created by this way is private and untrusted. throws SecurityException when setDisplayImePolicy.

mBaseDisplayInfo=DisplayInfo{"scrcpy", displayId 4, displayGroupId 0, FLAG_PRIVATE, real 1920 x 1080, largest app 1920 x 1080, smallest app 1920 x 1080, appVsyncOff 0, presDeadline 16666666, mode 860.0, defaultMode 8, modes [{id=8, width=1920, height=1080, fps=60.0, alternativeRefreshRates=[], supportedHdrTypes=[]}], hdrCapabilities null, userDisabledHdrTypes [], minimalPostProcessingSupported false, rotation 0, state ON, committedState UNKNOWN, type VIRTUAL, uniqueId "virtual:com.android.shell,2000,scrcpy,0", app 1920 x 1080, density 1 (1.0 x 1.0) dpi, layerStack 4, colorMode 0, supportedColorModes [0], deviceProductInfo null, owner com.android.shell (uid 2000), removeMode 1, refreshRateOverride 0.0, brightnessMinimum 0.0, brightnessMaximum 0.0, brightnessDefault 0.0, installOrientation ROTATION_0, layoutLimitedRefreshRate null, hdrSdrRatio not_available, thermalRefreshRateThrottling {}, thermalBrightnessThrottlingDataId default}

Caused by: java.lang.SecurityException: Attempted to set IME policy to an untrusted virtual display: 4

Sets the policy for how the display should show IME.

b37aa74

Possible values are "local", "fallback_display" and "hide".

rom1v reviewed Dec 26, 2024

View reviewed changes

Using AndroidVersions.API_31_ANDROID_12 to distinguish between should…

569b1bb

…ShowIme and getDisplayImePolicy

rom1v reviewed Jan 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sets the policy for how the display should show IME. #5703

Sets the policy for how the display should show IME. #5703

Mr-JingShi commented Dec 25, 2024

rom1v left a comment

rom1v Dec 26, 2024

Mr-JingShi Dec 27, 2024 •

edited

Loading

rom1v Jan 9, 2025

rom1v Dec 26, 2024

Mr-JingShi Dec 27, 2024

Mr-JingShi commented Dec 27, 2024 •

edited

Loading

rom1v Jan 9, 2025

Mr-JingShi Jan 13, 2025 •

edited

Loading

Mr-JingShi Jan 14, 2025 •

edited

Loading

rom1v Jan 9, 2025

rom1v commented Jan 11, 2025 •

edited

Loading

Mr-JingShi commented Jan 14, 2025 •

edited

Loading

brand	model	api-level	abi
HUAWEI	AGS5-W00	31	arm64-v8a
google	Pixel 3a	32	arm64-v8a
Lenovo	TB331FC	33	arm64-v8a
Xiaomi	23073RPBFC	34	arm64-v8a

Sets the policy for how the display should show IME. #5703

Are you sure you want to change the base?

Sets the policy for how the display should show IME. #5703

Conversation

Mr-JingShi commented Dec 25, 2024

rom1v left a comment

Choose a reason for hiding this comment

rom1v Dec 26, 2024

Choose a reason for hiding this comment

Mr-JingShi Dec 27, 2024 • edited Loading

Choose a reason for hiding this comment

rom1v Jan 9, 2025

Choose a reason for hiding this comment

rom1v Dec 26, 2024

Choose a reason for hiding this comment

Mr-JingShi Dec 27, 2024

Choose a reason for hiding this comment

Mr-JingShi commented Dec 27, 2024 • edited Loading

rom1v Jan 9, 2025

Choose a reason for hiding this comment

Mr-JingShi Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

Mr-JingShi Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

rom1v Jan 9, 2025

Choose a reason for hiding this comment

rom1v commented Jan 11, 2025 • edited Loading

Mr-JingShi commented Jan 14, 2025 • edited Loading

Mr-JingShi Dec 27, 2024 •

edited

Loading

Mr-JingShi commented Dec 27, 2024 •

edited

Loading

Mr-JingShi Jan 13, 2025 •

edited

Loading

Mr-JingShi Jan 14, 2025 •

edited

Loading

rom1v commented Jan 11, 2025 •

edited

Loading

Mr-JingShi commented Jan 14, 2025 •

edited

Loading