SurfaceControl.OnJankDataListenerRegistration

Kotlin |Java

public static class SurfaceControl.OnJankDataListenerRegistration
extends Object

java.lang.Object
↳	android.view.SurfaceControl.OnJankDataListenerRegistration

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

Added in API level 36

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

Added in API level 36

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