Choreographer.FrameData

Kotlin |Java

public static class Choreographer.FrameData
extends Object

java.lang.Object
↳	android.view.Choreographer.FrameData

The payload for VsyncCallback which includes frame information such as when the frame started being rendered, and multiple possible frame timelines and their information including deadline and expected present time.

Summary

Public methods
`long`	`getFrameTimeNanos()` The time in nanoseconds when the frame started being rendered.
`FrameTimeline[]`	`getFrameTimelines()` The possible frame timelines, sorted chronologically.
`Choreographer.FrameTimeline`	`getPreferredFrameTimeline()` The platform-preferred frame timeline.

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

getFrameTimeNanos

Added in API level 33

public long getFrameTimeNanos ()

The time in nanoseconds when the frame started being rendered.

This method provides an adjusted timestamp in nanoseconds when the frame started being rendered. In the past it was recommended to use this timestamp for animations. However, using this timestamp for animations, causes animations to skip forward after late frames, which introduces undesired jank. Instead, use ERROR(/#getAnimationTimeNanos()) for smoother animations. Only use this timestamps for frame timing information (e.g. comparing to current time, frame deadlines, etc.).

Returns
`long`

getFrameTimelines

Added in API level 33

public FrameTimeline[] getFrameTimelines ()

The possible frame timelines, sorted chronologically.

Returns
`FrameTimeline[]`	This value cannot be `null`.

getPreferredFrameTimeline

Added in API level 33

public Choreographer.FrameTimeline getPreferredFrameTimeline ()

The platform-preferred frame timeline.

Returns
`Choreographer.FrameTimeline`	This value cannot be `null`.