FrameMetricsAggregator

Added in 1.1.0

Kotlin |Java

class FrameMetricsAggregator

This class can be used to record and return data about per-frame durations. It returns those results in an array per metric type, with the results indicating how many samples were recorded for each duration value. The details of the durations data are described in getMetrics.

For more information on the various metrics tracked, see the documentation for the FrameMetrics API added in API 24 as well as the GPU Profiling guide.

Summary

Constants
`const Int`	`ANIMATION_DURATION = 256` A flag indicating that the metrics should track the animation duration.
`const Int`	`ANIMATION_INDEX = 8` The index in the metrics array where the data for `ANIMATION_DURATION` is stored.
`const Int`	`COMMAND_DURATION = 32` A flag indicating that the metrics should track the command duration.
`const Int`	`COMMAND_INDEX = 5` The index in the metrics array where the data for `SYNC_DURATION` is stored.
`const Int`	`DELAY_DURATION = 128` A flag indicating that the metrics should track the delay duration.
`const Int`	`DELAY_INDEX = 7` The index in the metrics array where the data for `DELAY_DURATION` is stored.
`const Int`	`DRAW_DURATION = 8` A flag indicating that the metrics should track the draw duration.
`const Int`	`DRAW_INDEX = 3` The index in the metrics array where the data for `DRAW_DURATION` is stored.
`const Int`	`EVERY_DURATION = 511` A flag indicating that the metrics should track all durations.
`const Int`	`INPUT_DURATION = 2` A flag indicating that the metrics should track the input duration.
`const Int`	`INPUT_INDEX = 1` The index in the metrics array where the data for `INPUT_DURATION` is stored.
`const Int`	`LAYOUT_MEASURE_DURATION = 4` A flag indicating that the metrics should track the layout duration.
`const Int`	`LAYOUT_MEASURE_INDEX = 2` The index in the metrics array where the data for `LAYOUT_MEASURE_DURATION` is stored.
`const Int`	`SWAP_DURATION = 64` A flag indicating that the metrics should track the swap duration.
`const Int`	`SWAP_INDEX = 6` The index in the metrics array where the data for `COMMAND_DURATION` is stored.
`const Int`	`SYNC_DURATION = 16` A flag indicating that the metrics should track the sync duration.
`const Int`	`SYNC_INDEX = 4` The index in the metrics array where the data for `SYNC_DURATION` is stored.
`const Int`	`TOTAL_DURATION = 1` A flag indicating that the metrics should track the total duration.
`const Int`	`TOTAL_INDEX = 0` The index in the metrics array where the data for `TOTAL_DURATION` is stored.

Public constructors
`FrameMetricsAggregator()` Constructs a FrameMetricsAggregator object that will track `TOTAL_DURATION` metrics.
`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.

Public functions
`Unit`	`add(activity: Activity)` Starts recording frame metrics for the given activity.
`Array<SparseIntArray!>?`	`getMetrics()` Returns the currently-collected metrics in an array of SparseIntArray objects.
`Array<SparseIntArray!>?`	`remove(activity: Activity)` Stops recording metrics for `activity` and returns the collected metrics so far.
`Array<SparseIntArray!>?`	`reset()` Resets the metrics data and returns the currently-collected metrics.
`Array<SparseIntArray!>?`	`stop()` Stops recording metrics for all Activities currently being tracked.

Constants

ANIMATION_DURATION

Added in 1.1.0

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.

ANIMATION_INDEX

Added in 1.1.0

const val ANIMATION_INDEX = 8: Int

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

See also
`getMetrics`

COMMAND_DURATION

Added in 1.1.0

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.

COMMAND_INDEX

Added in 1.1.0

const val COMMAND_INDEX = 5: Int

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

See also
`getMetrics`

DELAY_DURATION

Added in 1.1.0

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.

DELAY_INDEX

Added in 1.1.0

const val DELAY_INDEX = 7: Int

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

See also
`getMetrics`

DRAW_DURATION

Added in 1.1.0

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.

DRAW_INDEX

Added in 1.1.0

const val DRAW_INDEX = 3: Int

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

See also
`getMetrics`

EVERY_DURATION

Added in 1.1.0

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.

INPUT_DURATION

Added in 1.1.0

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.

INPUT_INDEX

Added in 1.1.0

const val INPUT_INDEX = 1: Int

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

See also
`getMetrics`

LAYOUT_MEASURE_DURATION

Added in 1.1.0

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.

LAYOUT_MEASURE_INDEX

Added in 1.1.0

const val LAYOUT_MEASURE_INDEX = 2: Int

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

See also
`getMetrics`

SWAP_DURATION

Added in 1.1.0

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.

SWAP_INDEX

Added in 1.1.0

const val SWAP_INDEX = 6: Int

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

See also
`getMetrics`

SYNC_DURATION

Added in 1.1.0

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.

SYNC_INDEX

Added in 1.1.0

const val SYNC_INDEX = 4: Int

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

See also
`getMetrics`

TOTAL_DURATION

Added in 1.1.0

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.

TOTAL_INDEX

Added in 1.1.0

const val TOTAL_INDEX = 0: Int

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

See also
`getMetrics`

Public constructors

FrameMetricsAggregator

Added in 1.1.0

FrameMetricsAggregator()

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

FrameMetricsAggregator

Added in 1.1.0

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.

Parameters
`metricTypeFlags: Int`	A bitwise collection of flags indicating which metrics should be recorded.

Public functions

add

Added in 1.1.0

fun add(activity: Activity): Unit

Starts recording frame metrics for the given activity.

Parameters
`activity: Activity`	The Activity object which will have its metrics measured.

getMetrics

Added in 1.1.0

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

Returns
`Array<SparseIntArray!>?`	An array whose index refers to the type of metric stored in that item's SparseIntArray object, e.g., data for `TOTAL_DURATION` is stored in the `[TOTAL_INDEX]` item.

remove

Added in 1.1.0

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.

Parameters
`activity: Activity`	The Activity to stop tracking metrics for.

Returns
`Array<SparseIntArray!>?`	An array whose index refers to the type of metric stored in that item's SparseIntArray object, e.g., data for `TOTAL_DURATION` is stored in the `[TOTAL_INDEX]` item.

See also
`getMetrics`

reset

Added in 1.1.0

fun reset(): Array<SparseIntArray!>?

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

Returns
`Array<SparseIntArray!>?`	An array whose index refers to the type of metric stored in that item's SparseIntArray object, e.g., data for `TOTAL_DURATION` is stored in the `[TOTAL_INDEX]` item.

See also
`getMetrics`

stop

Added in 1.1.0

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.

Returns
`Array<SparseIntArray!>?`	An array whose index refers to the type of metric stored in that item's SparseIntArray object, e.g., data for `TOTAL_DURATION` is stored in the `[TOTAL_INDEX]` item.

See also
`remove`
`getMetrics`