voice.setKwsVoiceRecv - GiGAGenie-ServiceSDK/UserGuide GitHub Wiki

gigagenie.voice.setKwsVoiceRecv

API 설명

  • 음성 명령 수신 설정 API
  • 기본적으로 번호 선택은 OTV 채널 선택, 확인/취소 등은 기본 메시지가 전달된다.
  • setKwsVoiceRecv로 3rd Party Web 에서 전달받을 수 있다.
  • 음성 선택 번호 수신
    • 번호로 선택 가능한 UI에서 사용자가 KWS 이후 발화한 번호를 3rd Party App 에 전달하도록 설정한다.(디폴트는 OTV 채널 실행) 앱을 다시 실행하거나, 다른 웹페이지로 이동하면 디폴트로 변경된다.
    • 음성 인식 API(voice.getVoiceText)의 mode=2의 경우 3rd Party App에서 직접 요청을 하는 상황에서 사용되며 voice.setKwsVoiceRecv 는 KWS 이후 발화 해석에서 번호 선택시 voice.onSelectedIndex 로 전달한다.
  • 음성 확인/취소 수신
    • KWS 이후 발화한 내용이 확인/취소에 해당할 경우 해당 내용을 3rd Party App 에 전달하도록 설정한다. 앱을 다시 실행하거나, 다른 웹페이지로 이동하면 기본 값으로 변경된다.
    • 음성인식 API(voice.getVoiceText)의 mode=2의 경우 3rd Party App에서 직접 요청하는 상황에서 사용되며 voice.setKwsVoiceRecv는 KWS 이후 발화 해석에서 확인/취소로 수신시 voice.onVoiceCommand 로 전달한다. 확인 및 취소 발화는 voice.getVoiceText 의 내용과 동일하다.

API 구조

  • function setKwsVoiceRecv(options,callback)
  • options
    • flag: (Int, Mandatory) 음성 인식 모드 선택
      • 0: OTV 채널 실행으로 변경
      • 1: Container App에서 음성선택번호 및 확인/취소 수신
  • result_cd
    • 200: 성공
      • 500: 시스템 에러
    • extra
      • null

사용 예시

// callback
var options = {};
options.flag = 1;
gigagenie.voice.setKwsVoiceRecv(options, function (result_cd, result_msg, extra) {
    if (result_cd === 200) {
        console.log("setKwsVoiceRecv success");
    };
});