quarkdown-core/com.quarkdown.core.media.storage/StoredMedia

StoredMedia

data class StoredMedia(val name: String, val media: Media, val storage: ReadOnlyMediaStorage)

A media file paired with a name, used in a ReadOnlyMediaStorage.

Parameters

name

symbolic name of the media. This is the name which elements in the document should refer to (e.g. a local image). This is reflected to the output file name in the output directory when the media is exported

media

the media

storage

reference to the storage that contains this media.

Constructors

StoredMedia

constructor(name: String, media: Media, storage: ReadOnlyMediaStorage)

Properties

media

val media: Media

name

val name: String

path

val path: String

Retrieves the path a stored media, starting from the output directory and using / as separator.

storage

val storage: ReadOnlyMediaStorage

Functions

path

fun path(separator: String): String

Retrieves the path a stored media, starting from the output directory.