Skip to content

Commit

Permalink
Merge pull request #40 from Picovoice/readme-updates
Browse files Browse the repository at this point in the history
Readme updates
  • Loading branch information
albho authored Aug 27, 2024
2 parents b192f01 + 3addb43 commit 57db4ac
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 20 deletions.
7 changes: 3 additions & 4 deletions binding/android/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
Orca is an on-device streaming text-to-speech engine that is designed for use with LLMs, enabling zero-latency
voice assistants. Orca is:

- Private; All voice processing runs locally.
- Private; All speech synthesis runs locally.
- Cross-Platform:
- Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64)
- Android and iOS
Expand Down Expand Up @@ -123,9 +123,8 @@ orca.delete()

### Text input

Orca accepts the 26 lowercase (a-z) and 26 uppercase (A-Z) letters of the English alphabet, numbers,
basic symbols, as well as common punctuation marks. You can get a list of all supported characters by calling the
`getValidCharacters()` method provided in the Orca SDK you are using.
Orca supports a wide range of English characters, including letters, numbers, symbols, and punctuation marks.
You can get a list of all supported characters by calling `getValidCharacters()`.
Pronunciations of characters or words not supported by this list can be achieved with
[custom pronunciations](#custom-pronunciations).

Expand Down
7 changes: 3 additions & 4 deletions binding/ios/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
Orca is an on-device streaming text-to-speech engine that is designed for use with LLMs, enabling zero-latency voice
assistants. Orca is:

- Private; All voice processing runs locally.
- Private; All speech synthesis runs locally.
- Cross-Platform:
- Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64)
- Android and iOS
Expand Down Expand Up @@ -111,9 +111,8 @@ orca.delete()

### Text input

Orca accepts the 26 lowercase (a-z) and 26 uppercase (A-Z) letters of the English alphabet, numbers,
basic symbols, as well as common punctuation marks. You can get a list of all supported characters by calling the
`validCharacters()` method provided in the Orca SDK you are using.
Orca supports a wide range of English characters, including letters, numbers, symbols, and punctuation marks.
You can get a list of all supported characters by calling `validCharacters()`.
Pronunciations of characters or words not supported by this list can be achieved with
[custom pronunciations](#custom-pronunciations).

Expand Down
7 changes: 3 additions & 4 deletions binding/nodejs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
Orca is an on-device streaming text-to-speech engine that is designed for use with LLMs, enabling zero-latency
voice assistants. Orca is:

- Private; All voice processing runs locally.
- Private; All speech synthesis runs locally.
- Cross-Platform:
- Linux (x86_64), macOS (x86_64, arm64), and Windows (x86_64)
- Android and iOS
Expand Down Expand Up @@ -105,9 +105,8 @@ orca.release()

### Text input

Orca accepts the 26 lowercase (a-z) and 26 uppercase (A-Z) letters of the English alphabet, numbers,
basic symbols, as well as common punctuation marks. You can get a list of all supported characters by calling
`validCharacters()`.
Orca supports a wide range of English characters, including letters, numbers, symbols, and punctuation marks.
You can get a list of all supported characters by calling `validCharacters()`.
Pronunciations of characters or words not supported by this list can be achieved with
[custom pronunciations](#custom-pronunciations).

Expand Down
7 changes: 3 additions & 4 deletions binding/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
Orca is an on-device streaming text-to-speech engine that is designed for use with LLMs, enabling zero-latency
voice assistants. Orca is:

- Private; All voice processing runs locally.
- Private; All speech synthesis runs locally.
- Cross-Platform:
- Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64)
- Android and iOS
Expand Down Expand Up @@ -106,9 +106,8 @@ orca.delete()

### Text input

Orca accepts the 26 lowercase (a-z) and 26 uppercase (A-Z) letters of the English alphabet, numbers,
basic symbols, as well as common punctuation marks. You can get a list of all supported characters by calling the
`valid_characters()` method provided in the Orca SDK you are using.
Orca supports a wide range of English characters, including letters, numbers, symbols, and punctuation marks.
You can get a list of all supported characters with the `.valid_characters` property.
Pronunciations of characters or words not supported by this list can be achieved with
[custom pronunciations](#custom-pronunciations).

Expand Down
2 changes: 1 addition & 1 deletion binding/web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
Orca is an on-device streaming text-to-speech engine that is designed for use with LLMs, enabling zero-latency
voice assistants. Orca is:

- Private; All voice processing runs locally.
- Private; All speech synthesis runs locally.
- Cross-Platform:
- Linux (x86_64), macOS (x86_64, arm64), and Windows (x86_64)
- Android and iOS
Expand Down
2 changes: 1 addition & 1 deletion demo/nodejs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
Orca is an on-device streaming text-to-speech engine that is designed for use with LLMs, enabling zero-latency
voice assistants. Orca is:

- Private; All voice processing runs locally.
- Private; All speech synthesis runs locally.
- Cross-Platform:
- Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64)
- Android and iOS
Expand Down
2 changes: 1 addition & 1 deletion demo/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
Orca is an on-device streaming text-to-speech engine that is designed for use with LLMs, enabling zero-latency
voice assistants. Orca is:

- Private; All voice processing runs locally.
- Private; All speech synthesis runs locally.
- Cross-Platform:
- Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64)
- Android and iOS
Expand Down
2 changes: 1 addition & 1 deletion demo/python/orca_demo_streaming.py
Original file line number Diff line number Diff line change
Expand Up @@ -297,9 +297,9 @@ def flush_audio_callback(pcm: Sequence[int]) -> None:
try:
print(f"Orca version: {orca.version}\n")

print(f"Simulated text stream:")
tokens = tokenize_text(text=text)

print(f"Simulated text stream:")
time_start_text_stream = time.time()
for token in tokens:
print(f"{token}", end="", flush=True)
Expand Down

0 comments on commit 57db4ac

Please sign in to comment.