Runtime
Getters and hooks that give a Roku SDK app access to Roku OS services such as device information, app lifecycle, remote input, the file system, voice, accessibility and HDMI-CEC
Pages
| Page | Description |
|---|---|
| __resetWhenFontReadyForTests | Test-only: cancel every in-flight poll and drop the shared poll table. |
| createFontReady | Reactive helper that becomes true once font() can be measured. |
| createSubtleCrypto | Creates a minimal SubtleCrypto implementation backed by Roku runtime crypto hosts. |
| Crypto | Runtime-compatible crypto shim exposing a subset of the Web Crypto API. |
| Device info | Returns a snapshot of static device properties and dynamic methods. |
| getAppInfo | Returns the app's metadata from the runtime, such as its ID, version, title and whether it is a sideloaded developer build. |
| getAppMemoryMonitor | Resolves to an object for querying the app's memory usage and limits. |
| getAudioGuide | Returns the runtime's Audio Guide, which speaks text through the device's screen reader. |
| getComponentLibraryFactory | Resolves to the runtime's component library factory, which creates dynamic component libraries (DCLs) for a TypeScript app. |
| getFileSystem | Get a FileSystem API object exposing safe file operations. |
| getFontMeasure | Returns the runtime's font measurement API, for measuring how text will render in a given font. |
| getHdmiStatus | Get the HdmiStatus runtime API with query methods only. |
| getPerfetto | Returns the runtime's Perfetto tracing API, for adding your own events to a performance trace. |
| getRandomBytes | Returns an ArrayBuffer containing length cryptographically secure random bytes. |
| getRandomValues | Web Crypto-compatible getRandomValues: fills the provided typed array with cryptographically secure random bytes and returns it. |
| getRegistry | Resolves to the device registry, the app's persistent key-value storage. |
| getSignalBeacon | Returns the runtime's signal beacon API, which reports app performance milestones to the device. |
| getTextToSpeech | Returns the runtime's text-to-speech API, for speaking text whether or not the screen reader is on. |
| getVoiceDictation | Returns the roVoiceDictation runtime instance, used to control keyboard voice-entry sessions (start/stop listening, switch keyboard domain, report text-box state). |
| randomUUID | Generates a version 4 UUID string using DeviceInfo. |
| Subtle | The app's Web Crypto SubtleCrypto object, backed by the Roku runtime's crypto support. |
| useAppMemoryMonitor | Returns a reactive accessor for the memory warnings the runtime reports for the app. |
| useCec | Returns a reactive accessor for the device's HDMI-CEC active source status. |
| useFileSystem | Hook for file system storage events for runtime signal-aware components. |
| useHdmiStatus | Hook for reactive HDMI status and ALLM events from the Roku runtime. |
| useInput | Hook for accessing input events from the Roku runtime. |
| useLaunchConfig | Returns a reactive accessor for the parameters the app was launched with. |
| useLifecycle | Hook for accessing app lifecycle events from the Roku runtime. |
| useVoiceCommands | Hook for reactive non-dictation voice commands (play, pause, seek, etc.). |
| useVoiceDictation | Hook for reactive roVoiceDictation events. |
| whenFontReady | Resolves once font can be measured with getFontMeasure. |
| Runtime types | Types shared by several @roku-sdk/runtime exports. |
Updated about 3 hours ago
What’s Next
Did this page help you?