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

Package-level declarations

Types

interface Content

Provides an iterable list of content Elements.

interface ContentService : Publication.Service

Provides a way to extract the raw Content of a Publication.

ContentTokenizer

fun interface ContentTokenizer : Tokenizer<Content.Element, Content.Element>

A tokenizer splitting a Content.Element into smaller pieces.

DefaultContentService

class DefaultContentService(manifest: Manifest, container: Container<Resource>, services: PublicationServicesHolder, resourceContentIteratorFactories: List<ResourceContentIteratorFactory>) : ContentService

Default implementation of DefaultContentService, delegating the content parsing to ResourceContentIteratorFactory.

TextContentTokenizer

class TextContentTokenizer(language: Language?, overrideContentLanguage: Boolean = false, contextSnippetLength: Int = 50, textTokenizerFactory: (Language?) -> TextTokenizer) : ContentTokenizer

A ContentTokenizer using a TextTokenizer to split the text of the Content.Element into smaller portions.

Properties

contentServiceFactory

var Publication.ServicesBuilder.contentServiceFactory: ServiceFactory?

Factory to build a ContentService

Functions

fun Publication.content(start: Locator? = null): Content?

Creates a Content starting from the given start location, or the beginning of the publication when missing.