TimeCapture

Added in 1.2.0

Kotlin |Java

@ExperimentalBenchmarkConfigApi
class TimeCapture : MetricCapture

kotlin.Any
↳	androidx.benchmark.MetricCapture
	↳	androidx.benchmark.TimeCapture

Time metric, which reports time in nanos, based on the time passed to captureStop.

Reports elapsed time with the label from name, which defaults to timeNs.

Summary

Public constructors
`TimeCapture(name: String)`

Public functions
`open Unit`	`capturePaused()` Pause data collection.
`open Unit`	`captureResumed()` Resume data collection
`open Unit`	`captureStart(timeNs: Long)` Starts collecting data for a run.
`open Unit`	`captureStop(timeNs: Long, output: LongArray, offset: Int)` Mark the end of a run, and store offset metrics in the output array, per sub metric.

`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`

List<String>

names

List of names of metrics produced by this MetricCapture.

Added in 1.3.0

TimeCapture(name: String = "timeNs")

Parameters
`name: String = "timeNs"`	Metric name of the measured time, defaults to `timeNs`.

open fun capturePaused(): Unit

Pause data collection.

open fun captureResumed(): Unit

Resume data collection

open fun captureStart(timeNs: Long): Unit

Starts collecting data for a run.

Called at the start of each run.

Parameters
`timeNs: Long`	Current time, just before starting metrics. Can be used directly to drive a timing metric produced.

open fun captureStop(timeNs: Long, output: LongArray, offset: Int): Unit

Mark the end of a run, and store offset metrics in the output array, per sub metric.

To output values, store them in the output array offset by both the parameter offset, and their submetric index.

Parameters
`timeNs: Long`	Time of metric capture start, in monotonic time (`java.lang.System.nanoTime`)
`output: LongArray`	LongArray sized to hold all simultaneous sub metric outputs, use `offset` as the initial position in `output` to start writing submetrics.
`offset: Int`	Offset into the output array to start writing sub metrics.