Samsung Product API References for Smart TV

The Samsung Product API extends the capabilities of your application beyond those provided by the Tizen TV Web Device API.

To use Samsung Product API,
<script type="text/javascript" src="$WEBAPIS/webapis/webapis.js"></script>
should be loaded in "index.html".

The following APIs provide access to features specific to Smart TVs.

API	Description	Since
WebApi	You can access the basic definitions used in the Samsung Product API for Smart TVs.	2.3
AdInfo	You can retrieve advertising identifier information.	2.4
AppCommon	You can switch the screensaver on and off.	2.3
ASFService	You can share media content between DLNA-certified devices by initializing and using the AllShare Framework. You can retrieve a list of discovered AllShare devices with a specified ID or information about media files and folders, such as the file extension and size, and content duration.	2.3
AvInfo	You can retrieve information about the screen and audio modes of the TV. You can also set the widescreen mode.	2.3
AVPlay	You can implement audio and video playback.	2.3
AVPlayStore	You can implement audio and video playback.	2.3
Billing	You can develop a billing system for your application, to allow users to make purchases within your application.	2.4
Microphone	You can manage a microphone connected to the TV.	2.3
Network	You can access information about the network connection and connection-related events.	2.3
Preview	You can use Smart Hub Preview to show deep links to application content.	2.3
ProductInfo	You can retrieve information about the TV, such as the device unique ID (DUID), and the model code. You can also retrieve and set system configuration parameters.	2.3
Sso	You can access the single sign-on (SSO) features.	2.3
SystemInfo	You can get the system state and settings information.	6.0
TvInfo	You can manage the TV settings.	2.3
VoiceInteraction	You can use voice commands to control applications.	6.0
WidgetData	You can store data in the application secure storage.	2.3
ObjectDetection	You can input an image and get the object detection results about it.	9.0
PoseEstimation	You can input an image and get the pose estimation results about it.	9.0

Table 1. Samsung Product APIs for Smart TV

Note

The AppCommonKeyName type definition of AppCommon API is supported since 2.4, and the"Ambient" key is defined since Tizen 4.0.
The applyInvoice(), verifyInvoice(), cancelSubscription(), getProductsList(), getUserPurchaseList(), getVersion() and isServiceAvailable()methods of the BillingManager interface of the Billing API are supported since Tizen 4.0.
The read(), write() andremove() methods of the WidgetDataManager interface of the WidgetData API are supported since Tizen 4.0.

Essential Cookies

These cookies are essential as they enable you to move around the website. This category cannot be disabled.

Analytical/Performance Cookies

These cookies collect information about how you use our website. for example which pages you visit most often. All information these cookies collect is used to improve how the website works.

Functionality Cookies

These cookies allow our website to remember choices you make (such as your user name, language or the region your are in) and tailor the website to provide enhanced features and content for you.

Advertising Cookies

These cookies gather information about your browser habits. They remember that you've visited our website and share this information with other organizations such as advertisers.