Skip to main content
Version: 8.1.0

osd

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

Methods​

showOSD()​

The showOSD() method opens the OSD without typing the pin.

showOSD(): Promise<void>;

API Example​

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

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