storage

Owned by BrightSign TechDocs
Last updated: Oct 16, 2024
1 min read

The storage object provides functions related to the player storage. This object is available as of BOS 9.0.168.

system IDL

[ constructor() ] interface Storage { Promise<void> eject(String mountPoint); Promise<void> format(String mountPoint, String fileSystemType); };

ON THIS PAGE

 

Object Creation

To create a storage object, first load the brightsign/storage module using the require() method. Then create an instance of the storage class.

var storageClass = require("@brightsign/storage"); var storage = new storageClass();

Storage

Use this interface to call the following methods:

eject()
Promise<void> eject(String mountPoint)

The storage device is prepared for safe removal and may be physically ejected if that is supported by the storage device.

format()

Formats the specified drive using one of the file systems listed below:

  • vfat (FAT32, DOS/Windows file system): Readable and writable by Windows, Linux, and MacOS.

  • exfat (DOS/Windows file system): Supported on Series 3, 4 and 5 players. 

  • ext2 (Linux file system): Writable by Linux and readable by Windows and MacOS with additional software.

  • ext3 (Linux file system): Writable by Linux and readable by Windows and MacOS with additional software. 

  • ext4 (Linux file system): Writable by Linux and readable by Windows and MacOS with additional software. This is the recommended file system for SSD devices and USB hard drives.

Examples