TextToSpeechKt

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 57 Open GitHub ↗

Kotlin Multiplatform Text-to-Speech library for Android, iOS, macOS and browser (Kotlin/JS & Kotlin/Wasm).

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# TextToSpeechKt
  Text-to-Speech library for Kotlin Multiplatform. Supports targets Android, iOS, macOS and browser (js and wasmJs).

[![Gradle deployment](https://github.com/Marc-JB/TextToSpeechKt/actions/workflows/deployment.yml/badge.svg)](https://github.com/Marc-JB/TextToSpeechKt/actions) 
  [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Marc-JB_TextToSpeechKt&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Marc-JB_TextToSpeechKt) 
  [![Maven Central](https://badgen.net/maven/v/maven-central/nl.marc-apps/tts)](https://central.sonatype.com/search?smo=true&namespace=nl.marc-apps&q=tts)
  [![License](https://badgen.net/github/license/Marc-JB/TextToSpeechKt)](https://github.com/Marc-JB/TextToSpeechKt/blob/main/LICENSE)

</div>

# :notebook_with_decorative_cover: Table of Contents
- [About the Project](#star2-about-the-project)
  * [Tech Stack](#space_invader-tech-stack)
  * [Features](#dart-features)
- [Getting Started](#toolbox-getting-started)
  * [Prerequisites](#bangbang-prerequisites)
  * [Installation](#gear-installation)
- [Usage](#eyes-usage)
- [License](#warning-license)
- [Acknowledgements](#gem-acknowledgements)

## :star2: About the Project
### :space_invader: Tech Stack
Uses Kotlin Multiplatform with support for the following targets:

| Platform            | Language      | Support                   |
|---------------------|---------------|---------------------------|
| Android             | Kotlin/JVM    | ✅                         |
| Browser             | Kotlin/JS     | ✅                         |
| Browser             | Kotlin/Wasm   | ✅                         |
| Browser             | JS, TS        | ❌ _Support ended in v2.0_ |
| Desktop             | Kotlin/JVM    | ⚠️ _Experimental support_ |
| iOS, MacOS          | Kotlin/Native | ✅                         |
| Other Kotlin/Native | Kotlin/Native | ❌                         |

### :dart: Features
- Kotlin Multiplatform API for text-to-speech on the following platforms: Android, iOS, macOS, js and wasmJs
- Await synthesis completion using Kotlin Coroutines
- Supports the following configuration:
   * Voice pitch & rate
   * Volume
   * Voice selection
   * Language (through voice selection)
- Compose Multiplatform support with `rememberTextToSpeechOrNull()` available in the `tts-compose` package.

## 	:toolbox: Getting Started
### :bangbang: Prerequisites
A build tool like Gradle or Maven.

### :gear: Installation
<details>
  <summary><strong>libs.versions.toml</strong></summary>

```Toml copy
  [versions]
  textToSpeech = "3.0.0"

[libraries]
  textToSpeech = { module = "nl.marc-apps:tts", version.ref = "textToSpeech" }
  # Optional: Extensions for Compose
  textToSpeech-compose = { module = "nl.marc-apps:tts-compose", version.ref = "textToSpeech" }
  ```

Make sure to configure the latest stable version: [![Maven Central](https://badgen.net/maven/v/maven-central/nl.marc-apps/tts)](https://central.sonatype.com/search?smo=true&namespace=nl.marc-apps&q=tts)

</details>

<details>
  <summary><strong>Gradle</strong></summary>

And add the library to your dependencies:  
  ```Kotlin copy
  dependencies {
      implementation("nl.marc-apps:tts:3.0.0")

// Optional: Extensions for Compose
      implementation("nl.marc-apps:tts-compose:3.0.0")
  }
  ```

Or

```Kotlin copy
  kotlin {
      sourceSets {
          commonMain.dependencies { 
              implementation("nl.marc-apps:tts:3.0.0")

// Optional: Extensions for Compose 
              implementation("nl.marc-apps:tts-compose:3.0.0")
          }
      }
  }
  ```

Make sure to configure the latest stable version: [![Maven Central](https://badgen.net/maven/v/maven-central/nl.marc-apps/tts)](https://central.sonatype.com/search?smo=true&namespace=nl.marc-apps&q=tts)

</details>

## :eyes: Usage
### Documentation files
[View documentation generated by Dokka](https://marc-jb.github.io/TextToSpeechKt/index.html)

### Demo projects 
Go to the [/demo directory](/demo) of this project.

## :warning: License
This project is published under the MIT License. Read more about this license in the `LICENSE` file.

## :gem: Acknowledgements
 - [Awesome Readme Template](https://github.com/Louis3797/awesome-readme-template)
 - [Badgen](https://badgen.net/)

TextToSpeechKt

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README