Stay organized with collections
Save and categorize content based on your preferences.
interface SurfaceControlInputReceiver
Provides a mechanism for a SurfaceControl to receive input events.
Summary
Public methods |
abstract Boolean |
When input events are batched, this is called at most once per frame.
|
Public methods
abstract fun onInputEvent(event: InputEvent): Boolean
When input events are batched, this is called at most once per frame. When non batched, this is called immediately for the input event.
Parameters |
event |
InputEvent: The input event that was received. This input event object will become invalid and recycled after this method is invoked. If there is need to persist this object beyond the scope of this method, the overriding code should make a copy of this object. For example, using MotionEvent.obtain(MotionEvent other) or KeyEvent.KeyEvent(KeyEvent) } This value cannot be null . |
Return |
Boolean |
true if the event was handled, false otherwise. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# SurfaceControlInputReceiver\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nSurfaceControlInputReceiver\n===========================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/view/SurfaceControlInputReceiver \"View this page in Java\") \n\n```\ninterface SurfaceControlInputReceiver\n```\n\n|-----------------------------------------------|\n| [android.view.SurfaceControlInputReceiver](#) |\n\nProvides a mechanism for a SurfaceControl to receive input events.\n\nSummary\n-------\n\n| Public methods ||\n|---------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [onInputEvent](#onInputEvent(android.view.InputEvent))`(`event:` `[InputEvent](/reference/kotlin/android/view/InputEvent)`)` When input events are batched, this is called at most once per frame. |\n\nPublic methods\n--------------\n\n### onInputEvent\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun onInputEvent(event: InputEvent): Boolean\n```\n\nWhen input events are batched, this is called at most once per frame. When non batched, this is called immediately for the input event.\n\n| Parameters ||\n|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `event` | [InputEvent](/reference/kotlin/android/view/InputEvent): The input event that was received. This input event object will become invalid and recycled after this method is invoked. If there is need to persist this object beyond the scope of this method, the overriding code should make a copy of this object. For example, using [MotionEvent.obtain(MotionEvent other)](/reference/kotlin/android/view/MotionEvent#obtain(android.view.MotionEvent)) or [KeyEvent.KeyEvent(KeyEvent)](/reference/kotlin/android/view/KeyEvent#KeyEvent(android.view.KeyEvent)) } This value cannot be `null`. |\n\n| Return ||\n|------------------------------------------------------------------------------------|-------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | true if the event was handled, false otherwise. |"]]