voiceinteraction api to use samsung product api, <script type="text/javascript" src="$webapis/webapis/webapis.js"></script> should be loaded in index.html samsung tvs allow developers to use voice commands such as navigation, search, selection and media control to control their application. the voice assistant in the tv can be bixby or other assistants. regardless of which assistant is used, the application will interact with it via the voice interaction apis. for best results, we recommend the application to be implemented with all the features that are described in this document. since : 6.0 product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol summary of interfaces and methods interface method voiceinteractionmanagerobject voiceinteractioncallback optional voiceapplicationstate onupdatestate();optional boolean onnavigation(voicenavigation voicenavigation);optional boolean onsearch(voicesearchterm voicesearchterm);optional boolean onplay();optional boolean onstop();optional boolean onpause();optional boolean onexit();optional boolean onselection(long voiceselection);optional boolean ontitleselection(domstring title);optional boolean onfastforward();optional boolean onrewind();optional domstring onsearchcollection(voicesearchterm voicesearchterm);optional boolean onchangeappstate(voiceapplicationstate state);optional boolean onchangeprevioustrack();optional boolean onchangenexttrack();optional boolean onrestart();optional boolean onskipbackward(long offsetseconds);optional boolean onskipforward(long offsetseconds);optional boolean onsetplayposition(long position);optional boolean onchangesubtitlemode(mediafunctionmode mode);optional boolean onchangeshufflemode(mediafunctionmode mode);optional boolean onchangescreenfitmode(mediafunctionmode mode);optional boolean onzoom(mediazoommode zoom);optional boolean onrotate(mediarotatemode direction);optional boolean onchange360mode(mediafunctionmode mode);optional boolean onchangerepeatmode(mediarepeatmode mode);optional boolean oncontinuewatching();optional boolean oncustom(domstring jsonobjectstring);optional domstring onrequestcontentcontext();optional boolean onadditiontolist(listitem list);optional boolean onremovalfromlist(listitem list); voicesearchterm voiceinteractioncontentcontext voiceinteractionmanager domstring getversion();void setcallback(voiceinteractioncallback callback);void listen();domstring getdatafromsearchterm(voicesearchterm voicesearchterm, voicesearchtermfield field);domstring buildcollectiondeeplinkdata(domstring appid, domstring title, domstring payload);domstring buildcollectionshowdata(domstring appid, domstring title, domstring payload, domstring thumbnail);voiceinteractioncontentcontext buildvoiceinteractioncontentcontextitem(long positionx, long positiony, domstring title, domstring[] aliasarr, boolean bfocused);domstring buildvoiceinteractioncontentcontextresponse(voiceinteractioncontentcontext[] contentcontextarr); 1. type definitions 1.1 voiceapplicationstate the application status handled via voice interaction. enum voiceapplicationstate { "none", "home", "list", "player", "setting", "search", "unknown" }; the following values are supported none : application default status. home : the status of application's home. list : the status of application showing something in list. player : the status of application playing something. setting : the status of application showing its setting. search : the status of application searching its content. unknown : the status of unknown. 1.2 voicenavigation the navigation via voice interaction. enum voicenavigation { "nav_previous", "nav_next", "nav_left", "nav_right", "nav_up", "nav_down", "nav_show_more", "nav_unknown" }; the following values are supported nav_previous : the navigation for the previous page. nav_next : the navigation for the next page. nav_left : the navigation for the left item. nav_right : the navigation for the right item. nav_up : the navigation for the upper item. nav_down : the navigation for the down item. nav_show_more : the navigation for the detail page. nav_unknown : the navigation for unknown. 1.3 voicesearchtermfield defines the fields which can be delivered via voice search. enum voicesearchtermfield { "search_term_utterance", "search_term_title", "search_term_genre", "search_term_cast", "search_term_content_type", "search_term_release_date_from", "search_term_release_date_to" }; the following values are supported search_term_utterance : the field for the full utterance. search_term_title : the field for the title. search_term_genre : the field for the genre. search_term_cast : the field for the cast. search_term_content_type : the field for the content type (movie/tvshow). search_term_release_date_from : the field for the start date time(iso 8601). search_term_release_date_to : the field for the end date time(iso 8601). 1.4 mediafunctionmode enum for the param of media control function mode. enum mediafunctionmode { "media_function_on", "media_function_off" }; the following values are supported media_function_on : media function mode on. media_function_off : media function mode off. 1.5 mediarotatemode enum for the param of rotate. enum mediarotatemode { "media_rotate_left", "media_rotate_right" }; the following values are supported media_rotate_left : media rotate mode left. media_rotate_right : media rotate mode right. 1.6 mediazoommode enum for the param of zoom. enum mediazoommode { "media_zoom_in", "media_zoom_out" }; the following values are supported media_zoom_in : media zoom mode in. media_zoom_out : media zoom mode out. 1.7 mediarepeatmode enum for the param of media repeat. enum mediarepeatmode { "media_repeat_off", "media_repeat_one", "media_repeat_all" }; the following values are supported media_repeat_off : media repeat mode off. media_repeat_one : media repeat mode for one track. media_repeat_all : media repeat mode for all tracks. 1.8 listitem enum for the param of list item. enum listitem { "list_bookmarks", "list_watch_later", "list_unknown" }; the following values are supported list_bookmarks : bookmarks list_watch_later : watchlater list_unknown : unknown 2. interfaces 2.1 voiceinteractionmanagerobject the voiceinteractionmanagerobject interface defines what is instantiated by the webapis object from the tizen platform. there will be a webapis.voiceinteraction object that allows access to the functionality of the voice interaction api. to use the voice interaction api, the following privileges must be declared in the manifest file of the application. if they are not declared, all usage of these apis are blocked, and security exceptions are thrown. to use these privileges, the minimum ‘required_version’ is 6.0. [nointerfaceobject] interface voiceinteractionmanagerobject { readonly attribute voiceinteractionmanager voiceinteraction; }; webapi implements voiceinteractionmanagerobject; since : 6.0 attributes readonly voiceinteractionmanager voiceinteraction this attribute defines the namespace for voiceinteraction apis. 2.2 voiceinteractioncallback every voice interaction application should implement a callback function, so that the assistant can operate the controls. your application can interact with voice assistant by passing the callbacks in webapis.voiceinteraction.setcallback and calling webapis.voiceinteraction.listen. except onupdatestate, onsearchcollection callbacks, the return value for the callback is the boolean flag for support or not. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. [callback, nointerfaceobject] interface voiceinteractioncallback { optional voiceapplicationstate onupdatestate(); optional boolean onnavigation(voicenavigation voicenavigation); optional boolean onsearch(voicesearchterm voicesearchterm); optional boolean onplay(); optional boolean onstop(); optional boolean onpause(); optional boolean onexit(); optional boolean onselection(long voiceselection); optional boolean ontitleselection(domstring title); optional boolean onfastforward(); optional boolean onrewind(); optional domstring onsearchcollection(voicesearchterm voicesearchterm); optional boolean onchangeappstate(voiceapplicationstate state); optional boolean onchangeprevioustrack(); optional boolean onchangenexttrack(); optional boolean onrestart(); optional boolean onskipbackward(long offsetseconds); optional boolean onskipforward(long offsetseconds); optional boolean onsetplayposition(long position); optional boolean onchangesubtitlemode(mediafunctionmode mode); optional boolean onchangeshufflemode(mediafunctionmode mode); optional boolean onchangescreenfitmode(mediafunctionmode mode); optional boolean onzoom(mediazoommode zoom); optional boolean onrotate(mediarotatemode direction); optional boolean onchange360mode(mediafunctionmode mode); optional boolean onchangerepeatmode(mediarepeatmode mode); optional boolean oncontinuewatching(); optional boolean oncustom(domstring jsonobjectstring); optional domstring onrequestcontentcontext(); optional boolean onadditiontolist(listitem list); optional boolean onremovalfromlist(listitem list); }; since : 6.0 methods onupdatestate developers must specify the current application status to the onupdatestate function to get a proper voice control from the voice assistant. this function is called right before processing every utterance, so that the voice assistant can be aware of the application status dynamically. depending on the status, the callback function called could be different. therefore, it is important to return the real status of the application. optional voiceapplicationstate onupdatestate(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol return value : optional voiceapplicationstate : the status of the current application status. "none" : application is in its default status. same as "player" status. "list" : the application is showing something in list. during this status, the utterances "play this" or "play" will call onselection(0). the utterance "previous" will call onnavigation ("nav_previous"). "player" : the application is playing a piece of content. during this status, the utterance "play this" will call onplay(). since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "list"; } }); onnavigation to support navigation controls via voice, the application should have the following callbacks. otherwise, the key event will be generated. optional boolean onnavigation(voicenavigation voicenavigation); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : voicenavigation : the navigation enumeration via voice. return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "list"; }, onnavigation : function (voicenavigation) { var bsupport = true; console.log("onnavigation : " + voicenavigation); switch(voicenavigation) { case "nav_previous ": // "previous page" break; case "nav_next": // "next page" break; case "nav_left": // "go to left" break; case "nav_right": // "move to right" break; case "nav_up": // "move up" break; case "nav_down": // "go down" break; // if there is no callback implementation for these enums, // tv will generate remote control key events: "arrowright", "arrowleft", "arrowup", "arrowdown". case "nav_show_more": // "show me more" break; default: bsupport = false; break; } return bsupport; } }); onsearch for a contents search provided by the application, it can receive a search utterance to show the search results. in order to support the search via voice, the application must be registered to samsung tv's companion search application and have the following callbacks. the onsearch parameter has a specific format. to learn more about it, please refer to the getdatafromsearchterm. some callbacks are not called by default such as onsearch. to receive all the callback signals on the development stage, request a key from samsung and apply the key to the manifest of your tizen application. the following example shows how to add the "http://developer.samsung.com/tizen/metadata/support-vif-devfeature" key to the manifest file. optional boolean onsearch(voicesearchterm voicesearchterm); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : voicesearchterm : the object contains the information via voice. return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : <?xml version="1.0" encoding="utf-8"?> <widget xmlns="http://www.w3.org/ns/widgets" tizen="http://tizen.org/ns/widgets" id="http://yourdomain/voiceinteractionwebsample" version="1.0.0" viewmodes="maximized"> <access origin="" subdomains="true"></access> < application id="abcdefghrj.voiceinteractionwebsample" package="abcdefghrj" required_version="6.0"/> <content src="index.html"/> <feature name="http://tizen.org/feature/screen.size.normal.1080.1920"/> <icon src="icon.png"/> < metadata key="http://developer.samsung.com/tizen/metadata/support-vif-dev-feature" value="true"/> <name>voiceinteractionwebsample</name> < privilege name="http://developer.samsung.com/privilege/voicecontrol"/> < privilege name="http://developer.samsung.com/privilege/microphone"/> < profile name="tv-samsung"/> </widget> @endcode @param voicesearchterm the object contains the information via voice. @see getdatafromsearchterm @throw none n/a @return boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. @code webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "home"; }, onsearch : function (voicesearchterm) { console.log("onsearch : " + json.stringify(voicesearchterm)); var title = webapis.voiceinteraction.getdatafromsearchterm(voicesearchterm, "search_term_title"); var genre = webapis.voiceinteraction.getdatafromsearchterm(voicesearchterm, "search_term_genre"); console.log("request to search " + title + ", " + genre); return true; } }); onplay supports the media control to handle playback(play). optional boolean onplay(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "player"; }, onplay : function () { // tv default action: generates the remote control key, "mediaplay". console.log("onplay called"); return true; } }); onstop supports the media control to handle playback(stop). optional boolean onstop(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "player"; }, onstop : function () { // tv default action: generates the remote control key, "mediastop". console.log("onstop called"); return true; } }); onpause supports the media control to handle playback(pause). optional boolean onpause(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "player"; }, onpause : function () { // tv default action: generates the remote control key, "mediaplaypause". console.log("onpause called"); return true; } }); onexit supports the media control to handle playback(exit). optional boolean onexit(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "player"; }, onexit : function () { // tv default action: generates the remote control key, "exit". console.log("onexit called"); return true; } }); onselection to support selection controls via voice, the application should have the following callbacks. this callback supports the ordinal, relative selection control. optional boolean onselection(long voiceselection); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : voiceselection : the relative index via voice, (ex. the last item is -1, the current item is 0, the first item is 1). return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "list"; }, onselection : function (voiceselection) { var bsupport = true; console.log("onselection : " + voiceselection); switch(voiceselection) { case -1 : // "select the last one" break; case 0 : // "select this" break; default: { if(voiceselection >= 1) // "select the first one" { // select the (voiceselection)th item // index of the first item is 1 console.log("for ordinal : " + voiceselection); } else { bsupport = false; } } break; } return bsupport; } }); ontitleselection title selection refers to an utterance in the format "select {title name}". to support the title selection via voice, the following two callbacks are required : onrequestcontentcontext and ontitleselection. the onrequestcontentcontext callback provides the information regarding the content of the screen (such as title and position) to the samsung tv. this method will be invoked at the beginning of every utterance. the response consists of positionx(int), positiony(int), title(string), alias(string array) and bfocused(bool). the title property is used for asr conversion and the other properties are used to set the priority of each title. the ontitleselection callback receives the title name from the utterance. optional boolean ontitleselection(domstring title); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : title : the string input via voice. return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "list"; }, onrequestcontentcontext : function () { console.log("onrequestcontentcontext "); var result = []; try { var item = { "positionx" : 0, "positiony" : 0, "title" : "title text1", "alias" : ["title1", "my text1"], "bfocused" : true }; result.push(item); var item2 = { "positionx" : 1, "positiony" : 0, "title" : "title text2", "alias" : ["title2", "my text2"], "bfocused" : false }; result.push(item2); result.push(webapis.voiceinteraction.buildvoiceinteractioncontentcontextitem(2,0,"title text3", ["title3", "my text3"], false)); } catch (e) { console.log("exception [" + e.code + "] name: " + e.name + " message: " + e.message); } return webapis.voiceinteraction.buildvoiceinteractioncontentcontextresponse(result); }, ontitleselection : function (title) { console.log("ontitleselection" + title); return true; } }); onfastforward supports the media control to handle playback(ff). optional boolean onfastforward(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "player"; }, onfastforward : function () { // tv default action: generates the remote control key, "mediafastforward". console.log("onfastforward called"); return true; } }); onrewind supports the media control to handle playback(rewind). optional boolean onrewind(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "player"; }, onrewind : function () { // tv default action: generates the remote control key, "mediarewind". console.log("onrewind called"); return true; } }); onsearchcollection supports the search utterance appending to the default search application. the value of the result for the search term. optional domstring onsearchcollection(voicesearchterm voicesearchterm); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : voicesearchterm : the object contains the information via voice. return value : optional domstring : the formatted value of the result for the search term. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "none"; }, onsearchcollection : function (voicesearchterm) { log("onsearchcollection : " + json.stringify(voicesearchterm)); var result = []; //appname and appid are of the ui application to get the payload on launch. result.push(webapis.voiceinteraction.buildcollectiondeeplinkdata("a1b2c3d4ef.mytizenappid", "mytizenapp", "page_id=123456&method=voice")); return json.stringify(result); } }); onchangeappstate to support the utterance of shortcut commands, the application must have the onchangeappstate callback. optional boolean onchangeappstate(voiceapplicationstate state); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : state : the application context via voice. return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "none"; }, onchangeappstate: function (state) { // tv default action: launches the samsung tv firstscreen, menu or search application. depending on the input parameter. // "go to home", "go to settings", "go to search". console.log("onchangeappstate : " + state); var bsupport = true; switch (state) { case "home": // go to app's home break; default: bsupport = false; break; } return bsupport; } }); onchangeprevioustrack in order to handle requests to move to the previous track via voice, the application should override the onchangeprevioustrack callback. optional boolean onchangeprevioustrack(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onchangeprevioustrack : function () { console.log("onchangeprevioustrack"); return true; } }); onchangenexttrack in order to handle requests to move to the next track via voice, the application should override the onchangenexttrack callback. optional boolean onchangenexttrack(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onchangenexttrack : function () { console.log("onchangenexttrack"); return true; } }); onrestart in order to handle requests to restart to this track via voice, the application should override the onrestart callback. optional boolean onrestart(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onrestart : function () { console.log("onrestart"); return true; } }); onskipbackward in order to handle requests to skip backward via voice, the application should override the onskipbackward callback. optional boolean onskipbackward(long offsetseconds); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : offsetseconds : the relative position in seconds. return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onskipbackward : function (offsetseconds) { console.log("onskipbackward : " + offsetseconds); return true; } }); onskipforward in order to handle requests to skip forward via voice, the application should override the onskipforward callback. optional boolean onskipforward(long offsetseconds); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : offsetseconds : the relative position in seconds. return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onskipforward : function (offsetseconds) { console.log("onskipforward : " + offsetseconds); return true; } }); onsetplayposition in order to handle requests to set play position via voice, the application should override the onsetplayposition callback. optional boolean onsetplayposition(long position); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : position : the absolute position in seconds. return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onsetplayposition : function (position) { console.log("onsetplayposition : " + position); return true; } }); onchangesubtitlemode in order to handle requests to turn the subtitle feature on/off via voice, the application should override the onchangesubtitlemode callback. optional boolean onchangesubtitlemode(mediafunctionmode mode); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : mode : media_function_on : turning on / media_function_off : turning off return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onchangesubtitlemode : function (mode) { console.log("onchangesubtitlemode"); switch(mode) { case "media_function_on" : console.log("function on"); break; default : console.log("function off"); break; } return true; } }); onchangeshufflemode in order to handle requests to turn the shuffle feature on/off via voice, the application should override the onchangeshufflemode callback. optional boolean onchangeshufflemode(mediafunctionmode mode); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : mode : media_function_on : turning on / media_function_off : turning off return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onchangeshufflemode : function (mode) { console.log("onchangeshufflemode"); switch(mode) { case "media_function_on" : console.log("function on"); break; default : console.log("function off"); break; } return true; } }); onchangescreenfitmode in order to handle requests to turn the screen fit feature on/off via voice, the application should override the onchangescreenfitmode callback. optional boolean onchangescreenfitmode(mediafunctionmode mode); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : mode : media_function_on : turning on / media_function_off : turning off return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onchangescreenfitmode : function (mode) { console.log("onchangescreenfitmode"); switch(mode) { case "media_function_on" : console.log("function on"); break; default : console.log("function off"); break; } return true; } }); onzoom in order to handle requests to zoom in/out via voice, the application should override the onzoom callback. optional boolean onzoom(mediazoommode zoom); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : zoom : media_zoom_in : zoom in / media_zoom_out : zoom out return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onzoom : function (zoom) { console.log("onzoom"); switch(zoom) { case "media_zoom_in" : console.log("zoom in"); break; default : console.log("zoom out"); break; } return true; } }); onrotate in order to handle requests to rotate left/right via voice, the application should override the onrotate callback. optional boolean onrotate(mediarotatemode direction); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : direction : media_rotate_left : rotate left / media_rotate_right : rotate right return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onrotate : function (direction) { console.log("onrotate"); switch(direction) { case "media_rotate_left" : console.log("rotate left"); break; default : console.log("rotate right"); break; } return true; } }); onchange360mode in order to handle requests to turn the 360 feature on/off via voice, the application should override the onchange360mode callback. optional boolean onchange360mode(mediafunctionmode mode); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : mode : media_function_on : turning on / media_function_off : turning off return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onchange360mode : function (mode) { console.log("onchange360mode"); switch(mode) { case "media_function_on" : console.log("function on"); break; default : console.log("function off"); break; } return true; } }); onchangerepeatmode in order to handle requests to change the repeat mode via voice, the application should override the onchangerepeatmode callback. optional boolean onchangerepeatmode(mediarepeatmode mode); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : mode : media_repeat_off : repeat mode off / media_repeat_one : repeat this track / media_repeat_all : repeat all tracks return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onchangerepeatmode : function (mode) { console.log("onchangerepeatmode"); switch(mode) { case "media_repeat_one" : console.log("one"); break; case "media_repeat_all" : console.log("all"); break; default : console.log("off"); break; } return true; } }); oncontinuewatching in order to handle requests to launch the application with playing the history track via voice, the application should override the oncontinuewatching callback to play the history track. this callback will be called after launching the application. optional boolean oncontinuewatching(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung device may perform its basic function. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, oncontinuewatching : function () { console.log("oncontinuewatching"); return true; } }); oncustom supports the custom voice assistant action. optional boolean oncustom(domstring jsonobjectstring); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : jsonobjectstring : the string stringified json object. return value : optional boolean : boolean value of whether the app supports this feature. voice assistant action will get the response "{"result_code":"success"}" for true, "{"result_code":"failure"}" for false/undefined. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "list"; }, oncustom : function (jsonobjectstring) { console.log("oncustom : " + jsonobjectstring); try { var customobject = json.parse(jsonobjectstring); for (var key in customobject) { if(customobject.hasownproperty(key)) { console.log("key : " + key + ", value : " + customobject[key]); } } } catch (e) { console.log("exception [" + e.code + "] name: " + e.name + " message: " + e.message); return false; } return true; } }); onrequestcontentcontext in order to support the voice title selection via voice, the application should override the onrequestcontentcontext callback, return the jsonobject string for the current content context list showing. optional domstring onrequestcontentcontext(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol return value : optional domstring : domstring containing jsonobject string for the content context list. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "list"; }, onrequestcontentcontext : function () { log("onrequestcontentcontext "); var result = []; try { var item = webapis.voiceinteraction.buildvoiceinteractioncontentcontextitem(1,1,"test", ["test set", "test title"], true); result.push(item); var item2 = webapis.voiceinteraction.buildvoiceinteractioncontentcontextitem(2,1,"test2", ["test set 2", "test title 2"], false); result.push(item2); } catch (e) { console.log("exception [" + e.code + "] name: " + e.name + " message: " + e.message); } return webapis.voiceinteraction.buildvoiceinteractioncontentcontextresponse(result); } }); onadditiontolist in order to handle requests to add this context to list via voice, the application should override the onadditiontolist callback. optional boolean onadditiontolist(listitem list); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : list : list_bookmarks : bookmarks / list_watch_later : watch later return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung tv may perform its basic function. since : 6.5 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onadditiontolist : function (list) { console.log("onadditiontolist"); switch(list) { case "list_bookmarks" : console.log("add this context to bookmarks"); break; case "list_watch_later" : console.log("add this context to watch later"); break; default : break; } return true; } }); onremovalfromlist in order to handle requests to remove this context from list via voice, the application should override the onremovalfromlist callback. optional boolean onremovalfromlist(listitem list); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : list : list_bookmarks : bookmarks / list_watch_later : watch later return value : optional boolean : boolean value of whether the app supports this feature. if a callback returns the false/undefined value, or there is no callback implementation for the utterance, samsung tv may perform its basic function. since : 6.5 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onremovalfromlist : function (list) { console.log("onremovalfromlist"); switch(list) { case "list_bookmarks" : console.log("remove this context from bookmarks"); break; case "list_watch_later" : console.log("remove this context from watch later"); break; default : break; } return true; } }); 2.3 voicesearchterm this interface represents information about the voice search term. [nointerfaceobject] interface voicesearchterm { readonly attribute domstring? utterance; readonly attribute domstring? title; readonly attribute domstring? genre; readonly attribute domstring? cast; readonly attribute domstring? contenttype; readonly attribute domstring? from; readonly attribute domstring? to; }; attributes readonly domstring utterance [nullable] the field for the full utterance. readonly domstring title [nullable] the field for the title. readonly domstring genre [nullable] the field for the genre. readonly domstring cast [nullable] the field for the cast. readonly domstring contenttype [nullable] the field for the content type (movie/tvshow). readonly domstring from [nullable] the field for the start date time(iso 8601). readonly domstring to [nullable] the field for the end date time(iso 8601). 2.4 voiceinteractioncontentcontext this interface represents information about the content context for an item. [nointerfaceobject] interface voiceinteractioncontentcontext { attribute long positionx; attribute long positiony; attribute domstring title; attribute boolean bfocused; }; attributes long positionx the field for x-axis position of the item. long positiony the field for y-axis position of the item. domstring title the field for the title of the item. boolean bfocused the field for whether this item has a focus. 2.5 voiceinteractionmanager the voiceinteractionmanager interface is the top-level interface for the voiceinteractionmanager api that provides access to the module functionalities. [nointerfaceobject] interface voiceinteractionmanager { domstring getversion(); void setcallback(voiceinteractioncallback callback); void listen(); domstring getdatafromsearchterm(voicesearchterm voicesearchterm, voicesearchtermfield field); domstring buildcollectiondeeplinkdata(domstring appid, domstring title, domstring payload); domstring buildcollectionshowdata(domstring appid, domstring title, domstring payload, domstring thumbnail); voiceinteractioncontentcontext buildvoiceinteractioncontentcontextitem(long positionx, long positiony, domstring title, domstring[] aliasarr, boolean bfocused); domstring buildvoiceinteractioncontentcontextresponse(voiceinteractioncontentcontext[] contentcontextarr); }; methods getversion this method gets the plugin's version number. domstring getversion(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol return value : domstring : domstring return value of plugin's version. exceptions : webapiexception with error type unknownerror in any other error case. with error type securityerror, if the application does not have the privilege to call this method. since : 6.0 code example : try { var version = webapis.voiceinteraction.getversion(); console.log("works with voiceinteraction [" + version + "]"); } catch (e) { console.log("exception [" + e.code + "] name: " + e.name + " message: " + e.message); } setcallback api to define callback functions for the voice interaction commands. void setcallback(voiceinteractioncallback callback); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : callback : composing the functions to be called for the voice interaction commands. exceptions : webapiexception with error type unknownerror in any other error case. with error type typemismatcherror, if an input parameter is not compatible with its expected type. with error type securityerror, if the application does not have the privilege to call this method. since : 6.0 code example : try { webapis.voiceinteraction.setcallback({ onupdatestate : function () { return "list"; }, onnavigation : function (vn) { console.log("onnavigation" + vn); return true; }, onselection : function (voiceselection) { console.log("onselection" + voiceselection); return true; } }); } catch (e) { console.log("exception [" + e.code + "] name: " + e.name + " message: " + e.message); } listen api to start listening the voice interaction commands after setting callbacks by setcallback. void listen(); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol exceptions : webapiexception with error type unknownerror in any other error case. with error type securityerror, if the application does not have the privilege to call this method. since : 6.0 code example : try { webapis.voiceinteraction.listen(); } catch (e) { console.log("exception [" + e.code + "] name: " + e.name + " message: " + e.message); } getdatafromsearchterm api to parse the searchterm from samsung side. domstring getdatafromsearchterm(voicesearchterm voicesearchterm, voicesearchtermfield field); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : voicesearchterm : the voicesearchterm from samsung side as search term. field : the field enum to get the value. return value : domstring : the result string formatted. exceptions : webapiexception with error type unknownerror in any other error case. with error type securityerror, if the application does not have the privilege to call this method. with error type invalidvalueserror, if any input parameter contains an invalid value. with error type typemismatcherror, if an input parameter is not compatible with its expected type. since : 6.0 code example : var title = webapis.voiceinteraction.getdatafromsearchterm(voicesearchterm, "search_term_title"); var genre = webapis.voiceinteraction.getdatafromsearchterm(voicesearchterm, "search_term_genre"); buildcollectiondeeplinkdata api to build data for search collection easily. domstring buildcollectiondeeplinkdata(domstring appid, domstring title, domstring payload); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : appid : the app id to be shown in the search application, and to launch the payload. title : the title to be shown in the search application. payload : the payload value to be passed with application launch request. return value : domstring : the result string formatted. exceptions : webapiexception with error type unknownerror in any other error case. with error type typemismatcherror, if any input parameter is not domstring type. with error type securityerror, if the application does not have the privilege to call this method. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "none"; }, onsearchcollection : function (voicesearchterm) { log("onsearchcollection : " + json.stringify(voicesearchterm)); var result = []; // appname and appid are of the ui application to get the payload on launch. try { result.push(webapis.voiceinteraction.buildcollectiondeeplinkdata("a1b2c3d4ef.mytizenappid", "mytizenapp", "page_id=123456&method=voice")); } catch (e) { console.log("exception [" + e.code + "] name: " + e.name + " message: " + e.message); } return json.stringify(result); } }); buildcollectionshowdata api to build data for search collection easily. domstring buildcollectionshowdata(domstring appid, domstring title, domstring payload, domstring thumbnail); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : appid : the app id to be shown in the search application, and to launch the payload. title : the title to be shown in the search application. payload : the payload value to be passed with application launch request. thumbnail : the thumbnail url, path to be shown in the search application. return value : domstring : the result string formatted. exceptions : webapiexception with error type unknownerror in any other error case. with error type typemismatcherror, if any input parameter is not domstring type. with error type securityerror, if the application does not have the privilege to call this method. since : 6.0 code example : webapis.voiceinteraction.setcallback({ onupdatestate : function () { console.log("assistant tries to get app state"); return "none"; }, onsearchcollection : function (voicesearchterm) { log("onsearchcollection : " + json.stringify(voicesearchterm)); var result = []; // appname and appid are of the ui application to get the payload on launch. try { result.push(webapis.voiceinteraction.buildcollectionshowdata("a1b2c3d4ef.mytizenappid", "mytizenapp", "page_id=123456&method=voice", "http://myservice.com/content/123456.png")); } catch (e) { console.log("exception [" + e.code + "] name: " + e.name + " message: " + e.message); } return json.stringify(result); } }); buildvoiceinteractioncontentcontextitem api to build the voiceinteractioncontentcontext of an item. voiceinteractioncontentcontext buildvoiceinteractioncontentcontextitem(long positionx, long positiony, domstring title, domstring[] aliasarr, boolean bfocused); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : positionx : x-axis position of the item. positiony : y-axis position of the item. title : the title of the item. aliasarr : the alias titles of the item. bfocused : whether this item has a focus. return value : voiceinteractioncontentcontext : the voiceinteractioncontentcontext object containing an item showing. exceptions : webapiexception with error type unknownerror in any other error case. with error type typemismatcherror, if any input parameters are not compatible with its expected type. since : 6.0 code example : onrequestcontentcontext : function () { console.log("onrequestcontentcontext "); var result = []; try { var item = webapis.voiceinteraction.buildvoiceinteractioncontentcontextitem(1,1,"test", ["test set", "test title"], true); result.push(item); } catch (e) { console.log("exception [" + e.code + "] name: " + e.name + " message: " + e.message); } return webapis.voiceinteraction.buildvoiceinteractioncontentcontextresponse(result); } buildvoiceinteractioncontentcontextresponse api to build the response of onrequestcontentcontext callback function from voiceinteractioncontentcontext. domstring buildvoiceinteractioncontentcontextresponse(voiceinteractioncontentcontext[] contentcontextarr); product : tv privilege level : public privilege : http://developer.samsung.com/privilege/voicecontrol parameters : contentcontextarr : voiceinteractioncontentcontext objects of the items showing. return value : domstring : the domstring of jsonobject string containing the items showing. exceptions : webapiexception with error type unknownerror in any other error case. with error type typemismatcherror, if any input parameters are not compatible with its expected type. since : 6.0 code example : onrequestcontentcontext : function () { console.log("onrequestcontentcontext "); var result = []; try { var item = webapis.voiceinteraction.buildvoiceinteractioncontentcontextitem(1,1,"test", ["test set", "test title"], true); result.push(item); } catch (e) { console.log("exception [" + e.code + "] name: " + e.name + " message: " + e.message); } return webapis.voiceinteraction.buildvoiceinteractioncontentcontextresponse(result); } 3. full webidl module voiceinteraction { enum voiceapplicationstate { "none", "home", "list", "player", "setting", "search", "unknown" }; enum voicenavigation { "nav_previous", "nav_next", "nav_left", "nav_right", "nav_up", "nav_down", "nav_show_more", "nav_unknown" }; enum voicesearchtermfield { "search_term_utterance", "search_term_title", "search_term_genre", "search_term_cast", "search_term_content_type", "search_term_release_date_from", "search_term_release_date_to" }; enum mediafunctionmode { "media_function_on", "media_function_off" }; enum mediarotatemode { "media_rotate_left", "media_rotate_right" }; enum mediazoommode { "media_zoom_in", "media_zoom_out" }; enum mediarepeatmode { "media_repeat_off", "media_repeat_one", "media_repeat_all" }; enum listitem { "list_bookmarks", "list_watch_later", "list_unknown" }; [nointerfaceobject] interface voiceinteractionmanagerobject { readonly attribute voiceinteractionmanager voiceinteraction; }; webapi implements voiceinteractionmanagerobject; [callback, nointerfaceobject] interface voiceinteractioncallback { optional voiceapplicationstate onupdatestate(); optional boolean onnavigation(voicenavigation voicenavigation); optional boolean onsearch(voicesearchterm voicesearchterm); optional boolean onplay(); optional boolean onstop(); optional boolean onpause(); optional boolean onexit(); optional boolean onselection(long voiceselection); optional boolean ontitleselection(domstring title); optional boolean onfastforward(); optional boolean onrewind(); optional domstring onsearchcollection(voicesearchterm voicesearchterm); optional boolean onchangeappstate(voiceapplicationstate state); optional boolean onchangeprevioustrack(); optional boolean onchangenexttrack(); optional boolean onrestart(); optional boolean onskipbackward(long offsetseconds); optional boolean onskipforward(long offsetseconds); optional boolean onsetplayposition(long position); optional boolean onchangesubtitlemode(mediafunctionmode mode); optional boolean onchangeshufflemode(mediafunctionmode mode); optional boolean onchangescreenfitmode(mediafunctionmode mode); optional boolean onzoom(mediazoommode zoom); optional boolean onrotate(mediarotatemode direction); optional boolean onchange360mode(mediafunctionmode mode); optional boolean onchangerepeatmode(mediarepeatmode mode); optional boolean oncontinuewatching(); optional boolean oncustom(domstring jsonobjectstring); optional domstring onrequestcontentcontext(); optional boolean onadditiontolist(listitem list); optional boolean onremovalfromlist(listitem list); }; [nointerfaceobject] interface voicesearchterm { readonly attribute domstring? utterance; readonly attribute domstring? title; readonly attribute domstring? genre; readonly attribute domstring? cast; readonly attribute domstring? contenttype; readonly attribute domstring? from; readonly attribute domstring? to; }; [nointerfaceobject] interface voiceinteractioncontentcontext { attribute long positionx; attribute long positiony; attribute domstring title; attribute boolean bfocused; }; [nointerfaceobject] interface voiceinteractionmanager { domstring getversion(); void setcallback(voiceinteractioncallback callback); void listen(); domstring getdatafromsearchterm(voicesearchterm voicesearchterm, voicesearchtermfield field); domstring buildcollectiondeeplinkdata(domstring appid, domstring title, domstring payload); domstring buildcollectionshowdata(domstring appid, domstring title, domstring payload, domstring thumbnail); voiceinteractioncontentcontext buildvoiceinteractioncontentcontextitem(long positionx, long positiony, domstring title, domstring[] aliasarr, boolean bfocused); domstring buildvoiceinteractioncontentcontextresponse(voiceinteractioncontentcontext[] contentcontextarr); }; };
