Tizen TV Web Device API Reference

The Tizen Web Device API, based on JavaScript, provides you advanced access to the device's platform capabilities.

You can develop rich Web applications using the Tizen Web Device APIs. You can, for example, control the application life-cycle, manage your schedules, exchange data, or make payments using NFC.

The APIs listed in this category are created by the Tizen platform to expose device capabilities to Web Applications.

Warning Some APIs, such as TVAudioControl API, may not run on a device whose TV model group does not support muting or TV channel source.

Base

API	Description	Version (Since)	TV	Supported on Emulator
Archive	This API provides interfaces and methods to create an archive file as well as various other kinds of manipulation (e.g. extract files, add a file to an archive file).	2.3	Mandatory	Yes
Filesystem	This API provides access to the file system of a device. This API might be obsolete in the future when W3C File APIs are extended to access system-sensitive files by Web applications.	1.0	Mandatory	Yes
Tizen	The base object for accessing the Tizen Web Device API.	1.0	Mandatory	Yes

Table 1. Base APIs

Application Framework

API	Description	Version (Since)	TV	Supported on Emulator
Alarm	This API provides functionality for setting and unsetting alarms.	1.0	Mandatory	Yes
Application	This API provides information about running and installed applications and controls them.	1.0	Mandatory	Yes
DataControl	This API provides interfaces and methods for accessing specific data exported by other applications.	2.4	Mandatory	Yes
MessagePort	This API provides the functionality for communication with other applications.	2.1	Mandatory	Yes
Package	This API provides information install/uninstall package and get information about installed packages.	2.1	Mandatory	Yes

Table 2. Application Framework APIs

Content

API	Description	Version (Since)	TV	Supported on Emulator
Content	This API provides functionality to discover multimedia content (such as images, videos or music).	2.0	Mandatory	Yes
Download	This API provides interfaces and methods for downloading remote objects by HTTP request.	2.0	Optional	Yes

Table 3. Content APIs

Machine Learning

API	Description	Version (Since)	TV	Supported on Emulator
Machine Learning	This API provides functions for Machine Learning features that help you to handle Neural Network Frameworks.	6.5	Mandatory	Yes
Single	This API provides functionality for a simple usage scenario of neural network models.	6.5	Mandatory	Yes
Pipeline	This API provides functionality for managing machine learning inference pipelines.	6.5	Mandatory	Yes

Table 4. Machine Learning APIs

Messaging

API	Description	Version (Since)	TV	Supported on Emulator
Push	This API provides the functionality for receiving push notifications.	3.0	Optional	Yes

Table 5. Messaging APIs

Multimedia

API	Description	Version (Since)	TV	Supported on Emulator
Exif	This API provides interfaces and methods for manipulating Exif data from JPEG file.	2.3	Mandatory	Yes
Media Controller	This API provides functions for communication between the media controller server and the media controller client.	5.0	Optional	Yes
Metadata	This API provides interfaces and methods for extracting metadata information from a media file.	6.0	Mandatory	Yes

Table 6. Multimedia APIs

Network

API	Description	Version (Since)	TV	Supported on Emulator
Bluetooth	This API enables control over Bluetooth.	6.0	Optional	No
Iotcon	This API provides functions for IoT (Internet of Things) connectivity.	3.0	Optional	Yes

Table 7. Network APIs

Security

API	Description	Version (Since)	TV	Supported on Emulator
Keymanager	This API provides interfaces and methods for a secure repository for storing, retrieving and removing the sensitive data of users and their applications.	2.4	Mandatory	Yes

Table 8. Security APIs

System

API	Description	Version (Since)	TV	Supported on Emulator
System Information	This API provides information about the device's display, network, storage and other capabilities. Getting Device Capabilities Using SystemInfo API	1.0	Mandatory	Yes
Time	This API exposes information about date, time and time zones.	1.0	Mandatory	Yes
Web Setting	This API manages the setting states of the web view in web applications.	2.2	Mandatory	Yes

Table 9. System APIs

TV Controls

API	Description	Version (Since)	TV	Supported on Emulator
TV Audio Control	This API provides interfaces and methods for control of TV audio.	2.3	Optional	No
TV Display Control	This API provides interfaces and methods to get information about the effects of stereoscopy (3D mode).	2.3	Optional	No
TV Information	This API provides interfaces and methods to get information about the TV settings.	2.4	Optional	No
TV Window	This API provides interfaces and methods to control the TV Window. For example, the main window and PIP window.	2.3	Optional	No

Table 10. TV Controls APIs

Deprecated API

API	Description	Version (Since)	Deprecated (Since)	TV	Supported on Emulator
LibTeec	This API provides interfaces and methods for a TrustZone.	4.0	6.5	Mandatory	Yes

Table 11. Deprecated APIs

Note

• The TvInfo API of Samsung Product APIs is more detailed than the TVInfo API of Tizen Web Device APIs. When getting information about TV setting, refer to the Samsung Product API, TvInfo API.
• Samsung display devices like TV and hospitality display do not support the Push API of Messaging category among Tizen Web Device APIs for TV Profile.

Except as noted, this content - excluding the Code Examples - is licensed under Creative Commons Attribution 3.0 and all of the Code Examples contained herein are licensed under BSD-3-Clause.
For details, see the Content License.

Copyright © 2024 SAMSUNG. All rights reserved.