tts engine
1.0.1
Androidアプリケーションにテキストからスピーチへの機能を提供するシンプルで効率的なライブラリ。
Gradleを使用してプロジェクトにライブラリを追加します。
allprojects {
repositories {
maven { url ' https://jitpack.io ' }
}
}dependencies {
implementation ' com.github.aiyu-ayaan:tts-engine:Tag '
}ライブラリを使用することは簡単でシンプルです。コードで使用する方法の例は次のとおりです。
TextToSpeechHelper
.getInstance(activity)
.registerLifecycle(owner)
.speak(message)
.highlight()
.onHighlight { pair ->
Log .d( TAG , " speak: ${pair.first} - ${pair.second} " )
}
.onDone {
Log .d( TAG , " speak: done " )
}
.onError {
Log .d( TAG , " speak: $it " )
} activityは、TTSエンジンの初期化に使用されるアクティビティです。
owner 、TTSエンジンライフサイクルオブザーバーの登録に使用されるライフサイクルオーナーであり、ライフサイクルイベントを処理できます。
message話されるテキストです。
highlight()は、テキスト内の話し言葉を強調するオプションの方法です。
onHighlight()は、単語が話されたときに呼び出されるオプションの方法です。
onDone()は、テキストが話されたときに呼び出される方法です。
onError()は、エラーが発生したときに呼び出されるメソッドです。
MainActivity.kt
class MainActivity : ComponentActivity () {
override fun onCreate ( savedInstanceState : Bundle ? ) {
super .onCreate(savedInstanceState)
setContent {
TTSLibraryTheme {
val viewModel = MainViewModel ()
val resource = stringResource(id = R .string.des)
val text = remember { resource }
// screen
Surface (
modifier = Modifier .fillMaxSize(),
color = MaterialTheme .colorScheme.background
) {
Screen (
state = text,
viewModel = viewModel,
) {
speak(
this ,
this as LifecycleOwner ,
text,
viewModel
)
}
}
}
}
}
}
@Composable
fun Screen (
modifier : Modifier = Modifier ,
viewModel : MainViewModel ,
state : String ,
onButtonClick : () -> Unit = {},
) {
Column (
modifier = modifier
.fillMaxSize()
.padding( 16 .dp),
verticalArrangement = Arrangement . Center ,
horizontalAlignment = Alignment . CenterHorizontally
) {
val s = viewModel.getState().value
TTSText (
textAlign = TextAlign . Center ,
textHighlightBuilder = TextHighlightBuilder (
text = state,
s
),
)
Spacer (modifier = Modifier .padding( 16 .dp))
Button (onClick = onButtonClick) {
Text (text = stringResource(id = R .string.speak))
}
}
}
private fun speak (
activity : Activity ,
owner : LifecycleOwner ,
message : String ,
viewModel : MainViewModel
) {
TextToSpeechHelper
.getInstance(activity)
.registerLifecycle(owner)
.speak(message)
.highlight()
.onHighlight { pair ->
viewModel.updateState(pair)
}
.onDone {
Log .d( TAG , " speak: done " )
}
.onError {
Log .d( TAG , " speak: $it " )
}
}
MainViewModel.kt
class MainViewModel : ViewModel () {
private val state = mutableStateOf( Pair ( 0 , 0 ))
fun updateState ( pair : Pair < Int , Int >) {
state.value = pair
}
fun getState (): State < Pair < Int , Int >> = state
} class MainActivity : AppCompatActivity () {
override fun onCreate ( savedInstanceState : Bundle ? ) {
super .onCreate(savedInstanceState)
setContentView( R .layout.activity_main)
val textView = findViewById< TextView >( R .id.text_view)
val button = findViewById< Button >( R .id.button)
val message = getString( R .string.des)
button.setOnClickListener {
speak(
this ,
this as LifecycleOwner ,
message,
textView
)
}
}
private fun speak (
activity : Activity ,
owner : LifecycleOwner ,
message : String ,
textView : TextView
) {
TextToSpeechHelper
.getInstance(activity)
.registerLifecycle(owner)
.speak(message)
.highlight()
.onHighlight { pair ->
textView.highlightText(pair.first, pair.second)
}
.onDone {
Log .d( TAG , " speak: done " )
}
.onError {
Log .d( TAG , " speak: $it " )
}
}
}TextView.highlightText()は、テキストの話し言葉を強調する拡張法です。 Method 1: registerLifecycle(owner: LifecycleOwner)は、指定された所有者のライフサイクルを登録します。
Method 2: initTTS()テキストからスピーチへのエンジンを初期化します。
Method 3: speak(message: String)指定されたメッセージからスピーチを生成します。
Method 4: highlight() TextViewのテキストを強調表示します。
Method 5: removeHighlight()テキストビューのテキストからハイライトを削除します。
Method 6: destroy(action: (() -> Unit))テキストからスピーチへのエンジンを破壊し、すべてのリスナーを削除します。
Method 7: onStart(onStartListener: () -> Unit) on -startリスナーを設定します。
Method 8: onDone(onCompleteListener: () -> Unit) ondoneリスナーを設定します。
Method 9: onError(onErrorListener: (String) -> Unit) Onerrorリスナーを設定します。
Method 10: onHighlight(onHighlightListener: (Pair<Int, Int>) -> Unit) onhighlightリスナーを設定します。
Method 11: setCustomActionForDestroy(action: () -> Unit)テキストからスピーチエンジンが破壊されたときに実行されるカスタムアクションを設定します。
Method 12: setLanguage(locale: Locale)テキストからスピーチへのエンジンの言語を設定します。
Method 13: setPitchAndSpeed(pitch: Float, speed: Float)テキストからスピーチエンジンによって生成された音声のピッチと速度を設定します。
Method 14: resetPitchAndSpeed()テキストからスピーチエンジンによって生成されたスピーチのピッチと速度をデフォルト値にリセットします。
ライブラリに貢献したい場合は、リポジトリをフォークしてプルリクエストを作成してください。
MIT License
Copyright (c) 2023 Ayaan
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
`
