Package-level declarations

Types

Link copied to clipboard

Provides publication-bound caches.

Link copied to clipboard

Provides information about a publication's content protection and manages user rights.

Link copied to clipboard

Provides an easy access to a bitmap version of the publication cover.

Link copied to clipboard
open class DefaultLocatorService(val readingOrder: List<Link>, val positionsByReadingOrder: suspend () -> List<List<Locator>>) : LocatorService
Link copied to clipboard

A basic CacheService implementation keeping the cached objects in memory.

Link copied to clipboard

A CoverService which uses a provided in-memory bitmap.

Link copied to clipboard

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

Link copied to clipboard
class PerResourcePositionsService(readingOrder: List<Link>, fallbackMediaType: MediaType) : PositionsService

Simple PositionsService for a Publication which generates one position per readingOrder resource.

Link copied to clipboard

Provides a list of discrete locations in the publication, no matter what the original format is.

Link copied to clipboard

Properties

Link copied to clipboard

Credentials used to unlock this Publication.

Link copied to clipboard

Returns whether this Publication is protected by a Content Protection technology.

Link copied to clipboard

Whether the Publication has a restricted access to its resources, and can't be rendered in a Navigator.

Link copied to clipboard

The error raised when trying to unlock the Publication, if any.

Link copied to clipboard

User-facing name for this Content Protection, e.g. "Readium LCP". It could be used in a sentence such as "Protected by {name}".

Link copied to clipboard

Known technology for this type of Content Protection.

Link copied to clipboard

Manages consumption of user rights and permissions.

Functions

Link copied to clipboard
suspend fun Publication.cover(): Bitmap?

Returns the publication cover as a Bitmap at its maximum size.

Link copied to clipboard
suspend fun Publication.coverFitting(maxSize: Size): Bitmap?

Returns the publication cover as a Bitmap, scaled down to fit the given maxSize.

Link copied to clipboard
suspend fun Publication.locate(locator: Locator): Locator?

Locates the target of the given locator.

Link copied to clipboard
suspend fun Publication.locateProgression(totalProgression: Double): Locator?

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

Link copied to clipboard

Returns the list of all the positions in the publication.

Link copied to clipboard

Returns the list of all the positions in the publication, grouped by the resource reading order index.