diff options
Diffstat (limited to 'SDL_Core/src/components/HMI/ffw/TTSRPC.js')
| -rw-r--r-- | SDL_Core/src/components/HMI/ffw/TTSRPC.js | 407 |
1 files changed, 0 insertions, 407 deletions
diff --git a/SDL_Core/src/components/HMI/ffw/TTSRPC.js b/SDL_Core/src/components/HMI/ffw/TTSRPC.js deleted file mode 100644 index fe205e555..000000000 --- a/SDL_Core/src/components/HMI/ffw/TTSRPC.js +++ /dev/null @@ -1,407 +0,0 @@ -/* - * Copyright (c) 2013, Ford Motor Company All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: · - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. · Redistributions in binary - * form must reproduce the above copyright notice, this list of conditions and - * the following disclaimer in the documentation and/or other materials provided - * with the distribution. · Neither the name of the Ford Motor Company nor the - * names of its contributors may be used to endorse or promote products derived - * from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ -/* - * Reference implementation of TTS component. - * - * TTS is responsible for playing sound data sent from SDLCore to notify user - * about some events happened. - */ - -FFW.TTS = FFW.RPCObserver.create( { - - /** - * If true then TTS is present and ready to communicate with SDL. - * - * @type {Boolean} - */ - isReady: true, - - /** - * Request id of current running Speak request - * - * @type {Boolean} - */ - requestId: null, - - /** - * Flag to determine if Speak request was aborted - * - * @type {Boolean} - */ - aborted: false, - - /* - * access to basic RPC functionality - */ - client: FFW.RPCClient.create( { - componentName: "TTS" - }), - - /* - * connect to RPC bus - */ - connect: function() { - - this.client.connect(this, 300); // Magic number is unique identifier for - // component - }, - - /* - * disconnect from RPC bus - */ - disconnect: function() { - - this.client.disconnect(); - }, - - /* - * Client is registered - we can send request starting from this point of - * time - */ - onRPCRegistered: function() { - - Em.Logger.log("FFW.TTS.onRPCRegistered"); - this._super(); - }, - - /* - * Client is unregistered - no more requests - */ - onRPCUnregistered: function() { - - Em.Logger.log("FFW.TTS.onRPCUnregistered"); - this._super(); - }, - - /* - * Client disconnected. - */ - onRPCDisconnected: function() { - - }, - - /* - * when result is received from RPC component this function is called It is - * the propriate place to check results of reuqest execution Please use - * previously store reuqestID to determine to which request repsonse belongs - * to - */ - onRPCResult: function(response) { - - Em.Logger.log("FFW.TTS.onRPCResult"); - this._super(); - }, - - /* - * handle RPC erros here - */ - onRPCError: function(error) { - - Em.Logger.log("FFW.TTS.onRPCError"); - this._super(); - }, - - /* - * handle RPC notifications here - */ - onRPCNotification: function(notification) { - - Em.Logger.log("FFW.TTS.onRPCNotification"); - this._super(); - }, - - /* - * handle RPC requests here - */ - onRPCRequest: function(request) { - - Em.Logger.log("FFW.TTS.onRPCRequest"); - this._super(); - - switch (request.method) { - case "TTS.Speak": { - - if (SDL.TTSPopUp.active) { - FFW.TTS.sendError(SDL.SDLModel.resultCode["REJECTED"], request.id, "TTS.Speak", "TTS in progress. Rejected."); - } else { - this.requestId = request.id; - SDL.SDLModel.onPrompt(request.params.ttsChunks); - } - - break; - } - case "TTS.SetGlobalProperties": { - - SDL.SDLModel.setProperties(request.params); - - this.sendTTSResult(SDL.SDLModel.resultCode["SUCCESS"], - request.id, - request.method); - - break; - } - case "TTS.StopSpeaking": { - - SDL.SDLModel.TTSStopSpeaking(); - - this.sendTTSResult(SDL.SDLModel.resultCode["SUCCESS"], - request.id, - request.method); - - break; - } - case "TTS.GetCapabilities": { - - Em.Logger.log("FFW." + request.method + "Response"); - - // send repsonse - var JSONMessage = { - "jsonrpc": "2.0", - "id": request.id, - "result": { - "speechCapabilities": [ - "TEXT", - "PRE_RECORDED" - ], - "prerecordedSpeechCapabilities": [ - "HELP_JINGLE", - "INITIAL_JINGLE", - "LISTEN_JINGLE", - "POSITIVE_JINGLE", - "NEGATIVE_JINGLE" - ], - "code": SDL.SDLModel.resultCode["SUCCESS"], // type (enum) - // from SDL - // protocol - "method": "TTS.GetCapabilities" - } - }; - this.client.send(JSONMessage); - - break; - } - case "TTS.PerformInteraction": - { - - SDL.SDLModel.onPrompt(request.params.initialPrompt); - - SDL.SDLModel.interactionData.helpPrompt = request.params.helpPrompt; - - var request = request; - - setTimeout(function(){ - if (SDL.InteractionChoicesView.active) { - //FFW.TTS.requestId = request.id; - SDL.SDLModel.onPrompt(request.params.timeoutPrompt); - SDL.SDLModel.interactionData.helpPrompt = null; - } - }, request.params.timeout - 2000); //Magic numer is a platform depended HMI behavior: -2 seconds for timeout prompt - - this.sendTTSResult(SDL.SDLModel.resultCode["SUCCESS"], request.id, "TTS.PerformInteraction"); - - break; - } - case "TTS.GetSupportedLanguages": { - - Em.Logger.log("FFW." + request.method + "Response"); - - var JSONMessage = { - "jsonrpc": "2.0", - "id": request.id, - "result": { - "code": SDL.SDLModel.resultCode["SUCCESS"], // type (enum) - // from SDL - "method": "TTS.GetSupportedLanguages", - "languages": SDL.SDLModel.sdlLanguagesList - } - }; - this.client.send(JSONMessage); - - break; - } - case "TTS.GetLanguage": { - - Em.Logger.log("FFW." + request.method + "Response"); - - var JSONMessage = { - "jsonrpc": "2.0", - "id": request.id, - "result": { - "code": SDL.SDLModel.resultCode["SUCCESS"], // type (enum) - // from SDL - "method": "TTS.GetLanguage", - "language": SDL.SDLModel.hmiTTSVRLanguage - } - }; - this.client.send(JSONMessage); - - break; - } - case "TTS.ChangeRegistration": { - - SDL.SDLModel.changeRegistrationTTSVR(request.params.language, request.params.appID); - - this.sendTTSResult(SDL.SDLModel.resultCode["SUCCESS"], - request.id, - request.method); - - break; - } - - case "TTS.IsReady": { - - Em.Logger.log("FFW." + request.method + "Response"); - - // send repsonse - var JSONMessage = { - "jsonrpc": "2.0", - "id": request.id, - "result": { - "available": this.get('isReady'), - "code": SDL.SDLModel.resultCode["SUCCESS"], - "method": "TTS.IsReady" - } - }; - - this.client.send(JSONMessage); - - break; - } - - default: { - // statements_def - break; - } - } - }, - - /** - * Send error response from onRPCRequest - * - * @param {Number} - * resultCode - * @param {Number} - * id - * @param {String} - * method - */ - sendError: function(resultCode, id, method, message) { - - Em.Logger.log("FFW." + method + "Response"); - - if (resultCode != SDL.SDLModel.resultCode["SUCCESS"]) { - - // send repsonse - var JSONMessage = { - "jsonrpc": "2.0", - "id": id, - "error": { - "code": resultCode, // type (enum) from SDL protocol - "message": message, - "data": { - "method": method - } - } - }; - this.client.send(JSONMessage); - } - }, - - /** - * send response from onRPCRequest - * - * @param {Number} - * resultCode - * @param {Number} - * id - * @param {String} - * method - */ - sendTTSResult: function(resultCode, id, method) { - - Em.Logger.log("FFW." + method + "Response"); - - if (resultCode === SDL.SDLModel.resultCode["SUCCESS"]) { - - // send repsonse - var JSONMessage = { - "jsonrpc": "2.0", - "id": id, - "result": { - "code": resultCode, // type (enum) from SDL protocol - "method": method - } - }; - this.client.send(JSONMessage); - } - }, - - /* - * Notifies if sdl TTS components language was changed - */ - OnLanguageChange: function(lang) { - - Em.Logger.log("FFW.TTS.OnLanguageChange"); - - // send repsonse - var JSONMessage = { - "jsonrpc": "2.0", - "method": "TTS.OnLanguageChange", - "params": { - "language": lang - } - }; - this.client.send(JSONMessage); - }, - - /** - * Initiated by TTS module to let SDL know that TTS session has started. - */ - Started: function() { - - Em.Logger.log("FFW.TTS.Started"); - - var JSONMessage = { - "jsonrpc": "2.0", - "method": "TTS.Started" - }; - this.client.send(JSONMessage); - }, - - /** - * Initiated by TTS module to let SDL know that TTS session has stopped. - */ - Stopped: function() { - - Em.Logger.log("FFW.TTS.Stopped"); - - var JSONMessage = { - "jsonrpc": "2.0", - "method": "TTS.Stopped" - }; - this.client.send(JSONMessage); - } -})
\ No newline at end of file |