getHdmiStatus

Get the HdmiStatus runtime API with query methods only

import { getHdmiStatus } from "@roku-sdk/runtime/hdmi-status";

getHdmiStatus(): Promise<HdmiStatus | null>

Description

Get the HdmiStatus runtime API with query methods only.

For reactive HDMI hot-plug and ALLM events, use useHdmiStatus.

Return values

Promise resolved with the safe HdmiStatus wrapper, or null when unavailable.

Types

HdmiStatus

Safe query surface exposed to app code (event handlers belong in useHdmiStatus).

type HdmiStatus = {
    apiVersion: number;
    isConnected: () => boolean;
    getHdcpVersion: () => string;
    isHdcpActive: (version: string) => boolean;
    getTVPowerStatus: () => TvPowerStatus;
};