colibrio-reader-framework/com.colibrio.readingsystem.base/EpubRandomAccessDataSourceLoadConfig

EpubRandomAccessDataSourceLoadConfig

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

Used with ReadingSystemEngine.loadEpub to load EPUB publications using a RandomAccessDataSource.

Constructors

Link copied to clipboard
fun EpubRandomAccessDataSourceLoadConfig(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 the EPUB file data.

Link copied to clipboard
val readerPublicationOptions: EpubReaderPublicationOptions

Options related to processing and presentation of the EPUB publication.

Link copied to clipboard
val readingSessionOptions: ReadingSessionOptions

This data is used to identify reading session using a combination of a user token and publication token. The values that should be used are dependent on your Product Commercial Agreement. This data should be anonymized in order to protect the user's privacy. This information will be sent to Colibrio License Server.

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.