API References
api references archive you can download samsung legacy platform api reference documents here legacy platform api documents 8 23mb application api while a developer creates a samsung smart tv app and javascript function can not support functions such as volume control or channel change, application, an api supported by samsung engine, enable to use the functions with method call easily application api type lists a variety of functions for samsung smart tv app this api is defined as class, and each class consists of methods, function, property etc feature class service sf service sf service smartremote storage sf service usb tv control appcommon filesystem filesystem file nnavi taskmanager tv tv channel tv info tv window window framework date number sf core sf env sf key sf scene sf util string webapis attributefilter attributerangefilter compositefilter simplecoordinates sortmode ui api user interface defines necessary ui elements for tv app development supported by samsung smart tv feature class imageviewer imageview sf service imageviewer ui component sf ui sf ui widget sfarrowbutton sfbackground sfbutton sfcheckbox sfdatepicker sfhscroll sfimage sfkeyhelp sflabel sflist sfloading sfmaps sfpageindicator sfpopup sfprogressbar sfscroll sfslider sftextinput sftextlist sftitlebar sftogglebutton sftooltip sfwizard display api with display api, everyone can use and control contents on samsung smart tv's big screen for instance, social media, apps, multimedia can be on the screen with a remote control's smart hub button using social media, users can enjoy popular contents through youtube, video calls through skype and show what their friends like on the screen using samsung or facebook account log-in in samsung apps store, various contents are categorized into several groups such as video, game, sports, life style, information and education etc , and users can check how to use display it provides promotion display through ads when a user enjoys films, videos, music, tv re-run, they can put images on the screen using allshare and usb and apps moreover, users can enjoy web surfing, watching tv ,and they can put subtitles on the screen if it supports 3d technologies, it provides a 3d video finally, it can re-adjust tv's , video's or images' size and position feature class 3d displaycontrol screen sf env closed caption tv closedcaption pig sf service pig hardware api hardware api provides api controlling, inputting and outputting samsung smart tv's internal and external devices hardware apis supported by samsung smart tv are camera, external interworking, network, remote control, customdevice, gamepad, healthcaredevice, midi, nservice, smarthome and microphone camera api can be used for functions related to video call, nservice and smarthome are network-based apis here, nservice api is a concept of bi-directional communication in the same network, and smarthome api , connected with network, provides functions controlling electronic devices produced by samsung network api connects internet to samsung smart tv and enable users to enjoy a variety of contents, receive updated news and download several apps and information gamepad api provides functions that users can control a device inputting gamepad's key with their fingers microphone api enables to use a microphone's information, device's name, microphone's volume and effects supported by a microphone ex echo this api can used for hardware- related app each api defines class and how to use feature class camera camera external interworking customdevice customdevice customdevice frontpanel gamepad gamepad gamepad healthcaredevice healthcaredevice healthcaredevice mediasharing mediaproviderdiscoverycallback mediasharing mediaproviderfinder microphone microphone microphone multiscreen channel multiscreen channelclient multiscreen device printer smarthome network network remote control appcommon midi mididevice nservice nservice media api media api is api controlling media contents such as video/audio this api's core purpose is allowing users to use media contents effectively in samsung smart tv app functions provided by media api perform media api includes avfunction which defines functions related to avplay, audio control controlling audio through webapis audiocontrol object, and player controlling video/audio moreover, sound defines volume control functions using deviceapis audiocontrol object, is contained in media api media api's core function is, as mentioned above, is controlling media contents through media api, contents' play, pause, stop, fast forward, fast reward, mute, and volume up / down functions can be performed also, media api can adjust contents' size, bring and control dtv platform's volume information and handle a streaming function additionally, it can show av setting pop-up using sf service avsetting class feature class av function avplay avplay sf service avsetting player avplay player sf service videoplayer sf service videoplayer skip sound audio audiocontrol sf service audioplayer sf service audioplayer skip recognition api recognition api controls samsung smart tv with gestures and voice recognition recognition api's core purpose is controlling tv apps in various ways not only with a remote control recognition api contains 'gesture api' controlling samsung smart tv and 'voice recognition api 'supporting voice recognition gesture controls samsung smart tv by synchronizing users' motions and the motion already defined in samsung smart tv voice recognition controls samsung smart tv sending users' voice to an external server and receiving the text-formed output recognition's core function is checking if recognition can be supported, setting gesture's or voice recognition's event and controlling samsung smart tv app through isrecognitionsupported /is gesturerecognitionenabled /is voicerecognitionenabled , developers can check if recognition can be supported moreover, event setting is performed through subscribeevent functionexevent function recognition api's functions, mentioned above, are performed through webapis recognition object in the case of gesture, developers need to revise config xml to support a mouse if they want to develop an app controlling samsung smart tv, they can use recognition api feature class gesture recognition recognition common recognition voice recognition recognition caph api caph framework, also known as caph js, it includes all kinds of caph wui widgets and animations & effect, caph wui engine, data acceleration library caph wui widgets are the basic widgets such as label, navigator, gridwidget, listwidget, image and so on they are the widget template for creating new web application caph wui animations & effect are main support high performance animation and effect based on smart tv motion guide, including fade, transfer, rotate, scale, bounce, flip animation effect and so on the function of caph wui engine is to manage hierarchical structure for ui, manage event and manage graphics acceleration the function of data acceleration library is high level api for response time optimization all the parts above mentioned are caph framework for high performance web applications feature class animation caph core effect caph wui ani anifactory caph wui ani aniloader caph wui ani baseanimation caph wui ani bounceanimation caph wui ani fadeanimation caph wui ani groupautoflipanimation caph wui ani rotateanimation caph wui ani scaleanimation caph wui ani scalebounceanimation caph wui ani syncanimation caph wui ani transferanimation caph wui engine tween animator caph wui engine tween layer caph wui engine tween timeline data cache caph dal basecache caph dal localstoragecache data loader caph dal baseloader caph dal eventhandler caph dal preloader caph dal tagloader caph dal xhrloader device info caph platform dtv browser caph platform dtv device event handler caph app event engineeventhandler caph app event perfeventhandler framework caph caph core caph lang caph misc caph misc time rendering core caph wui engine rendering ambientlight caph wui engine rendering arealight caph wui engine rendering basepage caph wui engine rendering basicmaterial caph wui engine rendering canvasrenderer caph wui engine rendering commonobject caph wui engine rendering cssobject caph wui engine rendering cssrenderer caph wui engine rendering cubegeometry caph wui engine rendering directionallight caph wui engine rendering hemispherelight caph wui engine rendering lambertmaterial caph wui engine rendering mesh3d caph wui engine rendering phongmaterial caph wui engine rendering planegeometry caph wui engine rendering pointlight caph wui engine rendering spheregeometry caph wui engine rendering spotlight caph wui engine rendering texture caph wui engine rendering webglrenderer ui component caph wui widget basicobject caph wui widget book caph wui widget box caph wui widget button caph wui widget carousel caph wui widget colortag caph wui widget dom caph wui widget domcontainer caph wui widget gridwidget caph wui widget highlighthelper caph wui widget image caph wui widget imagegallery caph wui widget inputbox caph wui widget keycontrol caph wui widget label caph wui widget listwidget caph wui widget navigator caph wui widget panel caph wui widget progressbar caph wui widget scene caph wui widget scenemanager caph wui widget sidebar caph wui widget spinner caph wui widget strip caph wui widget thememgr caph wui widget uicontext caph wui widget view caph wui widget widgeterror widget engine caph platform dtv widget i18n caph config i18n caph i18n language pepper api pepper api reference 2013 pepper api reference 2014 allshare api allshare api reference asf 1 5 allshare api reference asf 0 4 file api file api enables applications to use the file input/output system supported by the samsung tv application engine to store data they get while they are still working, and restore the data anytime they want all applications perform file input/output operations in a common area files used in different applications may have the same name to prevent problems due to this, a directory using application id curwidget id must be created, and the file in this directory is used if multiple applications need to share data, they do it through a file path that they share file input/output operations are performed by creating a file system object and calling the interface of the object feature class file closecommonfile createcommondir deletecommondir deletecommonfile filesystem isvalidcommonpath opencommonfile openfile readall readdir readline writeall writeline convergence app api the convergence framework provides a rest-based interface allowing devices supporting the http protocol to communicate with a smart tv devices discover samsung tvs on the local network using the upnp discovery for more information on the convergence application features, see convergence app for developing tv application we can use nservice client hhp to tv application communication feature class convergence app client hhp to tv application communication constants manager event nservice nservice device nservice device event info nservice device group info nservice device manager nservice device message info common modules api the application manager provides some common object modules that all your applications can use these common modules enable your applications to run normally on the screen also, using common modules, individual applications can recognize and identify remote control button events, use plugins, and communicate with the application manager in a convenient and simple way feature class common modules cimageviewer module common popup ime effect object imecn module ime module plugin objects sso module transition effects tvkeyvalue object widget object