All Implemented Interfaces:: org.readium.navigator.media.common.Media3Adapter , org.readium.navigator.media.common.MediaNavigator , org.readium.navigator.media.common.TextAwareMediaNavigator , org.readium.r2.navigator.Navigator , org.readium.r2.navigator.preferences.Configurable , org.readium.r2.shared.util.Closeable


public final class TtsNavigator<S extends TtsEngine.Settings, P extends TtsEngine.Preferences<P>, E extends TtsEngine.Error, V extends TtsEngine.Voice>
 implements MediaNavigator<TtsNavigator.Location, TtsNavigator.Playback, TtsNavigator.ReadingOrder>, TextAwareMediaNavigator<TtsNavigator.Location, TtsNavigator.Playback, TtsNavigator.ReadingOrder>, Media3Adapter, Configurable<S, P>

A navigator to read aloud a Publication with a TTS engine.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`TtsNavigator.Listener`
`public final class`	`TtsNavigator.Location`
`public final class`	`TtsNavigator.Playback`
`public final class`	`TtsNavigator.ReadingOrder`
`public class`	`TtsNavigator.State`
`public class`	`TtsNavigator.Error`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Set<V>`	`voices`
`private final TtsNavigator.ReadingOrder`	`readingOrder`
`private final StateFlow<TtsNavigator.Playback>`	`playback`
`private final StateFlow<TtsNavigator.Location>`	`location`
`private final StateFlow<Locator>`	`currentLocator`
`private final StateFlow<S>`	`settings`
`private final Locator`	`currentLocation`

Method Summary

Modifier and Type	Method	Description
`final Set<V>`	`getVoices()`
`TtsNavigator.ReadingOrder`	`getReadingOrder()`
`StateFlow<TtsNavigator.Playback>`	`getPlayback()`
`StateFlow<TtsNavigator.Location>`	`getLocation()`
`StateFlow<Locator>`	`getCurrentLocator()`
`StateFlow<S>`	`getSettings()`
`Locator`	`getCurrentLocation()`
`Unit`	`play()`
`Unit`	`pause()`
`final Unit`	`go(Locator locator)`
`Boolean`	`go(Locator locator, Boolean animated, Function0<Unit> completion)`
`Boolean`	`go(Link link, Boolean animated, Function0<Unit> completion)`
`Unit`	`skipToPreviousUtterance()`
`Unit`	`skipToNextUtterance()`
`Boolean`	`hasPreviousUtterance()`
`Boolean`	`hasNextUtterance()`
`Player`	`asMedia3Player()`
`Unit`	`close()`
`Unit`	`submitPreferences(P preferences)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getVoices
```
 final Set<V> getVoices()
```

getReadingOrder

 TtsNavigator.ReadingOrder getReadingOrder()

getPlayback

 StateFlow<TtsNavigator.Playback> getPlayback()

getLocation

 StateFlow<TtsNavigator.Location> getLocation()

getCurrentLocator
```
 StateFlow<Locator> getCurrentLocator()
```

getSettings
```
 StateFlow<S> getSettings()
```

getCurrentLocation
```
 Locator getCurrentLocation()
```

play
```
 Unit play()
```

pause
```
 Unit pause()
```

go
```
 final Unit go(Locator locator)
```

go

 Boolean go(Locator locator, Boolean animated, Function0<Unit> completion)

go

 Boolean go(Link link, Boolean animated, Function0<Unit> completion)

skipToPreviousUtterance
```
 Unit skipToPreviousUtterance()
```

skipToNextUtterance
```
 Unit skipToNextUtterance()
```

hasPreviousUtterance
```
 Boolean hasPreviousUtterance()
```

hasNextUtterance
```
 Boolean hasNextUtterance()
```

asMedia3Player
```
 Player asMedia3Player()
```

close
```
 Unit close()
```

submitPreferences
```
 Unit submitPreferences(P preferences)
```

Class TtsNavigator

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getVoices

getReadingOrder

getPlayback

getLocation

getCurrentLocator

getSettings

getCurrentLocation

play

pause

go

go

go

skipToPreviousUtterance

skipToNextUtterance

hasPreviousUtterance

hasNextUtterance

asMedia3Player

close

submitPreferences