FrameMetricsAggregator

const val ANIMATION_DURATION = 256: Int

A flag indicating that the metrics should track the animation duration. This flag may be OR'd with the other flags here when calling FrameMetricsAggregator to indicate all of the metrics that should be tracked for that activity.

const val ANIMATION_INDEX = 8: Int

The index in the metrics array where the data for ANIMATION_DURATION is stored.

const val COMMAND_DURATION = 32: Int

A flag indicating that the metrics should track the command duration. This flag may be OR'd with the other flags here when calling FrameMetricsAggregator to indicate all of the metrics that should be tracked for that activity.

const val COMMAND_INDEX = 5: Int

The index in the metrics array where the data for SYNC_DURATION is stored.

const val DELAY_DURATION = 128: Int

A flag indicating that the metrics should track the delay duration. This flag may be OR'd with the other flags here when calling FrameMetricsAggregator to indicate all of the metrics that should be tracked for that activity.

const val DELAY_INDEX = 7: Int

The index in the metrics array where the data for DELAY_DURATION is stored.

const val DRAW_DURATION = 8: Int

A flag indicating that the metrics should track the draw duration. This flag may be OR'd with the other flags here when calling FrameMetricsAggregator to indicate all of the metrics that should be tracked for that activity.

const val DRAW_INDEX = 3: Int

The index in the metrics array where the data for DRAW_DURATION is stored.

const val EVERY_DURATION = 511: Int

A flag indicating that the metrics should track all durations. This is a shorthand for OR'ing all of the duration flags. This flag may be OR'd with the other flags here when calling FrameMetricsAggregator to indicate the metrics that should be tracked for that activity.

const val INPUT_DURATION = 2: Int

A flag indicating that the metrics should track the input duration. This flag may be OR'd with the other flags here when calling FrameMetricsAggregator to indicate all of the metrics that should be tracked for that activity.

const val INPUT_INDEX = 1: Int

The index in the metrics array where the data for INPUT_DURATION is stored.

const val LAYOUT_MEASURE_DURATION = 4: Int

A flag indicating that the metrics should track the layout duration. This flag may be OR'd with the other flags here when calling FrameMetricsAggregator to indicate all of the metrics that should be tracked for that activity.

const val LAYOUT_MEASURE_INDEX = 2: Int

The index in the metrics array where the data for LAYOUT_MEASURE_DURATION is stored.

const val SWAP_DURATION = 64: Int

A flag indicating that the metrics should track the swap duration. This flag may be OR'd with the other flags here when calling FrameMetricsAggregator to indicate all of the metrics that should be tracked for that activity.

const val SWAP_INDEX = 6: Int

The index in the metrics array where the data for COMMAND_DURATION is stored.

const val SYNC_DURATION = 16: Int

A flag indicating that the metrics should track the sync duration. This flag may be OR'd with the other flags here when calling FrameMetricsAggregator to indicate all of the metrics that should be tracked for that activity.

const val SYNC_INDEX = 4: Int

The index in the metrics array where the data for SYNC_DURATION is stored.

const val TOTAL_DURATION = 1: Int

A flag indicating that the metrics should track the total duration. This flag may be OR'd with the other flags here when calling FrameMetricsAggregator to indicate all of the metrics that should be tracked for that activity.

const val TOTAL_INDEX = 0: Int

The index in the metrics array where the data for TOTAL_DURATION is stored.

FrameMetricsAggregator()

Constructs a FrameMetricsAggregator object that will track TOTAL_DURATION metrics. If more fine-grained metrics are needed, use FrameMetricsAggregator instead.

FrameMetricsAggregator(metricTypeFlags: Int)

Constructs a FrameMetricsAggregator object that will track the metrics specified bty metricTypeFlags, which is a value derived by OR'ing together metrics constants such as TOTAL_DURATION to specify all metrics that should be tracked. For example, TOTAL_DURATION | DRAW_DURATION will track both the total and draw durations for every frame.

fun add(activity: Activity): Unit

Starts recording frame metrics for the given activity.

fun getMetrics(): Array<SparseIntArray!>?

Returns the currently-collected metrics in an array of SparseIntArray objects. The index of the array indicates which metric's data is stored in that SparseIntArray object. For example, results for total duration will be in the [TOTAL_INDEX] item.

The return value may be null if no metrics were tracked. This is especially true on releases earlier than API 24, as the FrameMetrics system does not exist on these earlier release. If the return value is not null, any of the objects at a given index in the array may still be null, which indicates that data was not being tracked for that type of metric. For example, if the FrameMetricsAggregator was created with a call to new FrameMetricsAggregator(TOTAL_DURATION | DRAW_DURATION), then the SparseIntArray at index INPUT_INDEX will be null.

For a given non-null SparseIntArray, the results stored are the number of samples at each millisecond value (rounded). For example, if a data sample consisted of total durations of 5.1ms, 5.8ms, 6.1ms, and 8.2ms, the SparseIntArray at [TOTAL_DURATION] would have key-value pairs (5, 1), (6, 2), (8, 1).

fun remove(activity: Activity): Array<SparseIntArray!>?

Stops recording metrics for activity and returns the collected metrics so far. Recording will continue if there are still other activities being tracked. Calling remove() does not reset the metrics array; you must call reset to clear the data.

fun reset(): Array<SparseIntArray!>?

Resets the metrics data and returns the currently-collected metrics.

fun stop(): Array<SparseIntArray!>?

Stops recording metrics for all Activities currently being tracked. Like remove, this method returns the currently-collected metrics. Calling stop() does not reset the metrics array; you must call reset to clear the data.