colibrio-reader-framework/com.colibrio.readingsystem.base/PublicationLoadConfiguration/Epub

Epub

class Epub(val publicationDataSource: RandomAccessDataSource, val readingSessionOptions: ReadingSessionOptions, val readerPublicationOptions: EpubReaderPublicationOptions = EpubReaderPublicationOptions(), val encryptionMethods: List<EncryptionMethod> = emptyList(), val zipResourceProviderOptions: ZipResourceProviderOptions = ZipResourceProviderOptions()) : PublicationLoadConfiguration

Deprecated

Use EpubRandomAccessDataSourceLoadConfig or EpubResourceProviderLoadConfig instead

Used to load EPUB publications using a RandomAccessDataSource instance.

Constructors

Link copied to clipboard
fun Epub(publicationDataSource: RandomAccessDataSource, readingSessionOptions: ReadingSessionOptions, readerPublicationOptions: EpubReaderPublicationOptions = EpubReaderPublicationOptions(), encryptionMethods: List<EncryptionMethod> = emptyList(), zipResourceProviderOptions: ZipResourceProviderOptions = ZipResourceProviderOptions())

Properties

Link copied to clipboard
val encryptionMethods: List<EncryptionMethod>

A list of EncryptionMethod implementations used for decrypting encrypted resources inside the publication. The Colibrio Reader Framework uses the EPUB OCF encryption.xml file to detect encrypted resources. See https://www.w3.org/publishing/epub3/epub-ocf.html#sec-container-metainf-encryption.xml

Link copied to clipboard
val publicationDataSource: RandomAccessDataSource

A RandomAccessDataSource implementation used for retrieving publication resource data.

Link copied to clipboard
val readerPublicationOptions: EpubReaderPublicationOptions

Options related to processing and presentation of the EPUB publication.

Link copied to clipboard
Link copied to clipboard
val size: Long
Link copied to clipboard
val zipResourceProviderOptions: ZipResourceProviderOptions

The ZipResourceProvider is responsible for extracting resources from the EPUB file, i.e. the publicationDataSource These options configures how the ZipResourceProvider will use the publicationDataSource when fetching data chunks.