Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

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()
Promise<void> format(String mountPoint, String fileSystemType)

Formats the specified drive using one of the file systems listed below. This function returns True upon success and False upon failure:

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

  • exfat (DOS/Windows file system): Supported on Series 3 (XTx43, XDx33, HDx23, LS423, HO523) and Series 4 (XTx44, XDx34, HDx24, LS424) players with firmware versions 6.2.94 and later. Secure boot is not supported with the exFAT filesystem on firmware version 6.2.94.

  • 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

const Storage = require("@brightsign/storage");
let storage = new Storage();
storage.eject("/storage/sd").then(() => { console.log("SD card can now be removed\n"); } );
const Storage = require("@brightsign/storage");
let storage = new Storage();
storage.format("/storage/sd", "vfat").then(() => { console.log("SD card has been formatted\n");});
  • No labels