android-components / mozilla.components.service.pocket.data / PocketListenArticleMetadata

PocketListenArticleMetadata

data class PocketListenArticleMetadata (source)

The metadata for a spoken article’s audio file.

Some documentation on these values, directly from the endpoint, can be found here: https://documenter.getpostman.com/view/777613/S17jXChA#426b37e2-0a4f-bd65-35c6-e14f1b19d0f0

Types

Name Summary
Status enum class Status
A status representing whether or not the audio file is available.

Properties

Name Summary
audioUrl val audioUrl: String
the url to the spoken article’s audio file.
durationSeconds val durationSeconds: Long
length of the audio in seconds.
format val format: String
the encoding format of the audio file, e.g. “mp3”.
size val size: String
size of the audio file in bytes.
status val status: Status
whether or not the audio file is available.
voice val voice: String
the voice name used to speak the article content, e.g. “Salli”.

Extension Functions

Name Summary
loadResourceAsString fun Any.loadResourceAsString(path: String): String
Loads a file from the resources folder and returns its content as a string object.