Samsung Product API References

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 Samsung Product API supports various Samsung product types as following:

TV: Smart TV, Smart monitor, Beam projector
AV_BD: AI speaker, Blu-ray Disk player
HTV: Hospitality display

The following APIs provide access to features specific to Samsung products.

Table 1. Samsung Product APIs
API	Description	Support			Since
API	Description	TV	AV_BD	HTV	Since
WebApi	You can access the basic definitions used in the Samsung Product API for Smart TVs.	Yes	Yes	Yes	2.3
AdInfo	You can retrieve advertising identifier information.	Yes	No	No	2.4
AppCommon	You can switch the screensaver on and off.	Yes	No	Yes	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.	Yes	Yes	Yes	2.3
AvInfo	You can retrieve information about the screen and audio modes of the TV. You can also set the widescreen mode.	Yes	Yes	Yes	2.3
AVPlay	You can implement audio and video playback.	Yes	Yes	Yes	2.3
AVPlayExtension	You can implement multimedia playback with UDP or RTP for audio or video.	No	No	Yes	6.5
AVPlayStore	You can implement audio and video playback.	Yes	Yes	Yes	2.3
Billing	You can develop a billing system for your application, to allow users to make purchases within your application.	Yes	No	No	2.4
Broadcast	User can control the information that is related to the broadcast functionalities.	No	No	Yes	6.5
Microphone	You can manage a microphone connected to the TV.	Yes	No	Yes	2.3
Network	You can access information about the network connection and connection-related events.	Yes	Yes	Yes	2.3
Preview	You can use Smart Hub Preview to show deep links to application content.	Yes	Yes	Yes	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.	Yes	Yes	Yes	2.3
RemotePower	You can control remote power state in case of remote mode (background standby mode).	No	No	Yes	6.5
Sso	You can access the single sign-on (SSO) features.	Yes	Yes	No	2.3
SystemControl	You can control devices remotely.	No	No	Yes	6.5
SystemInfo	You can get the system state and settings information.	Yes	No	Yes	6.0
TvInfo	You can manage the TV settings.	Yes	Yes	Yes	2.3
VoiceInteraction	You can use voice commands to control applications.	Yes	No	No	6.0
WidgetData	You can store data in the application secure storage.	Yes	Yes	Yes	2.3

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.

Warning

If you want to use AVPlayExtension API among Samsung Product APIs, the following should be included at the "index.html" additionally.

<script type="text/javascript" src="$WEBAPIS/avplayextension/avplayextension.js"></script>