Skip to main content

162 docs tagged with "api"

View All Tags

Applet Basics

[Content JS API] This thread contains basic methods of every Applet used to load necessary configuration or device identifications and how to create Applet.

Applet Basics

[Content JS API] This thread contains basic methods of every Applet used to load necessary configuration or device identifications and how to create Applet.

Applet Basics

[Content JS API] This thread contains basic methods of every Applet used to load necessary configuration or device identifications and how to create Applet.

Applet Basics

[Content JS API] This thread contains basic methods of every Applet used to load necessary configuration or device identifications and how to create Applet.

Applet Resources

[Content JS API] Often there are some JavaScripts and CSS styles necessary to be loaded for your Applet. It can be libraries like jQuery or even your whole application code. For these necessities offline API for saving, storing & loading files are ready.

Applet Resources

[Content JS API] Often there are some JavaScripts and CSS styles necessary to be loaded for your Applet. It can be libraries like jQuery or even your whole application code. For these necessities offline API for saving, storing & loading files are ready.

Applet Resources

[Content JS API] Often there are some JavaScripts and CSS styles necessary to be loaded for your Applet. It can be libraries like jQuery or even your whole application code. For these necessities offline API for saving, storing & loading files are ready.

Applet Resources

[Content JS API] Often there are some JavaScripts and CSS styles necessary to be loaded for your Applet. It can be libraries like jQuery or even your whole application code. For these necessities offline API for saving, storing & loading files are ready.

Application

[Management JS API] Management API app lets you check application type and upgrade the application.

Application

[Management JS API] Management API app lets you check application type and upgrade the application.

Application

[Management JS API] Management API app lets you check application type and upgrade the application.

Application

[Management JS API] Management API app lets you check application type and upgrade the application.

Audio

[Management JS API] Management API audio allows you to check and set your devices current audio volume setting.

Audio

[Management JS API] Management API audio allows you to check and set your devices current audio volume setting.

Audio

[Management JS API] Management API audio allows you to check and set your devices current audio volume setting.

Audio

[Management JS API] Management API audio allows you to check and set your devices current audio volume setting.

Browser

[Content JS API] There are several use-cases when you need to open a web browser on a touch-enabled device (also known as a tablet). For these cases, you can use a custom web browser we built.

Browser

[Content JS API] There are several use-cases when you need to open a web browser on a touch-enabled device (also known as a tablet). For these cases, you can use a custom web browser we built.

Browser

[Content JS API] There are several use-cases when you need to open a web browser on a touch-enabled device (also known as a tablet). For these cases, you can use a custom web browser we built.

Browser

[Content JS API] There are several use-cases when you need to open a web browser on a touch-enabled device (also known as a tablet). For these cases, you can use a custom web browser we built.

Command

[Content JS API] In some cases, you might be interested in a complete log of what the device was doing during its operation. All of your business or technical logs can be stored in our storage for later usage. You can identify which events happened or even trigger self-repairing logic.

Command

[Content JS API] In some cases, you might be interested in a complete log of what the device was doing during its operation. All of your business or technical logs can be stored in our storage for later usage. You can identify which events happened or even trigger self-repairing logic.

Command

[Content JS API] In some cases, you might be interested in a complete log of what the device was doing during its operation. All of your business or technical logs can be stored in our storage for later usage. You can identify which events happened or even trigger self-repairing logic.

Command

[Content JS API] In some cases, you might be interested in a complete log of what the device was doing during its operation. All of your business or technical logs can be stored in our storage for later usage. You can identify which events happened or even trigger self-repairing logic.

Debug

[JS API] JS API debug lets you information about remote debug mode.

Debug

[Management JS API] Management API debug lets you enable and disable debug mode.

Debug

[JS API] JS API debug lets you information about remote debug mode.

Debug

[Management JS API] Management API debug lets you enable and disable debug mode.

Debug

[JS API] JS API debug lets you information about remote debug mode.

Debug

[Management JS API] Management API debug lets you enable and disable debug mode.

Debug

[JS API] JS API debug lets you information about remote debug mode.

Debug

[Management JS API] Management API debug lets you enable and disable debug mode.

Device Info

Information set to the device using the CloudControl - e.g. Location and Tags.

Device Info

Information set to the device using the CloudControl - e.g. Location and Tags.

Device Info

Information set to the device using the CloudControl - e.g. Location and Tags.

Device Info

Information set to the device using the CloudControl - e.g. Location and Tags.

Display

[Content JS API] Display API allows you to query the display to find out, which features it supports.

Display

[Content JS API] Display API allows you to query the display to find out, which features it supports.

Display

[Content JS API] Display API allows you to query the display to find out, which features it supports.

Display

[Content JS API] Display API allows you to query the display to find out, which features it supports.

File System

[Content JS API] File System API allows **low level manipulation with files and directories** in the device internal storage. File System API works with both in **internal and external storages** (USB flash drives, etc.).

File System

[Content JS API] File System API allows **low level manipulation with files and directories** in the device internal storage. File System API works with both in **internal and external storages** (USB flash drives, etc.).

File System

[Content JS API] File System API allows **low level manipulation with files and directories** in the device internal storage. File System API works with both in **internal and external storages** (USB flash drives, etc.).

File System

[Content JS API] File System API allows **low level manipulation with files and directories** in the device internal storage. File System API works with both in **internal and external storages** (USB flash drives, etc.).

Firmware

[Management JS API] Firmware management API allows you to remotely upgrade firmware version and check version on your current device.

Firmware

[Management JS API] Firmware management API allows you to remotely upgrade firmware version and check version on your current device.

Firmware

[Management JS API] Firmware management API allows you to remotely upgrade firmware version and check version on your current device.

Firmware

[Management JS API] Firmware management API allows you to remotely upgrade firmware version and check version on your current device.

Fonts

[Content JS API] When working with custom font families, you should use this method that downloads fonts into offline storage and generates the appropriate font-face definition.

Fonts

[Content JS API] When working with custom font families, you should use this method that downloads fonts into offline storage and generates the appropriate font-face definition.

Fonts

[Content JS API] When working with custom font families, you should use this method that downloads fonts into offline storage and generates the appropriate font-face definition.

Fonts

[Content JS API] When working with custom font families, you should use this method that downloads fonts into offline storage and generates the appropriate font-face definition.

Hardware

[Content JS API] Some platforms support special hardware, that can be easily managed by JS using sOS hardware API.

Hardware

[Content JS API] Some platforms support special hardware, that can be easily managed by JS using sOS hardware API.

Hardware

[Content JS API] Some platforms support special hardware, that can be easily managed by JS using sOS hardware API.

Hardware

[Content JS API] Some platforms support special hardware, that can be easily managed by JS using sOS hardware API.

Iframes

[Content JS API] We **do not recommend** to use iframes inside your Applet. However, if you have to use it, you can add full support of the sOS JS API to every one of your iframe. Just add the JS snippet script below to every page load in iframe before ending </body>. Everything will be prepared, and you can call the very same methods as described for Applet.

Iframes

[Content JS API] We **do not recommend** to use iframes inside your Applet. However, if you have to use it, you can add full support of the sOS JS API to every one of your iframe. Just add the JS snippet script below to every page load in iframe before ending </body>. Everything will be prepared, and you can call the very same methods as described for Applet.

Iframes

[Content JS API] We **do not recommend** to use iframes inside your Applet. However, if you have to use it, you can add full support of the sOS JS API to every one of your iframe. Just add the JS snippet script below to every page load in iframe before ending </body>. Everything will be prepared, and you can call the very same methods as described for Applet.

Iframes

[Content JS API] We **do not recommend** to use iframes inside your Applet. However, if you have to use it, you can add full support of the sOS JS API to every one of your iframe. Just add the JS snippet script below to every page load in iframe before ending </body>. Everything will be prepared, and you can call the very same methods as described for Applet.

IR Remote control

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

IR Remote control

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

IR Remote control

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

IR Remote control

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

IR Remote Control Input

[Content JS API] For the specific logic of an application (games for example), binding the remote control inputs can be helpful.

IR Remote Control Input

[Content JS API] For the specific logic of an application (games for example), binding the remote control inputs can be helpful.

IR Remote Control Input

[Content JS API] For the specific logic of an application (games for example), binding the remote control inputs can be helpful.

IR Remote Control Input

[Content JS API] For the specific logic of an application (games for example), binding the remote control inputs can be helpful.

JS SDK Home

[Content JS API] General introduction to signageOS JS API

JS SDK Home

[Content JS API] General introduction to signageOS JS API

JS SDK Home

[Content JS API] General introduction to signageOS JS API

JS SDK Home

[Content JS API] General introduction to signageOS JS API

Management

[Management JS API] To make the management of devices more viable and open there is a management API prepared. Through this API things like device firmware, battery status, brightness, network information, remote control, power, time or volume can be monitored.

Management

[Management JS API] To make the management of devices more viable and open there is a management API prepared. Through this API things like device firmware, battery status, brightness, network information, remote control, power, time or volume can be monitored.

Management

[Management JS API] To make the management of devices more viable and open there is a management API prepared. Through this API things like device firmware, battery status, brightness, network information, remote control, power, time or volume can be monitored.

Management

[Management JS API] To make the management of devices more viable and open there is a management API prepared. Through this API things like device firmware, battery status, brightness, network information, remote control, power, time or volume can be monitored.

Monitoring Commands

[Content JS API] All commands have type prefixed with sos. string. It is not recommended using this prefix as a type in your custom commands. Predefined monitoring commands are not dispatched until monitoring is enabled. There are two ways how to enable it.

Monitoring Commands

[Content JS API] All commands have type prefixed with sos. string. It is not recommended using this prefix as a type in your custom commands. Predefined monitoring commands are not dispatched until monitoring is enabled. There are two ways how to enable it.

Monitoring Commands

[Content JS API] All commands have type prefixed with sos. string. It is not recommended using this prefix as a type in your custom commands. Predefined monitoring commands are not dispatched until monitoring is enabled. There are two ways how to enable it.

Monitoring Commands

[Content JS API] All commands have type prefixed with sos. string. It is not recommended using this prefix as a type in your custom commands. Predefined monitoring commands are not dispatched until monitoring is enabled. There are two ways how to enable it.

Monitors

[Content JS API] Monitors provides info about connected **monitors**

Monitors

[Content JS API] Monitors provides info about connected **monitors**

Monitors

[Content JS API] Monitors provides info about connected **monitors**

Monitors

[Content JS API] Monitors provides info about connected **monitors**

Network

[Management JS API] Network management API allows you to manually set network interfaces or set back DHCP and current active network info.

Network

[Management JS API] Network management API allows you to manually set network interfaces or set back DHCP and current active network info.

Network

[Management JS API] Network management API allows you to manually set network interfaces or set back DHCP and current active network info.

Network

[Management JS API] Network management API allows you to manually set network interfaces or set back DHCP and current active network info.

Offline Cache for storing data

[Content JS API] This API provides you with approach similar to the HTML5's Local Storage, but implemented internally via native device API and completely device agnostic.

Offline Cache for storing data

[Content JS API] This API provides you with approach similar to the HTML5's Local Storage, but implemented internally via native device API and completely device agnostic.

Offline Cache for storing data

[Content JS API] This API provides you with approach similar to the HTML5's Local Storage, but implemented internally via native device API and completely device agnostic.

Offline Cache for storing data

[Content JS API] This API provides you with approach similar to the HTML5's Local Storage, but implemented internally via native device API and completely device agnostic.

OS

[Management JS API] OS management API allows you to manage information of operating system on your current device.

OS

[Management JS API] OS management API allows you to manage information of operating system on your current device.

OS

[Management JS API] OS management API allows you to manage information of operating system on your current device.

OS

[Management JS API] OS management API allows you to manage information of operating system on your current device.

OSD

[Content JS API] OSD API allows you to open OSD.

OSD

[Content JS API] OSD API allows you to open OSD.

OSD

[Content JS API] OSD API allows you to open OSD.

OSD

[Content JS API] OSD API allows you to open OSD.

Package

[Management JS API] Management API package allows you to install new packages.

Package

[Management JS API] Management API package allows you to install new packages.

Package

[Management JS API] Management API package allows you to install new packages.

Package

[Management JS API] Management API package allows you to install new packages.

Power

[Management JS API] POWER allows you to reboot the system, restart the application and set timer.

Power

[Management JS API] POWER allows you to reboot the system, restart the application and set timer.

Power

[Management JS API] POWER allows you to reboot the system, restart the application and set timer.

Power

[Management JS API] POWER allows you to reboot the system, restart the application and set timer.

Proof of Play

[Content JS API] You can use our Prooof of Play mechanism to log that some content was played on end device successfully or not. Our system includes important metadata about applet and device out-of-box to simplify solution of issues with content. You can use SignageOS to analyze, if, where, when and how long proposed content was playing in front of audience.

Proof of Play

[Content JS API] You can use our Prooof of Play mechanism to log that some content was played on end device successfully or not. Our system includes important metadata about applet and device out-of-box to simplify solution of issues with content. You can use SignageOS to analyze, if, where, when and how long proposed content was playing in front of audience.

Proof of Play

[Content JS API] You can use our Prooof of Play mechanism to log that some content was played on end device successfully or not. Our system includes important metadata about applet and device out-of-box to simplify solution of issues with content. You can use SignageOS to analyze, if, where, when and how long proposed content was playing in front of audience.

Proof of Play

[Content JS API] You can use our Prooof of Play mechanism to log that some content was played on end device successfully or not. Our system includes important metadata about applet and device out-of-box to simplify solution of issues with content. You can use SignageOS to analyze, if, where, when and how long proposed content was playing in front of audience.

Proxy

[Management JS API] Proxy management API enables you to manage currently connected proxy on your device.

Proxy

[Management JS API] Proxy management API enables you to manage currently connected proxy on your device.

Proxy

[Management JS API] Proxy management API enables you to manage currently connected proxy on your device.

Proxy

[Management JS API] Proxy management API enables you to manage currently connected proxy on your device.

Screen

[Management JS API] Management API screen allows for manipulation with screen resolution, orientation, content, set displays brightness, retrieve current brightness of your display and manipulate with the power mode. It enables you to turn display on, off and check whether the display is on/off.

Screen

[Management JS API] Management API screen allows for manipulation with screen resolution, orientation, content, set displays brightness, retrieve current brightness of your display and manipulate with the power mode. It enables you to turn display on, off and check whether the display is on/off.

Screen

[Management JS API] Management API screen allows for manipulation with screen resolution, orientation, content, set displays brightness, retrieve current brightness of your display and manipulate with the power mode. It enables you to turn display on, off and check whether the display is on/off.

Screen

[Management JS API] Management API screen allows for manipulation with screen resolution, orientation, content, set displays brightness, retrieve current brightness of your display and manipulate with the power mode. It enables you to turn display on, off and check whether the display is on/off.

Security

[Management JS API] Security management API allows you to manually set PIN code interfaces or get current PIN code.

Security

[Management JS API] Security management API allows you to manually set PIN code interfaces or get current PIN code.

Security

[Management JS API] Security management API allows you to manually set PIN code interfaces or get current PIN code.

Security

[Management JS API] Security management API allows you to manually set PIN code interfaces or get current PIN code.

Sensors

[Content JS API] We don't directly provide any sensors API but we provide a set of tools to implement your own integration of the hardware that you want to use.

Sensors

[Content JS API] We don't directly provide any sensors API but we provide a set of tools to implement your own integration of the hardware that you want to use.

Sensors

[Content JS API] We don't directly provide any sensors API but we provide a set of tools to implement your own integration of the hardware that you want to use.

Sensors

[Content JS API] We don't directly provide any sensors API but we provide a set of tools to implement your own integration of the hardware that you want to use.

Serial Port

[Content JS API] Some platforms support connecting hardware via serial port, either directly via UART or via USB. This can be leveraged to integrate a wide variety of hardware into your digital signage application.

Serial Port

[Content JS API] Some platforms support connecting hardware via serial port, either directly via UART or via USB. This can be leveraged to integrate a wide variety of hardware into your digital signage application.

Serial Port

[Content JS API] Some platforms support connecting hardware via serial port, either directly via UART or via USB. This can be leveraged to integrate a wide variety of hardware into your digital signage application.

Serial Port

[Content JS API] Some platforms support connecting hardware via serial port, either directly via UART or via USB. This can be leveraged to integrate a wide variety of hardware into your digital signage application.

Synchronized playback

[Content JS API] Sync API enables multiple devices to communicate and coordinate their behavior with each other. The communication is facilitated by the server. At any given moment, one of the devices is chosen by the server to be the master and all other devices become slaves.

Synchronized playback

[Content JS API] Sync API enables multiple devices to communicate and coordinate their behavior with each other. The communication is facilitated by the server. At any given moment, one of the devices is chosen by the server to be the master and all other devices become slaves.

Synchronized playback

[Content JS API] Sync API enables multiple devices to communicate and coordinate their behavior with each other. The communication is facilitated by the server. At any given moment, one of the devices is chosen by the server to be the master and all other devices become slaves.

Synchronized playback

[Content JS API] Sync API enables multiple devices to communicate and coordinate their behavior with each other. The communication is facilitated by the server. At any given moment, one of the devices is chosen by the server to be the master and all other devices become slaves.

Time

[Management JS API] Management API time allows you to check your devices current time with a timezone and set current time with a timezone.

Time

[Management JS API] Management API time allows you to check your devices current time with a timezone and set current time with a timezone.

Time

[Management JS API] Management API time allows you to check your devices current time with a timezone and set current time with a timezone.

Time

[Management JS API] Management API time allows you to check your devices current time with a timezone and set current time with a timezone.

Video Inputs (PiP)

[Content JS API] Display content from another device over HDMI, Display Port, or other port. PIP (Picture in Picture) functionality allows you to display content from the internal port while keeping signageOS on.

Video Inputs (PiP)

[Content JS API] Display content from another device over HDMI, Display Port, or other port. PIP (Picture in Picture) functionality allows you to display content from the internal port while keeping signageOS on.

Video Inputs (PiP)

[Content JS API] Display content from another device over HDMI, Display Port, or other port. PIP (Picture in Picture) functionality allows you to display content from the internal port while keeping signageOS on.

Video Inputs (PiP)

[Content JS API] Display content from another device over HDMI, Display Port, or other port. PIP (Picture in Picture) functionality allows you to display content from the internal port while keeping signageOS on.

Video Playback

[Content JS API] We know how crucial video is for digital signage. So we made it easy. There are several methods you can use for video manipulation.

Video Playback

[Content JS API] We know how crucial video is for digital signage. So we made it easy. There are several methods you can use for video manipulation.

Video Playback

[Content JS API] We know how crucial video is for digital signage. So we made it easy. There are several methods you can use for video manipulation.

Video Playback

[Content JS API] We know how crucial video is for digital signage. So we made it easy. There are several methods you can use for video manipulation.

Video Streams

[Content JS API] Methods to play or stop video streams.

Video Streams

[Content JS API] Methods to play or stop video streams.

Video Streams

[Content JS API] Methods to play or stop video streams.

Video Streams

[Content JS API] Methods to play or stop video streams.

Wi-Fi

[Management JS API] Wi-Fi API allows you to configure Wi-Fi, if the device supports it.

Wi-Fi

[Management JS API] Wi-Fi API allows you to configure Wi-Fi, if the device supports it.

Wi-Fi

[Management JS API] Wi-Fi API allows you to configure Wi-Fi, if the device supports it.

Wi-Fi

[Management JS API] Wi-Fi API allows you to configure Wi-Fi, if the device supports it.