# FrameMetricsAggregator

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/app/FrameMetricsAggregator.java+class:androidx.core.app.FrameMetricsAggregator) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

*** ** * ** ***


```
public class FrameMetricsAggregator
```

<br />

*** ** * ** ***

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 `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()`.

For more information on the various metrics tracked, see the documentation for the [FrameMetrics](https://developer.android.com/reference/android/view/FrameMetrics.html) API added in API 24 as well as the [GPU Profiling guide](https://developer.android.com/studio/profile/dev-options-rendering.html).

## Summary

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#ANIMATION_DURATION() = 256` A flag indicating that the metrics should track the animation duration. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#ANIMATION_INDEX() = 8` The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#ANIMATION_DURATION()` is stored. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#COMMAND_DURATION() = 32` A flag indicating that the metrics should track the command duration. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#COMMAND_INDEX() = 5` The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#SYNC_DURATION()` is stored. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#DELAY_DURATION() = 128` A flag indicating that the metrics should track the delay duration. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#DELAY_INDEX() = 7` The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#DELAY_DURATION()` is stored. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#DRAW_DURATION() = 8` A flag indicating that the metrics should track the draw duration. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#DRAW_INDEX() = 3` The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#DRAW_DURATION()` is stored. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#EVERY_DURATION() = 511` A flag indicating that the metrics should track all durations. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#INPUT_DURATION() = 2` A flag indicating that the metrics should track the input duration. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#INPUT_INDEX() = 1` The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#INPUT_DURATION()` is stored. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#LAYOUT_MEASURE_DURATION() = 4` A flag indicating that the metrics should track the layout duration. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#LAYOUT_MEASURE_INDEX() = 2` The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#LAYOUT_MEASURE_DURATION()` is stored. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#SWAP_DURATION() = 64` A flag indicating that the metrics should track the swap duration. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#SWAP_INDEX() = 6` The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#COMMAND_DURATION()` is stored. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#SYNC_DURATION() = 16` A flag indicating that the metrics should track the sync duration. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#SYNC_INDEX() = 4` The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#SYNC_DURATION()` is stored. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#TOTAL_DURATION() = 1` A flag indicating that the metrics should track the total duration. |
| `static final int` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#TOTAL_INDEX() = 0` The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#TOTAL_DURATION()` is stored. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#FrameMetricsAggregator()()` Constructs a FrameMetricsAggregator object that will track `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#TOTAL_DURATION()` metrics. |
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#FrameMetricsAggregator(int)(int metricTypeFlags)` 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 `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#TOTAL_DURATION()` to specify all metrics that should be tracked. |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#add(android.app.Activity)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/app/Activity.html activity)` Starts recording frame metrics for the given activity. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html SparseIntArray[]` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()()` Returns the currently-collected metrics in an array of SparseIntArray objects. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html SparseIntArray[]` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#remove(android.app.Activity)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/app/Activity.html activity)` Stops recording metrics for `activity` and returns the collected metrics so far. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html SparseIntArray[]` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#reset()()` Resets the metrics data and returns the currently-collected metrics. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html SparseIntArray[]` | `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#stop()()` Stops recording metrics for all Activities currently being tracked. |

## Constants

### ANIMATION_DURATION

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int ANIMATION_DURATION = 256
```

A flag indicating that the metrics should track the animation duration. This flag may be OR'd with the other flags here when calling `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#FrameMetricsAggregator(int)` to indicate all of the metrics that should be tracked for that activity.

### ANIMATION_INDEX

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int ANIMATION_INDEX = 8
```

The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#ANIMATION_DURATION()` is stored.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()` |   |

### COMMAND_DURATION

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int COMMAND_DURATION = 32
```

A flag indicating that the metrics should track the command duration. This flag may be OR'd with the other flags here when calling `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#FrameMetricsAggregator(int)` to indicate all of the metrics that should be tracked for that activity.

### COMMAND_INDEX

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int COMMAND_INDEX = 5
```

The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#SYNC_DURATION()` is stored.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()` |   |

### DELAY_DURATION

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int DELAY_DURATION = 128
```

A flag indicating that the metrics should track the delay duration. This flag may be OR'd with the other flags here when calling `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#FrameMetricsAggregator(int)` to indicate all of the metrics that should be tracked for that activity.

### DELAY_INDEX

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int DELAY_INDEX = 7
```

The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#DELAY_DURATION()` is stored.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()` |   |

### DRAW_DURATION

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int DRAW_DURATION = 8
```

A flag indicating that the metrics should track the draw duration. This flag may be OR'd with the other flags here when calling `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#FrameMetricsAggregator(int)` to indicate all of the metrics that should be tracked for that activity.

### DRAW_INDEX

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int DRAW_INDEX = 3
```

The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#DRAW_DURATION()` is stored.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()` |   |

### EVERY_DURATION

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int EVERY_DURATION = 511
```

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 `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#FrameMetricsAggregator(int)` to indicate the metrics that should be tracked for that activity.

### INPUT_DURATION

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int INPUT_DURATION = 2
```

A flag indicating that the metrics should track the input duration. This flag may be OR'd with the other flags here when calling `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#FrameMetricsAggregator(int)` to indicate all of the metrics that should be tracked for that activity.

### INPUT_INDEX

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int INPUT_INDEX = 1
```

The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#INPUT_DURATION()` is stored.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()` |   |

### LAYOUT_MEASURE_DURATION

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int LAYOUT_MEASURE_DURATION = 4
```

A flag indicating that the metrics should track the layout duration. This flag may be OR'd with the other flags here when calling `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#FrameMetricsAggregator(int)` to indicate all of the metrics that should be tracked for that activity.

### LAYOUT_MEASURE_INDEX

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int LAYOUT_MEASURE_INDEX = 2
```

The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#LAYOUT_MEASURE_DURATION()` is stored.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()` |   |

### SWAP_DURATION

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int SWAP_DURATION = 64
```

A flag indicating that the metrics should track the swap duration. This flag may be OR'd with the other flags here when calling `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#FrameMetricsAggregator(int)` to indicate all of the metrics that should be tracked for that activity.

### SWAP_INDEX

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int SWAP_INDEX = 6
```

The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#COMMAND_DURATION()` is stored.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()` |   |

### SYNC_DURATION

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int SYNC_DURATION = 16
```

A flag indicating that the metrics should track the sync duration. This flag may be OR'd with the other flags here when calling `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#FrameMetricsAggregator(int)` to indicate all of the metrics that should be tracked for that activity.

### SYNC_INDEX

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int SYNC_INDEX = 4
```

The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#SYNC_DURATION()` is stored.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()` |   |

### TOTAL_DURATION

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int TOTAL_DURATION = 1
```

A flag indicating that the metrics should track the total duration. This flag may be OR'd with the other flags here when calling `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#FrameMetricsAggregator(int)` to indicate all of the metrics that should be tracked for that activity.

### TOTAL_INDEX

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int TOTAL_INDEX = 0
```

The index in the metrics array where the data for `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#TOTAL_DURATION()` is stored.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()` |   |

## Public constructors

### FrameMetricsAggregator

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public FrameMetricsAggregator()
```

Constructs a FrameMetricsAggregator object that will track `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#TOTAL_DURATION()` metrics. If more fine-grained metrics are needed, use `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#FrameMetricsAggregator(int)` instead.

### FrameMetricsAggregator

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public FrameMetricsAggregator(int metricTypeFlags)
```

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 `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#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 |
|---|---|
| `int metricTypeFlags` | A bitwise collection of flags indicating which metrics should be recorded. |

## Public methods

### add

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public void add(@NonNull Activity activity)
```

Starts recording frame metrics for the given activity.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/app/Activity.html activity` | The Activity object which will have its metrics measured. |

### getMetrics

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @Nullable SparseIntArray[] getMetrics()
```

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 |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html 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](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @Nullable SparseIntArray[] remove(@NonNull Activity activity)
```

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 `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#reset()` to clear the data.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/app/Activity.html activity` | The Activity to stop tracking metrics for. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html 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 |
|---|---|
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()` |   |

### reset

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @Nullable SparseIntArray[] reset()
```

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

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html 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 |
|---|---|
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()` |   |

### stop

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @Nullable SparseIntArray[] stop()
```

Stops recording metrics for all Activities currently being tracked. Like `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#remove(android.app.Activity)`, this method returns the currently-collected metrics. Calling stop() does not reset the metrics array; you must call `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#reset()` to clear the data.

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html 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 |
|---|---|
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#remove(android.app.Activity)` |   |
| `https://developer.android.com/reference/androidx/core/app/FrameMetricsAggregator#getMetrics()` |   |