Stay organized with collections
Save and categorize content based on your preferences.
SurfaceControl.OnJankDataListenerRegistration
public
static
class
SurfaceControl.OnJankDataListenerRegistration
extends Object
Handle to a registered ERROR(/OnJankDatalistener).
Summary
Public methods |
|---|
void
|
flush()
Request a flush of any pending jank classification data.
|
void
|
removeAfter(long afterVsync)
Schedule the removal of the registered listener after the frame with the provided id.
|
Inherited methods |
|---|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object.
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(long timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait(long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
Public methods
flush
public void flush ()
Request a flush of any pending jank classification data.
May cause the registered listener to be invoked inband. Since jank is tracked by the
system compositor by surface, flushing the data on one listener, will also cause other
listeners on the same surface to receive jank classification data.
removeAfter
public void removeAfter (long afterVsync)
Schedule the removal of the registered listener after the frame with the provided id.
Because jank classification is only possible after frames have been displayed, the
callbacks are always delayed. To ensure receipt of all jank classification data, an
application can schedule the removal to happen no sooner than after the data for the
frame with the provided id has been provided.
Use a value <= 0 for afterVsync to remove the listener immediately, ensuring no future
callbacks.
| Parameters |
|---|
afterVsync |
long: the id of the Vsync after which to remove the listener |
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-03-13 UTC.
[null,null,["Last updated 2025-03-13 UTC."],[],[],null,["# SurfaceControl.OnJankDataListenerRegistration\n\nAdded in [API level 36](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nSurfaceControl.OnJankDataListenerRegistration\n=============================================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/view/SurfaceControl.OnJankDataListenerRegistration \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\nstatic\n\n\nclass\nSurfaceControl.OnJankDataListenerRegistration\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|------------------------------------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.view.SurfaceControl.OnJankDataListenerRegistration |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nHandle to a registered [ERROR(/OnJankDatalistener)](/).\n\nSummary\n-------\n\n| ### Public methods ||\n|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` void` | ` `[flush](/reference/android/view/SurfaceControl.OnJankDataListenerRegistration#flush())`() ` Request a flush of any pending jank classification data. |\n| ` void` | ` `[removeAfter](/reference/android/view/SurfaceControl.OnJankDataListenerRegistration#removeAfter(long))`(long afterVsync) ` Schedule the removal of the registered listener after the frame with the provided id. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic methods\n--------------\n\n### flush\n\nAdded in [API level 36](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic void flush ()\n```\n\nRequest a flush of any pending jank classification data.\n\n\nMay cause the registered listener to be invoked inband. Since jank is tracked by the\nsystem compositor by surface, flushing the data on one listener, will also cause other\nlisteners on the same surface to receive jank classification data.\n\n\u003cbr /\u003e\n\n### removeAfter\n\nAdded in [API level 36](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic void removeAfter (long afterVsync)\n```\n\nSchedule the removal of the registered listener after the frame with the provided id.\n\n\nBecause jank classification is only possible after frames have been displayed, the\ncallbacks are always delayed. To ensure receipt of all jank classification data, an\napplication can schedule the removal to happen no sooner than after the data for the\nframe with the provided id has been provided.\n\n\nUse a value \\\u003c= 0 for afterVsync to remove the listener immediately, ensuring no future\ncallbacks.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------|\n| `afterVsync` | `long`: the id of the Vsync after which to remove the listener \u003cbr /\u003e |"]]
