readium-shared/org.readium.r2.shared.util.format

Package-level declarations

Types

ArchiveSniffer

object ArchiveSniffer : FormatSniffer

Sniffs a simple Archive-based publication format, like Comic Book Archive or Zipped Audio Book.

AudioSniffer

object AudioSniffer : FormatSniffer

Sniffs audio files.

BitmapSniffer

object BitmapSniffer : FormatSniffer

Sniffs a bitmap image.

BlobSniffer

interface BlobSniffer

Tries to refine a Format by sniffing a Readable blob.

CompositeFormatSniffer

class CompositeFormatSniffer(sniffers: List<FormatSniffer>) : FormatSniffer

ContainerSniffer

interface ContainerSniffer

Tries to refine a Format by sniffing a Container.

CssSniffer

object CssSniffer : FormatSniffer

Sniffs CSS.

EpubDrmSniffer

object EpubDrmSniffer : FormatSniffer

Sniffs LCP and Adept protection on EPUBs.

EpubSniffer

object EpubSniffer : FormatSniffer

Sniffs an EPUB publication.

Format

data class Format(val specification: FormatSpecification, val mediaType: MediaType, val fileExtension: FileExtension)

FormatHints

data class FormatHints(val mediaTypes: List<MediaType> = emptyList(), val fileExtensions: List<FileExtension> = emptyList())

Bundle of media type and file extension hints for the FormatHintsSniffer.

FormatHintsSniffer

interface FormatHintsSniffer

Tries to guess a Format from media type and file extension hints.

FormatSniffer

interface FormatSniffer : FormatHintsSniffer, BlobSniffer, ContainerSniffer

Tries to refine a Format by sniffing format hints or content.

FormatSpecification

@JvmInline

value class FormatSpecification(val specifications: Set<Specification>)

HtmlSniffer

object HtmlSniffer : FormatSniffer

Sniffs an HTML or XHTML document.

JavaScriptSniffer

object JavaScriptSniffer : FormatSniffer

Sniffs JavaScript.

JsonSniffer

object JsonSniffer : FormatSniffer

Sniffs a JSON document.

LcpLicenseSniffer

object LcpLicenseSniffer : FormatSniffer

Sniffs an LCP License Document.

LpfSniffer

object LpfSniffer : FormatSniffer

Sniffs a Lightweight Packaging Format (LPF).

Opds1Sniffer

object Opds1Sniffer : FormatSniffer

Sniffs an OPDS1 document.

Opds2Sniffer

object Opds2Sniffer : FormatSniffer

Sniffs an OPDS 2 document.

PdfSniffer

object PdfSniffer : FormatSniffer

Sniffs a PDF document.

RarSniffer

object RarSniffer : FormatSniffer

Sniffs a RAR archive.

RpfSniffer

object RpfSniffer : FormatSniffer

Sniffs a Readium Web Publication, protected or not by LCP.

RwpmSniffer

object RwpmSniffer : FormatSniffer

Sniffs a Readium Web Manifest.

Specification

interface Specification

W3cWpubSniffer

object W3cWpubSniffer : FormatSniffer

Sniffs a W3C Web Publication Manifest.

ZipSniffer

object ZipSniffer : FormatSniffer

Sniffs a ZIP archive.