FrameData

Artifact: androidx.metrics:metrics-performance

Added in 1.0.0

Kotlin |Java

public class FrameData

Known direct subclasses

FrameDataApi24

FrameDataApi24

This class stores duration data for a single frame.

Known indirect subclasses

FrameDataApi31

FrameDataApi31

This class stores duration data for a single frame.

See also
`jankHeuristicMultiplier`
`putState`

Summary

Public constructors
`FrameData( long frameStartNanos, long frameDurationUiNanos, boolean isJank, @NonNull List<@NonNull StateInfo> states )`

Public methods
`@NonNull FrameData`	`copy()` Utility method which makes a copy of the items in this object (including copying the items in `states` into a new List).
`boolean`	`equals(Object other)`
`final long`	`getFrameDurationUiNanos()` The time spent in the UI portion of this frame (in nanoseconds).
`final long`	`getFrameStartNanos()` These backing fields are used to enable mutation of an existing FrameData object, to avoid allocating a new object on every frame for sending out to listeners.
`final @NonNull List<@NonNull StateInfo>`	`getStates()` The UI/app state during this frame.
`int`	`hashCode()`
`final boolean`	`isJank()` Whether this frame was determined to be janky, meaning that its duration exceeds the duration determined by the system to indicate jank (@see `JankStats.jankHeuristicMultiplier`).
`@NonNull String`	`toString()`

Public constructors

FrameData

Added in 1.0.0

public FrameData(
    long frameStartNanos,
    long frameDurationUiNanos,
    boolean isJank,
    @NonNull List<@NonNull StateInfo> states
)

Public methods

copy

Added in 1.0.0

public @NonNull FrameData copy()

Utility method which makes a copy of the items in this object (including copying the items in states into a new List). This is used internally to create a copy to pass along to listeners to avoid having a reference to the internally-mutable FrameData object.

equals

public boolean equals(Object other)

getFrameDurationUiNanos

Added in 1.0.0

public final long getFrameDurationUiNanos()

The time spent in the UI portion of this frame (in nanoseconds). This is essentially the time spent on the UI thread to draw this frame, but does not include any time spent on the RenderThread.

getFrameStartNanos

Added in 1.0.0

public final long getFrameStartNanos()

These backing fields are used to enable mutation of an existing FrameData object, to avoid allocating a new object on every frame for sending out to listeners.

getStates

Added in 1.0.0

public final @NonNull List<@NonNull StateInfo> getStates()

The UI/app state during this frame. This is the information set by the app, or by other library code, that can be analyzed later to determine the UI state that was current when jank occurred.

hashCode

public int hashCode()

isJank

Added in 1.0.0

public final boolean isJank()

Whether this frame was determined to be janky, meaning that its duration exceeds the duration determined by the system to indicate jank (@see JankStats.jankHeuristicMultiplier).

toString

public @NonNull String toString()