readium-shared/org.readium.r2.shared.publication.services/LocatorService

LocatorService

interface LocatorService : Publication.Service

Locates the destination of various sources (e.g. locators, progression, etc.) in the publication.

This service can be used to implement a variety of features, such as:

Jumping to a given position or total progression, by converting it first to a Locator.
Converting a Locator which was created from an alternate manifest with a different reading order. For example, when downloading a streamed manifest or offloading a package.

Inheritors

DefaultLocatorService

Functions

open override fun close()

Closes any opened file handles, removes temporary files, etc.

abstract suspend fun locate(locator: Locator): Locator?

Locates the target of the given locator.

locateProgression

abstract suspend fun locateProgression(totalProgression: Double): Locator?

Locates the target at the given totalProgression relative to the whole publication.