client library

Classes

AnnotatedSample: Annotates a single measurement with statistical information.
FrameRecorder: Implemented by recorders that use _RecordingWidgetsBinding to receive frame life-cycle calls.
LocalBenchmarkServerClient: Implements the client REST API for the local benchmark server.
Profile: Base class for a profile collected from running a benchmark.
RawRecorder: A recorder for benchmarking raw execution of Dart code.
Recorder: Base class for benchmark recorders.
Runner: Runs the benchmark using the given recorder.
SceneBuilderRecorder: A recorder for benchmarking interactions with the engine without the framework by directly exercising SceneBuilder.
Timeseries: Series of time recordings indexed in time order.
TimeseriesStats: Various statistics about a Timeseries.
TimeseriesVisualization: Draws timeseries data and statistics on a canvas.
WidgetBuildRecorder: A recorder for measuring the performance of building a widget from scratch starting from an empty frame.
WidgetRecorder: A recorder for benchmarking interactions with the framework by creating widgets.

kProfileApplyFrame → const String: A benchmark metric that includes submitting layer and picture information to the renderer.
kProfilePrerollFrame → const String: A benchmark metric that includes frame-related computations prior to submitting layer and picture operations to the underlying renderer, such as HTML and CanvasKit. During this phase we compute transforms, clips, and other information needed for rendering.
kTotalSampleCount → const int: The total number of samples collected by a benchmark.

endMeasureFrame() → void: Signals the end of a measured frame.
registerEngineBenchmarkValueListener(String name, EngineBenchmarkValueListener listener) → void: Registers a listener for engine benchmark values labeled by name.
runBenchmarks(Map<String, RecorderFactory> benchmarks, {String initialPage = defaultInitialPage}) → Future<void>: Starts a local benchmark client to run benchmarks.
startMeasureFrame(Profile profile) → void: Adds a marker indication the beginning of frame rendering.
stopListeningToEngineBenchmarkValues(String name) → void: Stops listening to engine benchmark values under labeled by name.
timeAction(VoidCallback action) → Duration: Measures the amount of time action takes.

AsyncVoidCallback = Future<void> Function(): A function that performs asynchronous work.
EngineBenchmarkValueListener = void Function(num value): A function that receives a benchmark value from the framework.
RecorderFactory = Recorder Function(): Signature for a function that creates a Recorder.