colibrio-reader-framework/com.colibrio.readingsystem.base/ReadingSystemEngine/loadEpub

loadEpub

abstract fun loadEpub(config: EpubRandomAccessDataSourceLoadConfig, onSuccess: (EpubReaderPublication) -> Unit, onError: (ColibrioException) -> Unit)

Loads an EPUB file into the ReadingSystemEngine.

When loading an EPUB using this method, the EPUB file is streamed in chunks from the passed RandomAccessDataSource instance. The framework will download only the requested portions of the publication, thus minimizing load times and data usage.

abstract suspend fun loadEpub(config: EpubRandomAccessDataSourceLoadConfig): ColibrioResult<EpubReaderPublication>

Loads an EPUB file into the ReadingSystemEngine.

When loading an EPUB using this method, the EPUB file is streamed in chunks from the passed RandomAccessDataSource instance. The framework will download only the requested portions of the publication, thus minimizing load times and data usage.

Return

Either ColibrioResult.Success with the created EpubReaderPublication when successful, or ColibrioResult.Error containing the error.

abstract fun loadEpub(config: EpubResourceProviderLoadConfig, onSuccess: (EpubReaderPublication) -> Unit, onError: (ColibrioException) -> Unit)

Loads an EPUB file into the ReadingSystemEngine.

In this case the specified backing ResourceProvider will be used to fetch publication resources instead of extracting them from an .epub file. This allows you for example to load resource form disk or from an HTTP endpoint where the EPUB container has already been extracted.

abstract suspend fun loadEpub(config: EpubResourceProviderLoadConfig): ColibrioResult<EpubReaderPublication>

Loads an EPUB file into the ReadingSystemEngine.

In this case the specified backing ResourceProvider will be used to fetch publication resources instead of extracting them from an .epub file. This allows you for example to load resource form disk or from an HTTP endpoint where the EPUB container has already been extracted.

Return

Either ColibrioResult.Success with the created EpubReaderPublication when successful, or ColibrioResult.Error containing the error.