SpeechSynthesizer (Star-1.5 (オプションAPIリファレンス))

ネイティブの音声合成機能にアクセスして、文字列データを音声出力する機能を提供します。

音声出力する文字列を setText(String) メソッドで指定し、 play() メソッドで音声出力を開始します。音声出力時にユーザ固有の読み方を指定するには、 setRuby(String[][]) メソッドを使用します。

setAttribute(int, int) メソッドにより属性の設定が行われていない場合、音声出力を開始すると次の標準値が指定された状態で出力されます。

音声合成機能と、音声再生を行う他の機能との間でサウンドリソース競合が発生した場合、先発の再生は停止され、後発の再生要求が実行されます。

属性	標準値
`VOLUME`	100
`PITCH`	0
`SPEED`	0
`SPEECH_MODE`	プレーンモード

音声出力中にアプリケーションがサスペンドした場合は、 stop() メソッドが呼ばれたのと同じ状態になります。

記号	利用可能な文字	意味	出力
。	全角のみ	通常の文末	通常のイントネーション
?	全角、半角とも可	疑問の文末	疑問のイントネーション
!	全角、半角とも可	驚きの文末	驚きのイントネーション

タグ
音声出力したい文のうち、一部の文字列について属性や強弱を変更することが出来ます。
setAttribute(int, int) メソッドで設定した属性は、 setText(String) メソッドで指定した文字列全部に影響しますが、 setText(String) メソッドに指定する文字列にタグを挿入することで、部分的な変更が可能になります。

例えば、setText(String) メソッドの引数に "<emphasis=+50>こんばんは。" と指定した場合は、強調を +50 にして "コンバンワ" と音声出力します。

タグ記号は半角英数で、 "<" から ">" の間に次の特殊な修飾を記述して、指定します。
"<" から ">" の間にある半角空白、全角空白、タブは、無視されます。

修飾の表記	内容	指定可能な数値の範囲
<emphasis=数値>	<emphasis=数値> 以降に表記されている文字列を強調して出力します。次の emphasis 設定、または <clear> があるまで有効です。単に <emphasis> と記述した場合は、 <emphasis=0> と記述した場合と同様に振る舞います。	-100(弱く) ～ 0（初期値) ～ +100（強く)
<pitch=数値>	<pitch=数値> 以降に表記されている文字列のピッチを変更して出力します。次の pitch 設定、または <clear> があるまで有効です。単に <pitch>と記述した場合は、 <pitch=0> と記述した場合と同様に振る舞います。 `setAttribute(int, int)` メソッドによりピッチを示す属性を指定している場合は、既に指定されている値にこの数値を加算し、有効範囲でクリップした結果を実際の設定値とします。	-100（低く) ～ 0（初期値) ～ +100（高く)
<rate=数値>	<rate=数値> 以降に表記されている文字列の再生速度を変更して出力します。次の rate 設定、または <clear> があるまで有効です。単に <rate>と記述した場合は、 <rate=0> と記述した場合と同様に振る舞います。 `setAttribute(int, int)` メソッドにより再生速度を示す属性を指定している場合は、既に指定されている値にこの数値を加算し、有効範囲でクリップした結果を実際の設定値とします。	-100（遅く) ～ 0（初期値) ～ +100（早く)
<volume=数値>	<volume=数値> 以降に表記されている文字列のボリュームを変更して出力します。次の volume 設定、または <clear> があるまで有効です。単に <volume>と記述した場合は、 <volume=100> と記述した場合と同様に振る舞います。 `setAttribute(int, int)` メソッドによりボリュームを示す属性を指定している場合は、既に指定されている値にこの数値を乗算し、100で割った結果を実際の設定値とします。	0（無音) ～ +100（初期値)
<clear>	<clear> より前に表記されている装飾をクリアにします。 <emphasis=0> 、 <pitch=0> 、 <rate=0> 、 <volume=100> が設定された状態になります。
<break=数値>	挿入された箇所で、数値に指定された長さを無音で出力します。数値の単位は ms (ミリ秒) 、分解能は 100ms 、100 未満は切り捨てとなります。	0（なし) ～ +10000（長く)

数値の前に "+" 、"-" が無い場合は、"+数値" として扱います。

有効なタグ以外は、文章として扱い音声出力を行います。有効なタグとみなされないのは、次の場合です。

"<" から ">" の間に、修飾の表記で規定されている以外の文字列が設定されている場合
タグ記号を半角英数以外で記述している場合
"<" から ">" の間に、改行が入っている場合
指定可能な数値の範囲に含まれない値を指定している場合
数値に "+" 、"-" 以外の文字が含まれる場合

なお、プレーンモードにおいて、記号やタグを含んだ文字列を setText(String) へ指定すると、記号やタグはそのまま音声出力されます。
"明日は<break=500>雨です。"と指定した場合は、 "アスワブレークイコールゴヒャクアメデス"のように音声出力します。

フィールドの概要
`static int`	`PITCH` ピッチを示す属性です(=2)。
`static int`	`SPEECH_COMPLETE` 音声出力が終了したことを示すイベントタイプです(=3)。
`static int`	`SPEECH_MODE` 音声合成の動作モードを示す属性です(=4)。
`static int`	`SPEECH_MODE_PLANE` 音声合成の動作モードの属性値で、プレーンモードを表します(=0)。
`static int`	`SPEECH_MODE_TAG` 音声合成の動作モードの属性値で、タグモードを表します(=1)。
`static int`	`SPEECH_PLAYING` 音声出力が開始されたことを示すイベントタイプです(=1)。
`static int`	`SPEECH_STOPPED` 音声出力が中断されたことを示すイベントタイプです(=2)。
`static int`	`SPEED` 再生速度を示す属性です(=3)。
`static int`	`VOLUME` ボリュームを示す属性です(=1)。

メソッドの概要
`static int`	`getAvailableBytes()` 音声出力する文字列データに設定できる最大バイト数を取得します。
`static int`	`getAvailableRubyLength()` ルビ情報として登録できる最大のデータ数を取得します。
`static String`	`getEncode()` ネイティブの音声合成機能が対応している文字エンコードを取得します。
`com.docomostar.media.MediaResource`	`getMediaResource()` このクラスのインスタンスに対して呼び出すことはできません。
`static SpeechSynthesizer`	`getSpeechSynthesizer()` SpeechSynthesizer オブジェクトを取得します。
`boolean`	`isAvailableRuby(String text, String speech)` 引数で指定したルビ情報が有効かどうかを判定します。
`void`	`play()` 音声出力を開始します。
`void`	`setAttribute(int attr, int value)` 音声出力方法に関する属性値を設定します。
`void`	`setMediaListener(com.docomostar.ui.MediaListener listener)` リスナを設定します。
`void`	`setRuby(String[][] data)` ルビ情報を設定します。
`void`	`setText(String textData)` 音声出力する文字列データを設定します。
`void`	`stop()` 音声出力を停止します。

com.docomostar.opt.ui クラス SpeechSynthesizer

SPEECH_PLAYING

SPEECH_STOPPED

SPEECH_COMPLETE

VOLUME

PITCH

SPEED

SPEECH_MODE

SPEECH_MODE_PLANE

SPEECH_MODE_TAG

getSpeechSynthesizer

getMediaResource

setMediaListener

play

stop

setAttribute

setText

getAvailableBytes

getEncode

setRuby

isAvailableRuby

getAvailableRubyLength

com.docomostar.opt.ui
クラス SpeechSynthesizer