Skip to content

//readium-shared/org.readium.r2.shared.util.mediatype/MediaType/Companion

Companion

[androidJvm]\ object Companion

Functions

Name Summary
of [androidJvm]
suspend fun of(mediaType: String? = null, fileExtension: String? = null, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
Resolves a format from a single file extension and media type hint, without checking the actual content.
[androidJvm]
suspend fun of(mediaTypes: List<String>, fileExtensions: List<String>, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
Resolves a format from file extension and media type hints, without checking the actual content.
[androidJvm]
fun ~~of~~(file: File, mediaType: String? = null, fileExtension: String? = null, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
fun ~~of~~(file: File, mediaTypes: List<String>, fileExtensions: List<String>, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
fun ~~of~~(bytes: () -> ByteArray, mediaType: String? = null, fileExtension: String? = null, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
fun ~~of~~(bytes: () -> ByteArray, mediaTypes: List<String>, fileExtensions: List<String>, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
fun ~~of~~(uri: Uri, contentResolver: ContentResolver, mediaType: String? = null, fileExtension: String? = null, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
fun ~~of~~(uri: Uri, contentResolver: ContentResolver, mediaTypes: List<String>, fileExtensions: List<String>, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
ofBytes [androidJvm]
suspend fun ofBytes(bytes: () -> ByteArray, mediaType: String? = null, fileExtension: String? = null, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
suspend fun ofBytes(bytes: () -> ByteArray, mediaTypes: List<String>, fileExtensions: List<String>, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
Resolves a format from bytes, e.g. from an HTTP response.
ofFile [androidJvm]
suspend fun ofFile(file: File, mediaType: String? = null, fileExtension: String? = null, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
suspend fun ofFile(file: File, mediaTypes: List<String>, fileExtensions: List<String>, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
suspend fun ofFile(path: String, mediaType: String? = null, fileExtension: String? = null, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
suspend fun ofFile(path: String, mediaTypes: List<String>, fileExtensions: List<String>, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
Resolves a format from a local file path.
ofUri [androidJvm]
suspend fun ofUri(uri: Uri, contentResolver: ContentResolver, mediaType: String? = null, fileExtension: String? = null, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
suspend fun ofUri(uri: Uri, contentResolver: ContentResolver, mediaTypes: List<String>, fileExtensions: List<String>, sniffers: List<Sniffer> = MediaType.sniffers): MediaType?
Resolves a format from a content URI and a ContentResolver. Accepts the following URI schemes: content, android.resource, file.
parse [androidJvm]
fun parse(string: String, name: String? = null, fileExtension: String? = null): MediaType?
Creates a MediaType from its RFC 6838 string representation.

Properties

Name Summary
AAC [androidJvm]
val AAC: MediaType
ACSM [androidJvm]
val ACSM: MediaType
AIFF [androidJvm]
val AIFF: MediaType
AUDIOBOOK [androidJvm]
val ~~AUDIOBOOK~~: MediaType
AUDIOBOOK_MANIFEST [androidJvm]
val ~~AUDIOBOOK_MANIFEST~~: MediaType
AVI [androidJvm]
val AVI: MediaType
AVIF [androidJvm]
val AVIF: MediaType
BINARY [androidJvm]
val BINARY: MediaType
BMP [androidJvm]
val BMP: MediaType
CBZ [androidJvm]
val CBZ: MediaType
CSS [androidJvm]
val CSS: MediaType
DIVINA [androidJvm]
val DIVINA: MediaType
DIVINA_MANIFEST [androidJvm]
val DIVINA_MANIFEST: MediaType
EPUB [androidJvm]
val EPUB: MediaType
GIF [androidJvm]
val GIF: MediaType
GZ [androidJvm]
val GZ: MediaType
HTML [androidJvm]
val HTML: MediaType
JAVASCRIPT [androidJvm]
val JAVASCRIPT: MediaType
JPEG [androidJvm]
val JPEG: MediaType
JSON [androidJvm]
val JSON: MediaType
JSON_PROBLEM_DETAILS [androidJvm]
val JSON_PROBLEM_DETAILS: MediaType
JXL [androidJvm]
val JXL: MediaType
LCP_LICENSE [androidJvm]
val ~~LCP_LICENSE~~: MediaType
LCP_LICENSE_DOCUMENT [androidJvm]
val LCP_LICENSE_DOCUMENT: MediaType
LCP_PROTECTED_AUDIOBOOK [androidJvm]
val LCP_PROTECTED_AUDIOBOOK: MediaType
LCP_PROTECTED_PDF [androidJvm]
val LCP_PROTECTED_PDF: MediaType
LCP_STATUS_DOCUMENT [androidJvm]
val LCP_STATUS_DOCUMENT: MediaType
LPF [androidJvm]
val LPF: MediaType
MP3 [androidJvm]
val MP3: MediaType
MPEG [androidJvm]
val MPEG: MediaType
NCX [androidJvm]
val NCX: MediaType
OGG [androidJvm]
val OGG: MediaType
OGV [androidJvm]
val OGV: MediaType
OPDS1 [androidJvm]
val OPDS1: MediaType
OPDS1_ENTRY [androidJvm]
val OPDS1_ENTRY: MediaType
OPDS1_FEED [androidJvm]
val ~~OPDS1_FEED~~: MediaType
OPDS2 [androidJvm]
val OPDS2: MediaType
OPDS2_FEED [androidJvm]
val ~~OPDS2_FEED~~: MediaType
OPDS2_PUBLICATION [androidJvm]
val OPDS2_PUBLICATION: MediaType
OPDS_AUTHENTICATION [androidJvm]
val OPDS_AUTHENTICATION: MediaType
OPUS [androidJvm]
val OPUS: MediaType
OTF [androidJvm]
val OTF: MediaType
PDF [androidJvm]
val PDF: MediaType
PNG [androidJvm]
val PNG: MediaType
READIUM_AUDIOBOOK [androidJvm]
val READIUM_AUDIOBOOK: MediaType
READIUM_AUDIOBOOK_MANIFEST [androidJvm]
val READIUM_AUDIOBOOK_MANIFEST: MediaType
READIUM_WEBPUB [androidJvm]
val READIUM_WEBPUB: MediaType
READIUM_WEBPUB_MANIFEST [androidJvm]
val READIUM_WEBPUB_MANIFEST: MediaType
SMIL [androidJvm]
val SMIL: MediaType
sniffers [androidJvm]
val sniffers: MutableList<Sniffer>
The default sniffers provided by Readium 2 to resolve a MediaType. You can register additional sniffers globally by modifying this list. The sniffers order is important, because some formats are subsets of other formats.
SVG [androidJvm]
val SVG: MediaType
TEXT [androidJvm]
val TEXT: MediaType
TIFF [androidJvm]
val TIFF: MediaType
TTF [androidJvm]
val TTF: MediaType
W3C_WPUB_MANIFEST [androidJvm]
val W3C_WPUB_MANIFEST: MediaType
WAV [androidJvm]
val WAV: MediaType
WEBM_AUDIO [androidJvm]
val WEBM_AUDIO: MediaType
WEBM_VIDEO [androidJvm]
val WEBM_VIDEO: MediaType
WEBP [androidJvm]
val WEBP: MediaType
WEBPUB [androidJvm]
val ~~WEBPUB~~: MediaType
WEBPUB_MANIFEST [androidJvm]
val ~~WEBPUB_MANIFEST~~: MediaType
WOFF [androidJvm]
val WOFF: MediaType
WOFF2 [androidJvm]
val WOFF2: MediaType
XHTML [androidJvm]
val XHTML: MediaType
XML [androidJvm]
val XML: MediaType
ZAB [androidJvm]
val ZAB: MediaType
ZIP [androidJvm]
val ZIP: MediaType