Skip to main content

ScriptProfiler.stopSampling

Function

Stops the sampling profiler and writes the trace to device storage.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

stopSampling(): string

Stops the sampling profiler and writes the trace to device storage.

Returns

string

Trace identifier for the recorded trace. Treat the value as an opaque handle — the current format is the on-device filename (e.g. 1713200000000.trace), but future versions may change it. Returns an empty string if the profiler was unavailable.

Lens Studio retrieves the trace independently via the script_trace file-pull request; a Lens does not need to interpret this value.