All Implemented Interfaces:: kotlinx.coroutines.CoroutineScope , org.readium.r2.navigator.MediaNavigator , org.readium.r2.navigator.Navigator

@Deprecated(message = Use the new AudioNavigator from the readium-navigator-media-audio module. This class will be removed in a future 3.x release.) 
public final class MediaSessionNavigator
 implements MediaNavigator, CoroutineScope

An implementation of MediaNavigator using an Android's MediaSession compatible media player.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`MediaSessionNavigator.Listener`

Field Summary

Fields
Modifier and Type	Field	Description
`private final StateFlow<Locator>`	`currentLocator`
`private final Flow<MediaPlayback>`	`playback`
`private final Boolean`	`isPlaying`
`private final Publication`	`publication`
`private final <ERROR CLASS>`	`publicationId`
`private final MediaControllerCompat`	`controller`
`private MediaSessionNavigator.Listener`	`listener`
`private final Locator`	`currentLocation`
`private final CoroutineContext`	`coroutineContext`

Constructor Summary

Constructors
Constructor	Description
`MediaSessionNavigator(Publication publication, <ERROR CLASS> publicationId, MediaControllerCompat controller, MediaSessionNavigator.Listener listener)`

Method Summary

Modifier and Type	Method	Description
`StateFlow<Locator>`	`getCurrentLocator()`
`Flow<MediaPlayback>`	`getPlayback()`	Current playback information.
`Boolean`	`getIsPlaying()`
`final Publication`	`getPublication()`
`final <ERROR CLASS>`	`getPublicationId()`
`final MediaControllerCompat`	`getController()`
`final MediaSessionNavigator.Listener`	`getListener()`
`final Unit`	`setListener(MediaSessionNavigator.Listener listener)`
`Locator`	`getCurrentLocation()`
`CoroutineContext`	`getCoroutineContext()`
`Boolean`	`go(Locator locator, Boolean animated)`	Moves to the position in the publication corresponding to the given Locator.
`Boolean`	`go(Link link, Boolean animated)`	Moves to the position in the publication targeted by the given link.
`final Boolean`	`goForward(Boolean animated)`
`final Boolean`	`goBackward(Boolean animated)`
`Unit`	`setPlaybackRate(Double rate)`	Sets the speed of the media playback.
`Unit`	`play()`	Resumes or start the playback at the current location.
`Unit`	`pause()`	Pauses the playback.
`Unit`	`playPause()`	Toggles the playback.
`Unit`	`stop()`	Stops the playback.
`Unit`	`seekTo(Duration position)`	Seeks to the given time in the current resource.
`Unit`	`seekRelative(Duration offset)`	Seeks relatively from the current position in the current resource.

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

Constructor Detail

MediaSessionNavigator

MediaSessionNavigator(Publication publication, <ERROR CLASS> publicationId, MediaControllerCompat controller, MediaSessionNavigator.Listener listener)

Method Detail
- getCurrentLocator
```
 StateFlow<Locator> getCurrentLocator()
```
- getPlayback
```
 Flow<MediaPlayback> getPlayback()
```
  Current playback information.
- getIsPlaying
```
 Boolean getIsPlaying()
```
- getPublication
```
 final Publication getPublication()
```
- getPublicationId
```
 final <ERROR CLASS> getPublicationId()
```
- getController
```
 final MediaControllerCompat getController()
```
- getListener
```
 final MediaSessionNavigator.Listener getListener()
```
- setListener
```
 final Unit setListener(MediaSessionNavigator.Listener listener)
```
- getCurrentLocation
```
 Locator getCurrentLocation()
```
- getCoroutineContext
```
 CoroutineContext getCoroutineContext()
```
- go
```
 Boolean go(Locator locator, Boolean animated)
```
  Moves to the position in the publication corresponding to the given Locator.
- go
```
 Boolean go(Link link, Boolean animated)
```
  Moves to the position in the publication targeted by the given link.
- goForward
```
 final Boolean goForward(Boolean animated)
```
- goBackward
```
 final Boolean goBackward(Boolean animated)
```
- setPlaybackRate
```
 Unit setPlaybackRate(Double rate)
```
  Sets the speed of the media playback.
  Normal speed is 1.0 and 0.0 is incorrect.
- play
```
 Unit play()
```
  Resumes or start the playback at the current location.
- pause
```
 Unit pause()
```
  Pauses the playback.
- playPause
```
 Unit playPause()
```
  Toggles the playback. Can be useful as a handler for play/pause button.
- stop
```
 Unit stop()
```
  Stops the playback.
  Compared to pause, the navigator may clear its state in whatever way is appropriate. For example, recovering a player's resources.
- seekTo
```
 Unit seekTo(Duration position)
```
  Seeks to the given time in the current resource.
- seekRelative
```
 Unit seekRelative(Duration offset)
```
  Seeks relatively from the current position in the current resource.

Class MediaSessionNavigator

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MediaSessionNavigator

Method Detail

getCurrentLocator

getPlayback

getIsPlaying

getPublication

getPublicationId

getController

getListener

setListener

getCurrentLocation

getCoroutineContext

go

go

goForward

goBackward

setPlaybackRate

play

pause

playPause

stop

seekTo

seekRelative