ExperimentalConfig

Artifact: androidx.benchmark:benchmark-common

View Source

Added in 1.4.0

---

Kotlin |Java

@ExperimentalBenchmarkConfigApi
class ExperimentalConfig

---

Experimental configuration options for a benchmark.

Currently used to override the default PerfettoConfig, enable Startup Insightss, or configure memory heap profiling.

Summary

Public constructors
ExperimentalConfig(     perfettoConfig: PerfettoConfig?,     startupInsightsConfig: StartupInsightsConfig?,     memoryProfilingConfig: MemoryProfilingConfig? )

Public properties
MemoryProfilingConfig?	memoryProfilingConfig The MemoryProfilingConfig for the benchmark - null to disable memory profiling.
PerfettoConfig?	perfettoConfig The PerfettoConfig for the benchmark - null to use the default config.
StartupInsightsConfig?	startupInsightsConfig The StartupInsightsConfig for the benchmark - null to not enable insights reporting.

Public constructors

ExperimentalConfig

Added in 1.6.0-alpha01

ExperimentalConfig(
    perfettoConfig: PerfettoConfig? = null,
    startupInsightsConfig: StartupInsightsConfig? = null,
    memoryProfilingConfig: MemoryProfilingConfig? = null
)

Public properties

memoryProfilingConfig

Added in 1.6.0-alpha01

val memoryProfilingConfig: MemoryProfilingConfig?

The MemoryProfilingConfig for the benchmark - null to disable memory profiling.

perfettoConfig

Added in 1.4.0

val perfettoConfig: PerfettoConfig?

The PerfettoConfig for the benchmark - null to use the default config.

startupInsightsConfig

Added in 1.4.0

val startupInsightsConfig: StartupInsightsConfig?

The StartupInsightsConfig for the benchmark - null to not enable insights reporting.