FrameDataApi31

Artifact: androidx.metrics:metrics-performance

Added in 1.0.0

Kotlin |Java

public final class FrameDataApi31 extends FrameDataApi24

java.lang.Object
↳	androidx.metrics.performance.FrameData
	↳	androidx.metrics.performance.FrameDataApi24
		↳	androidx.metrics.performance.FrameDataApi31

This class stores duration data for a single frame.

This subclass of FrameData adds an additional value for frameDurationCpuNanos

See also
`jankHeuristicMultiplier`
`putState`

Summary

Public constructors
`FrameDataApi31( long frameStartNanos, long frameDurationUiNanos, long frameDurationCpuNanos, long frameDurationTotalNanos, long frameOverrunNanos, 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`	`getFrameDurationTotalNanos()` The total time spent rendering this frame (in nanoseconds), which includes both CPU and GPU processing.
`final long`	`getFrameOverrunNanos()` The amount of time past the frame deadline that this frame took to complete.
`int`	`hashCode()`
`@NonNull String`	`toString()`

Inherited methods

From androidx.metrics.performance.FrameData

`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.
`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`).

From androidx.metrics.performance.FrameDataApi24

final long

getFrameDurationCpuNanos()

The time spent in the non-GPU portions of this frame (in nanoseconds).

Public constructors

FrameDataApi31

Added in 1.0.0

public FrameDataApi31(
    long frameStartNanos,
    long frameDurationUiNanos,
    long frameDurationCpuNanos,
    long frameDurationTotalNanos,
    long frameOverrunNanos,
    boolean isJank,
    @NonNull List<@NonNull StateInfo> states
)

Public methods

copy

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)

getFrameDurationTotalNanos

Added in 1.0.0

public final long getFrameDurationTotalNanos()

The total time spent rendering this frame (in nanoseconds), which includes both CPU and GPU processing.

getFrameOverrunNanos

Added in 1.0.0

public final long getFrameOverrunNanos()

The amount of time past the frame deadline that this frame took to complete. A positive value indicates some jank, a negative value indicates that the frame was complete within the given deadline.

hashCode

public int hashCode()

toString

public @NonNull String toString()