readium-shared/org.readium.r2.shared

Package-level declarations

Types

data class Clip(val audioResource: String? = null, val fragmentId: String? = null, val start: Double? = null, val end: Double? = null)

DelicateReadiumApi

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "This is a delicate API and its use requires care. Make sure you fully read and understand documentation of the declaration that is marked as a delicate API.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY])

annotation class DelicateReadiumApi

ExperimentalReadiumApi

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "This API is still experimental. It might change in the future without notice.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalReadiumApi

InternalReadiumApi

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This is an internal API that should not be used outside of Readium modules. No compatibility guarantees are provided.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])

annotation class InternalReadiumApi

JSONable

interface JSONable

MediaOverlayNode

data class MediaOverlayNode(val text: Url, val audio: Url?, val children: List<MediaOverlayNode> = listOf(), val role: List<String> = listOf()) : Serializable

MediaOverlays

data class MediaOverlays(nodes: List<MediaOverlayNode> = listOf()) : Serializable

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "Support for SearchService is still experimental. The API may be changed in the future without notice.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY])

annotation class Search

Functions

toJSON

fun List<JSONable>.toJSON(): JSONArray

Serializes a list of JSONable into a JSONArray.