FrameDataApi24

Artifact: androidx.metrics:metrics-performance

Kotlin |Java

open class FrameDataApi24 : FrameData

kotlin.Any
↳	androidx.metrics.performance.FrameData
	↳	androidx.metrics.performance.FrameDataApi24

Known direct subclasses

FrameDataApi31

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
`FrameDataApi24( frameStartNanos: Long, frameDurationUiNanos: Long, frameDurationCpuNanos: Long, isJank: Boolean, states: List<StateInfo> )`

Public functions
`open FrameData`	`copy()` Utility method which makes a copy of the items in this object (including copying the items in `states` into a new List).
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`open String`	`toString()`

Public properties
`Long`	`frameDurationCpuNanos` The time spent in the non-GPU portions of this frame (in nanoseconds).

Inherited properties

From androidx.metrics.performance.FrameData

`Long`	`frameDurationUiNanos` The time spent in the UI portion of this frame (in nanoseconds).
`Long`	`frameStartNanos` 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.
`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`).
`List<StateInfo>`	`states` The UI/app state during this frame.

Public constructors

FrameDataApi24

Added in 1.0.0-beta01

FrameDataApi24(
    frameStartNanos: Long,
    frameDurationUiNanos: Long,
    frameDurationCpuNanos: Long,
    isJank: Boolean,
    states: List<StateInfo>
)

Public functions

copy

open fun copy(): FrameData

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

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

frameDurationCpuNanos

Added in 1.0.0-beta01

val frameDurationCpuNanos: Long

The time spent in the non-GPU portions of this frame (in nanoseconds). This includes the time spent on the UI thread frameDurationUiNanos plus time spent on the RenderThread.