mouthing library

Classes

MouthingResult

The result of mouthing a word: its IPA, and the SignWriting representation in both FSW and SWU (null when the IPA could not be fully mouthed).

Functions

getMouthings() → Map<String, Map<String, dynamic>>

The IPA → mouthing index, with each entry's alternatives also keyed to the same record. Mirrors Python get_mouthings.

getMouthingsWithoutAspiration() → Map<String, Map<String, dynamic>>

Like getMouthings but with the "air blowing out" aspiration mark (S335) stripped and each sign re-boxed. Mirrors Python get_mouthings_without_aspiration, including its in-place processing of records shared between a symbol and its alternatives.

mouth(String word, {required GraphemeToIpa g2p, bool aspiration = false}) → MouthingResult

Mouths a written word for a spoken language, using a supplied g2p grapheme-to-IPA function (epitran has no Dart port — see EPITRAN_PORT.md).

mouthIpa(String characters, {bool aspiration = false}) → String?

Mouths a space-separated IPA string, mouthing each word and joining them. Returns null if any word cannot be mouthed. Mirrors Python mouth_ipa.

mouthIpaSingle(String word, {bool aspiration = false}) → String?

Mouths a single IPA word into an FSW sign, or returns null if any IPA symbol is unknown. Mirrors Python mouth_ipa_single.

Typedefs

GraphemeToIpa = String Function(String word)

A grapheme-to-IPA transliteration function (e.g. a Dart port of epitran, or any other G2P). Used by mouth to turn a written word into IPA.