osd

The sos.osd API groups together methods for working with the signageOS OSD (On Screen Display).

More information about the OSD can be found in the OSD Introduction

Front OSD Capabilities

Capability	Description
FRONT_OSD	If device supports opening OSD

If you want to check if the device supports this capability, use sos.display.supports().

Methods

showOSD()

The showOSD() method opens the OSD without typing the pin. Note: The OSD will be opened after 6 seconds.

showOSD(): Promise<void>;

Return value

A promise that resolves when the OSD is shown.

API Example

import { sos } from '@signageos/front-applet';

void sos.onReady(() => {
	sos.input.onKeyUp(async (e) => {
		if (e.keyName === 'BLUE') {
			await sos.osd.showOSD();
		}
	});
});