VoiceInteraction API

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";
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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);
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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;
  }
});

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);
  }
});

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;
  }
});

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;
  }
});

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);
}

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);
}

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);
}

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");

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);
  }
});

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);
  }
});

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);
}

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);
}