RecompositionTracingReceiver

class RecompositionTracingReceiver : BroadcastReceiver

Receives broadcast intents to start and stop the RecompositionTracer.

RecompositionTracer is a higher overhead debugging tool that collects information about state reads and writes that affect composition into a Perfetto trace.

This receiver can be started at any point of time to start and stop the tracing. The RecompositionTracer will automatically find all existing compositions and start observations from there.

Supported actions:

• ACTION_START - Starts recomposition tracing

• ACTION_STOP - Stops recomposition tracing

Result codes:

• RESULT_CODE_SUCCESS - Successfully installed the tracer

• RESULT_CODE_ALREADY_IN_PROGRESS - Tracing is already in progress

• RESULT_CODE_FAILURE - Failed to install or stop the tracer

This receiver is generally not expected to be called directly by the user and should only be used by surrounding tooling (e.g. macrobenchmarks) to actually start and stop the tracing.

To start the receiver, use:

 adb shell am broadcast \
-a androidx.compose.tracing.action.START_RECOMPOSE_TRACING \
$package/androidx.compose.runtime.tracing.RecompositionTracingReceiver

To stop the receiver, use:

adb shell am broadcast \
-a androidx.compose.tracing.action.STOP_RECOMPOSE_TRACING \
$package/androidx.compose.runtime.tracing.RecompositionTracingReceiver

Where $package is your application's package name.

Note that enabled / disabled state for recomposition tracing is persisted until app reinstall.

Summary

const val ACTION_START: String

const val ACTION_STOP: String

const val RESULT_CODE_ALREADY_IN_PROGRESS = 2: Int

const val RESULT_CODE_FAILURE = 3: Int

const val RESULT_CODE_SUCCESS = 1: Int

RecompositionTracingReceiver()

open fun onReceive(context: Context?, intent: Intent?): Unit