Skip to main content
Version: next

displayImePolicy

info

Added in Scrcpy 3.2

  • Type: "local" | "fallback" | "hide" | undefined
  • Default value: undefined

Controls the policy for displaying the Input Method Editor (IME) during screen mirroring.

Values​

  • "local": Show IME locally on the device
  • "fallback": Use fallback IME behavior
  • "hide": Hide the IME during screen mirroring
  • undefined: Use the system default policy (no explicit policy set)
  • newDisplay: Creates a new virtual display for video streaming
  • vdSystemDecorations: Controls whether the virtual display should include system decorations

Example​

import { ScrcpyOptions3_2 } from "@yume-chan/scrcpy";

const options = new ScrcpyOptions3_2({
    displayImePolicy: "hide", // Hide IME during screen mirroring
});