getSignalBeacon

Returns the runtime's signal beacon API, which reports app performance milestones to the device

import { getSignalBeacon } from "@roku-sdk/runtime/signal-beacon";

const getSignalBeacon: () => SignalBeacon

Description

Returns the runtime's signal beacon API, which reports app performance milestones to the device.

Call signal with a beacon name to mark a milestone, for example "AppLaunchComplete" when the app's first screen is ready, or "AppDialogInitiate" and "AppDialogComplete" around a dialog. Roku uses these beacons to measure app launch and dialog times. The call is synchronous, and the runtime object is fetched on the first call and reused afterwards.

Example

getSignalBeacon().signal("AppLaunchComplete");