Skip to main content
Version: 8.1.3

display

The sos.display API groups together methods for getting information about the device. Primarily to find out which features it supports.

List of all display capabilities
CapabilityDescription
FILE_SYSTEM_INTERNAL_STORAGEIf device supports internal storage
FILE_SYSTEM_EXTERNAL_STORAGEIf device supports external storage
FILE_SYSTEM_FILE_CHECKSUMIf device supports file checksum calculation
FILE_SYSTEM_LINKIf device supports file system link()
FILE_SYSTEM_CREATE_ARCHIVEIf device supports creating archives in the file system
FILE_SYSTEM_ARCHIVE_EXTRACT_INFOIf device can determine a total size of a potentially extracted archive
TIMERS_PROPRIETARYIf device supports proprietary timers
VIDEO_4KIf device supports 4K video playback
BROWSERIf device supports opening browser
SERIALIf device supports serial port communication
BARCODE_SCANNERIf device supports barcode scanner setup
FRONT_OSDIf device supports Front OSD (our on-screen display)
PROXIMITY_SENSORIf device supports proximity sensor

Methods

supports()

The supports() method determines whether a queried capability is supported by the device.

supports(capability: DisplayCapability): Promise<boolean>;

Params

NameTypeDescription
capabilityDisplayCapability- The capability to check for support.

Return value

Resolves to true if the capability is supported, otherwise false.

API Example

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

void sos.onReady(async () => {
const supports = await sos.display.supports('SERIAL');

if (supports) {
console.log('This device supports serial port.');
} else {
console.log('This device does NOT support serial port.');
}
});