Skip to main content
Version: Next

IR Remote control

Remote control API allows you to enable, disable and check status of remote control of your device.

All methods​

MethodDescriptionSupported since
enable()Enables IR Remote control allows you to operate the device with IR Remote control (available alias unlock())3.0.0
disable()Disables IR Remote control allows you to operate the device with IR Remote control (available alias lock())3.0.0
isEnabled()Check is the IR Remote control is enabled or not (available alias isLocked())3.0.0

enable()​

Method enable() allows for a simple on state of remote control on your device.

danger

Android Devices Attention Required: In order to prevent Android from displaying Android homepage and thus not showing your content, you must Enable Kiosk Mode (or Lock Remote Control) either through Box device settings or through API.

Always set the Remote Control Lock to enable after the deployment.

await sos.management.remoteControl.enable(); // Returns void
// or await sos.management.remoteControl.unlock();
GitHub Example

Enable remote control on device

disable()​

Method disable() allows for a simple off state of remote control on your device.

await sos.management.remoteControl.disable(); // Returns void
// or await sos.management.remoteControl.lock();

isEnabled()​

Method isEnabled() allows to check whether the remote control is turned on or off.

await sos.management.remoteControl.isEnabled(); // Returns boolean
// or await sos.management.remoteControl.isLocked();