top

API References

Samsung Smart TV supports four main types of APIs. This section contains the documentation of all supported APIs.

Tizen Web Device API References

These APIs follow Tizen device API standard. They can be used on any device supporting the Tizen system.

Tizen Common

API Description Version
Tizen The base object for accessing the Tizen Web Device API. 1.0

Application

API Description Version
Alarm This API provides functionality for setting and unsetting alarms. 1.0
Application This API provides information about running and installed applications and controls them. 1.0
Package This API provides information install/uninstall package and get information about installed packages. 2.1

Content

API Description Version
Content This API provides functionality to discover multimedia content (such as images, videos or music). 2.0
Download This API provides interfaces and methods for downloading remote objects by HTTP request. 2.0
Exit This API provides interfaces and methods for manipulatiing Exif data from JPEG file. 2.3

Input/Output

API Description Version
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
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
Message Port This API provides the functionality for communication with other applications. 2.1

System

API Description Version
System Information This API provides information about the device’s display, network, storage and other capabilities. 1.0
Time This API exposes information about date, time and time zones. 1.0
Web Setting This API manages the setting states of the web view in web applications. 2.2

TV Controls

API Description Version
TV Audio Control This API provide interfaces and methods to control of TV audio. 2.3
TV Channel This API provides interfaces and methods for control of TV channel, such as getting TV channel list, switching TV channels, and getting information of electronic program guide(EPG). 2.3
TV Display Control This API provides interfaces and methods for getting information about the effects of stereoscopy(3D mode). 2.3
TV Input Device This API allows receiving key events generated when the user presses a key of an Input Device (for example a TV remote control). 2.3
TV Window This API provide interfaces and methods to control of TV Window(e.g. main window, PIP window). 2.3

Samsung Product API References

The Samsung Product API based on JavaScript expands capability of your application beyond Tizen Device API stamdard.
The API provides TV-specialized useful APIs and functionalities for Samsung TV devices.

API Description
WebAPI The module defines the functionalities that provide as the Samsung Smart TV Product API. Additionally, this API specifies the location in the ECMAscript hierarchy in which the Samsung Smart TV Product API is instantiated (window.webapis)
DrmInfo The module defines the functionalities of getting DRM information that are provides as the Samsung Smart TV Product API.
TvInfo The module defines the functionalities of TV settings value that are provides as the Samsung Smart TV Product API.
WidgetData The module defines the functionalities of TV settings value that are provides as the Samsung Smart TV Product API.
TvInfo The module defines the functionalities of storing data in the application’s secure storage that are provides as the Samsung Smart TV Product API.
AppCommon The module defines the functionalities of getting information that are related application that are provides as the Samsung Smart TV Product API.
Network The module defines the functionalities of getting network information that are provides as the Samsung Smart TV Product API.
AVPlay The module defines the functionalities of player that are exposed which could be easily used by app or widget developer to support multimedia playback for audio or video that are provides as the Samsung Smart TV Product API.
ASFService This allows developers to initiate the AllShare Framework
DeviceDiscovery This API allows developers to get a list of discovered AllShare devices with a specified ID. It also includes provisions for obtaining device discovery update notification.
Item The Item API provides access to the content information.
Provider This API allows developers to share media contents between DLNA devices.
ProductInfo The module defines the functionalities of getting product information that are provides as the Samsung Smart TV Product API.
Microphone The module defines the functionalities of Microphone that are provides as the Samsung Smart TV Product API.
SSO The module defines the functionalities of using SSO that are provides as the Samsung Smart TV Product API.
SmartController The module defines the functionalities of getting six-axis data of smart controller that are provides as the Samsung Smart TV Product API.
AvInfo The module defines the functionalities of TV settings value that are provides as the Samsung Smart TV Product API.
AdFramework The AdFramework module allows playback of video content with ads via the IAB VAST/VMAP standards.
Billing The module defines the functionalities of getting Billing function that are provides as the Samsung Smart TV Billing API.
Preview The module defines the functionalities of Preview that are provides as the Samsung Smart TV Product API.

W3C/HTML5 API References

Using W3C/HTML5 APIs supported on the Tizen platform, check various Tizen features.

CAPH API References

Pepper API References

Pepper API Reference for Samsung Smart TV.

API Description
Pepper_47 API Reference This page introduces Pepper API reference to the 47 version of a NaCl toolchain
Pepper_42 API Reference This page introduces Pepper API reference to the 42 version of a NaCl toolchain
Pepper_37 API Reference This page introduces Pepper API reference to the 37 version of a NaCl toolchain
Pepper_31 API Reference This page introduces Pepper API reference to the 31 version of a NaCl toolchain
Product Compatibility Matrix This page shows compatibility matrix for tizen 15 products families