Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update TTS guide related to completed callback #1917

Merged
merged 3 commits into from
May 17, 2024
Merged

Update TTS guide related to completed callback #1917

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
11293a5
Update TTS guide related to completed callback
syeonholic Jan 16, 2024
0fa890f
Update TTS C# guide related to UtteranceCompleted event handler
syeonholic Jan 16, 2024
497f952
Change capital letters and descriptions
syeonholic May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 18 additions & 1 deletion docs/application/native/guides/text-input/tts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,24 @@ To set and unset callbacks, follow these steps:

- Utterance started or completed

If you add text in TTS, that text is handled as an utterance and it obtains its own ID. After you request the TTS process to start, the text is synthesized by an engine and played out. To get a notification when an utterance is started or completed, set the respective callbacks:
If you add text in TTS, that text is handled as an utterance and it obtains its own ID. After you request the TTS process to start, the text is synthesized by an engine and played out. Each callback is invoked in the following cases:

| Callback | Invoked when | TTS state |
| :--------------------------: | :---------------------------------------: | :-------: |
| Utterance started callback | playing the synthesized audio is started | `TTS_STATE_READY` > `TTS_STATE_PLAYING` |
| Utterance completed callback | playing the synthesized audio is finished | `TTS_STATE_PLAYING` (The state is NOT changed until `tts_stop()` is called.) |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Utterance started callback | playing the synthesized audio is started | `TTS_STATE_READY` > `TTS_STATE_PLAYING` |
| Utterance completed callback | playing the synthesized audio is finished | `TTS_STATE_PLAYING` (The state is NOT changed until `tts_stop()` is called.) |
| Utterance started callback | Playing the synthesized audio is started | `TTS_STATE_READY` > `TTS_STATE_PLAYING` |
| Utterance completed callback | Playing the synthesized audio is finished | `TTS_STATE_PLAYING` (The state is NOT changed until `tts_stop()` is called.) |


> [!NOTE]
> Utterance completed callback is NOT invoked when
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> Utterance completed callback is NOT invoked when
> Utterance completed callback is NOT invoked when the following occurs:

>
> (1) your application calls `tts_stop()`.
>
> (2) playing the synthesized audio is stopped by other application.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> (1) your application calls `tts_stop()`.
>
> (2) playing the synthesized audio is stopped by other application.
> (1) Your application calls `tts_stop()`.
>
> (2) Playing the synthesized audio is stopped by another application.

>
> Although the utterance completed callback is not invoked, a state changed callback will be invoked. (The state will be changed from `TTS_STATE_PLAYING` to `TTS_STATE_READY`.)


To get a notification when an utterance is started or completed, set the respective callbacks:

```cpp
/* Started callback */
Expand Down