ReadAloudKit for Kotlin/fm.apakabar.readaloudkit

Package-level declarations

Types

Elisions

class Elisions(fullForms: Map<String, List<String>>)

The full forms of each elided spelling a work prints, from the work's own data.

LineSegment

data class LineSegment

One drawable part of a line, preserving the marks and spacing around a word.

NarrationAlignment

@Serializable(with = NarrationAlignment.Serializer::class)

data class NarrationAlignment(val piece: String, val duration: Double, val words: List<NarrationAlignment.Word>, val recording: String? = null)

Word-timing metadata supplied for a recorded narration.

NarrationTimeline

object NarrationTimeline

Builds and queries word-level timelines for recorded speech.

NotUTF8

class NotUTF8 : Exception

A served document that is not UTF-8 text, with or without a byte order mark.

Passage

data class Passage(val lines: List<String>)

The printed lines read as one continuous passage.

PieceProgress

object PieceProgress

Derives ordered piece states from the pieces attempted and cleared.

PieceProgressState

enum PieceProgressState : Enum<PieceProgressState>

What a reader has done with one piece of a staged reading.

PlaybackEnvelope

object PlaybackEnvelope

Shapes the gain at the edges of a playback buffer.

PublishedAlignment

data class PublishedAlignment(val version: String, val alignment: NarrationAlignment)

A narration alignment as the server publishes it: the alignment and the version it was published under.

RecognizerQuirks

class RecognizerQuirks(allowances: Map<String, List<RecognizerQuirks.Allowance>>)

Explicit spellings that one recognizer may return for particular written words.

SpokenLineTracker

class SpokenLineTracker(lines: List<String>, val quirks: RecognizerQuirks, val elisions: Elisions, val tokenizer: WordTokenizer)

Checks a complete spoken attempt against one or more printed lines.

SpokenWord

data class SpokenWord

One spoken word together with its position and source range in the passage.

SpokenWords

object SpokenWords

Decides whether recognized words faithfully represent the printed words.

StageState

enum StageState : Enum<StageState>

Where one stage of a staged reading stands.

UnknownStageState

data class UnknownStageState(val raw: Int) : Exception

A stored stage state this build does not know, perhaps written by a newer one.

VerseLayoutPlan

data class VerseLayoutPlan

The chosen column and visual row starts for every line of verse.

VerseLayoutPlanner

object VerseLayoutPlanner

Plans line turnovers for a whole passage rather than letting each line wrap alone.

WaveformEnvelope

object WaveformEnvelope

Reduces audio samples to normalized display amplitudes.

WordAttempt

data class WordAttempt(val word: String, val check: WordCheck)

A printed word paired with the result of one reading attempt.

WordCheck

@Serializable

enum WordCheck : Enum<WordCheck>

The persisted result of checking one printed word.

WordReadingState

enum WordReadingState : Enum<WordReadingState>

How one printed word is presented while a reading is in progress.

WordTiming

data class WordTiming

The interval in which one word is spoken in a recording.

WordTokenizer

class WordTokenizer(val interiorMarks: Set<Int>)

Splits printed lines into the words a reader actually says.

Functions

timings

fun TranscriptAligner.timings(words: List<SpokenWord>, heard: List<RecognizedWord>, duration: Double, weighting: SpeechWeighting): List<WordTiming>

Aligns recognized words with printed words and returns passage-aware timings.