AmiVoice® Robot SDK  0.9.10
IVoiceRecognizerBase クラスabstract
IVoiceRecognizerBase の継承関係図
IVoiceRecognizer IVoiceRecognizerOutputStream

公開メンバ関数

virtual bool VOICE_RECOGNIZER_API_CALL setup ()=0
 
virtual bool VOICE_RECOGNIZER_API_CALL start ()=0
 
virtual bool VOICE_RECOGNIZER_API_CALL stop ()=0
 
virtual void VOICE_RECOGNIZER_API_CALL cancel ()=0
 

公開変数類

VOICE_RECOGNIZER_COMPLETE complete
 認識結果終了イベント関数の型 [詳解]
 
VOICE_RECOGNIZER_UPDATED updated
 認識処理中イベント関数の型 [詳解]
 
VOICE_RECOGNIZER_UTTERANCE utterance
 発話検出/終話検出イベント関数の型 [詳解]
 
const TCHAR * serviceId
 
const TCHAR * servicePassword
 
const TCHAR * licensePath
 
const TCHAR * languageModel
 
const TCHAR * segmenterType
 
const TCHAR * segmenterProperties
 
const char ** writtens
 
const char ** spokens
 
const char * confPath
 
bool outputDebugLog
 
const TCHAR * audioLogFilename
 
int updatedInterval
 

詳解

IVoiceRecognizerBase

サーバー認識を行うためのベースクラス。

関数詳解

◆ cancel()

virtual void VOICE_RECOGNIZER_API_CALL IVoiceRecognizerBase::cancel ( )
pure virtual

cancel() 音声認識をキャンセルします。キャンセル後に認識結果がかえってくる事は有りません。 エラーが発生した場合は認識結果終了イベントがコールされます。

◆ setup()

virtual bool VOICE_RECOGNIZER_API_CALL IVoiceRecognizerBase::setup ( )
pure virtual

setup() 音声認識エンジンを初期化します。プロパティ値は setup() 前に全てセットしておく必要があります。 エラーが発生した場合は認識結果終了イベントがコールされます。

戻り値
true:初期化に成功 false: 初期化に失敗。

◆ start()

virtual bool VOICE_RECOGNIZER_API_CALL IVoiceRecognizerBase::start ( )
pure virtual

start() 音声認識サーバーに接続し、音声認識を開始します。 エラーが発生した場合は認識結果終了イベントがコールされます。

注釈
録音開始後、発話が検出できずに10秒間すぎると録音が停止します。 発話開始検出後は、20秒間録音できます。
戻り値
true:音声認識の開始に成功 false: 音声認識の開始に失敗。

◆ stop()

virtual bool VOICE_RECOGNIZER_API_CALL IVoiceRecognizerBase::stop ( )
pure virtual

stop() 音声認識を停止します。音声認識停止後に認識結果がかえってくる事があり得ます。 エラーが発生した場合は認識結果終了イベントがコールされます。

戻り値
true:音声認識の停止に成功 false: 音声認識の停止に失敗。

メンバ詳解

◆ audioLogFilename

const TCHAR* IVoiceRecognizerBase::audioLogFilename

デバッグ用に音声データをテンポラリディレクトリに出力するためのファイル名を指定します。 例: /tmp/audio.wavを出力する場合には、"audio"を指定します。

◆ complete

VOICE_RECOGNIZER_COMPLETE IVoiceRecognizerBase::complete

認識結果終了イベント関数の型

認識結果終了イベントを取得する関数ポインタを設定します。
void(VOICE_RECOGNIZER_API_CALL * VOICE_RECOGNIZER_COMPLETE)(const void *, const char *);

引数
instanceイベントが発生したインスタンス(IVoiceRecognizerのインスタンスの識別などに使用します)
json認識結果/エラーをjson形式で示します。 jsonのフォーマットについては 認識結果終了イベントについて を参照してください。

◆ confPath

const char* IVoiceRecognizerBase::confPath

端末識別用のID値などを保存するパスを設定します

  • デフォルトではHOMEディレクトリ/Recognizer.confとなります
  • 端末識別用IDが保存されませんと認識ができなくなったり、サーバー使用時間の カウントが正常にできなくなり、過請求される可能性もございますので、 設定される場合には必ず実装されるユーザーの権限で書き込み可能なパスを設定して いただくようお願い致します。
  • 開発用の端末などを変更する場合は、Recognizer.confをコピーしていただくよう お願い致します。

◆ languageModel

const TCHAR* IVoiceRecognizerBase::languageModel

言語モデルを設定します。 現在のSDKでは"a-Robot-ja"固定となります。

◆ licensePath

const TCHAR* IVoiceRecognizerBase::licensePath

ライセンスファイルへのパスを指定します https://storagedl.amivoice.com/relmanager/index.htmlよりダウンロード取得してください。

◆ outputDebugLog

bool IVoiceRecognizerBase::outputDebugLog

デバッグ用などに音声認識ライブラリを標準出力に出力します 認識結果が出力されないなどの原因調査が必要な場合などにtrueを設定します。

◆ segmenterProperties

const TCHAR* IVoiceRecognizerBase::segmenterProperties

VAD(音声切出器)のパラメータを設定します 音声の頭や語尾がうまくテキストに変換できない場合に弊社にご相談ください。

別途有料のコンサルティング契約を締結した後、 弊社から適切なパラメータをご連絡し、その値を設定します。

◆ segmenterType

const TCHAR* IVoiceRecognizerBase::segmenterType

VAD(音声切出器)のタイプを設定します。 現在のSDKでは"G4"固定となります。

◆ serviceId

const TCHAR* IVoiceRecognizerBase::serviceId

サーバーライセンス用のサービスID AmiVoice Robot SDKのサイト(https://robotsdk.amivoice.com/)より取得してください。

◆ servicePassword

const TCHAR* IVoiceRecognizerBase::servicePassword

サーバーライセンス用のサービスパスワード AmiVoice Robot SDKのサイトより取得してください。

◆ spokens

const char** IVoiceRecognizerBase::spokens

単語登録機能:単語の読み(20文字まで)の配列

  • 単語登録は1000語まで可能です。
  • 読みに設定できる文字列は、全角カタカナ及び全角ひらがなのみです。
  • writtesとspokensの配列長は一致している必要があります。
  • 指定する配列の最後には終端を表すため以下のようにNULLを指定してください。
  • spokens[0] = "表記1"; spokens[1] = "表記1"; ... spokens[N+1] = NULL;

◆ updated

VOICE_RECOGNIZER_UPDATED IVoiceRecognizerBase::updated

認識処理中イベント関数の型

認識処理中イベントを取得する関数ポインタを設定します。
void(VOICE_RECOGNIZER_API_CALL * VOICE_RECOGNIZER_UPDATED)(const void *, const char *);

引数
instanceイベントが発生したインスタンス(IVoiceRecognizerのインスタンスの識別などに使用します)
json認識処理中結果/エラーをjson形式で示します。

◆ updatedInterval

int IVoiceRecognizerBase::updatedInterval

認識中イベントの発行間隔を設定します 0 認識中イベントを発行しません。 >0 指定された時間の音声データを認識処理する毎に認識中イベントを発行します。 認識中イベントは、実際に経過した時間に応じて発行されるのではなく、認識処理された音声データの処理量に応じて発行されます。 100 未満の端数を含む値が指定された場合は、100 の倍数に切り上げた値が指定されたものとして扱います。

◆ utterance

VOICE_RECOGNIZER_UTTERANCE IVoiceRecognizerBase::utterance

発話検出/終話検出イベント関数の型

発話検出/終話検出イベントを取得する関数ポインタを設定します。
void(VOICE_RECOGNIZER_API_CALL * VOICE_RECOGNIZER_UTTERANCE)(const void *, bool);

注釈
このイベント内でIVoiceRecognizer/IVoiceRecognizerOutputStreamの stop()/ cancel()メソッドを呼ぶことは出来ません(呼んだ場合無視されます)
引数
instanceイベントが発生したインスタンス(IVoiceRecognizerのインスタンスの識別などに使用します)
utterancetrue: 発話検出 false: 終話検出

◆ writtens

const char** IVoiceRecognizerBase::writtens

単語登録機能:単語の表記(20文字まで)の配列(UTF-8)

  • 単語登録は1000語まで可能です。
  • writtesとspokensの配列長は一致している必要があります。
  • 指定する配列の最後には終端を表すため以下のようにNULLを指定してください。
  • writtes[0] = "表記1"; writtes[1] = "表記1"; ... writtes[N+1] = NULL;

このクラス詳解は次のファイルから抽出されました: