クラス Sapie::CSpeakController
発話制御クラス [詳細]
#include <SpeakController.h>
Sapie::CSpeakControllerに対する継承グラフ
Public メソッド | |
| CSpeakController () | |
| コンストラクタ | |
| virtual | ~CSpeakController () |
| デストラクタ | |
| long | SpeakText (std::string text) |
| 発話指示 | |
| long | SpeakFile (std::string voiceFilePath) |
| 音声ファイル再生。 | |
| long | SetVolume (long volume) |
| 音量を設定する | |
| long | GetVolume (long &volume) |
| 音量を取得する | |
| long | SetDefaultVolume () |
| 音量をデフォルトに設定する | |
| long | CancelDefaultVolume () |
| 音量のデフォルト設定を解除する | |
| long | SetMute (bool mute) |
| ミュートを設定する | |
| long | GetMute (bool &mute) |
| ミュート設定を取得する | |
| long | CancelSpeak () |
| 実行中の発話を中止する。 | |
| long | Lock () |
| 発話をロックする。 | |
| long | Unlock () |
| 発話ロックを解除する | |
| long | GetIdleTime (unsigned long &lIdle) |
| アイドル時間を取得する | |
| long | CancelSpeakBackground (long reqno) |
| 実行中のバックグラウンド再生を停止する | |
説明
発話制御クラス関数
| long Sapie::CSpeakController::SpeakText | ( | std::string | text | ) |
発話指示
文字列 text に渡された文字列を発話する。 発話が完了した時点でOnCompleteイベントが発生する。
- 引数:
-
text 発話する内容の文字列。 文字コードUTF-8でエンコードされた日本語の文字列。
- 戻り値:
- 要求識別番号を返す。異常時は0を返す。
| long Sapie::CSpeakController::SpeakFile | ( | std::string | voiceFilePath | ) |
音声ファイル再生。
引数で渡されたパスのファイルを再生する。 再生できるファイルの形式は、以下のとおり。
- テキストファイル(文字コード: UTF-8、EUC、Shift-JIS)
- WAVファイル
- MP3ファイル
- 引数:
-
[in] voiceFilePath 登録されている音声ファイルのフルパス
- 戻り値:
- 要求識別番号を返す。異常時は0を返す。
| long Sapie::CSpeakController::SetVolume | ( | long | volume | ) |
音量を設定する
- 引数:
-
[in] volume 音量設定値。
- 戻り値:
- 正常時は0以外、異常時は0。
| long Sapie::CSpeakController::GetVolume | ( | long & | volume | ) |
音量を取得する
- 引数:
-
[out] volume 音量設定値。
- 戻り値:
- 正常時は0以外、異常時は0。
| long Sapie::CSpeakController::SetDefaultVolume | ( | ) |
音量をデフォルトに設定する
音量レベルがデフォルト以下の場合は、現状音量レベルを維持する。
- 戻り値:
- 正常時は0以外、異常時は0。
| long Sapie::CSpeakController::CancelDefaultVolume | ( | ) |
音量のデフォルト設定を解除する
音量をデフォルト設定前の音量に戻す。
- 戻り値:
- 正常時は0以外、異常時は0。
| long Sapie::CSpeakController::SetMute | ( | bool | mute | ) |
ミュートを設定する
- 引数:
-
[in] mute ミュート設定値。
- 戻り値:
- 正常時は0以外、異常時は0。
| long Sapie::CSpeakController::GetMute | ( | bool & | mute | ) |
ミュート設定を取得する
- 引数:
-
[out] mute ミュート設定値。
- 戻り値:
- 正常時は0以外、異常時は0。
| long Sapie::CSpeakController::CancelSpeak | ( | ) |
実行中の発話を中止する。
停止が完了した時点で、停止された動作に対する OnComplete イベントが 発生する。
- 戻り値:
- 正常時は0以外、異常時は0。
| long Sapie::CSpeakController::Lock | ( | ) |
発話をロックする。
- 戻り値:
- 要求識別番号を返す。異常時は0を返す。
| long Sapie::CSpeakController::Unlock | ( | ) |
発話ロックを解除する
- 戻り値:
- 正常時は0以外、異常時は0。
| long Sapie::CSpeakController::GetIdleTime | ( | unsigned long & | lIdle | ) |
アイドル時間を取得する
- 引数:
-
[out] lIdle アイドル時間
- 戻り値:
- 正常時は0以外、異常時は0。
| long Sapie::CSpeakController::CancelSpeakBackground | ( | long | reqno | ) |
実行中のバックグラウンド再生を停止する
- 引数:
-
[in] reqno SpeakFileBackgroundで返却された要求識別番号を指定する
- 戻り値:
- 正常時は0以外、異常時は0。
このクラスの説明は次のファイルから生成されました:
