OSSVoiceEnum

@available(*, deprecated, message: "Use OSSLanguage.catalog and runtime capability APIs.")
public enum OSSVoiceEnum : String, CaseIterable

The available system voices.

The enum is iteratable; access to an array of the enum values can be accessed using:

OSSVoiceEnum.allCases

  • Australian

    Declaration

    Swift

    case Australian = "en-AU"

  • Brazilian

    Declaration

    Swift

    case Brazilian = "pt-BR"

  • Bulgarian

    Declaration

    Swift

    case Bulgarian = "bg-BG"

  • CanadianFrench

    Declaration

    Swift

    case CanadianFrench = "fr-CA"

  • Chinese Traditional

    Declaration

    Swift

    case Chinese = "zh-CH"

  • Chinese Simplified

    Declaration

    Swift

    case ChineseSimplified = "zh-CN"

  • ChineseHongKong

    Declaration

    Swift

    case ChineseHongKong = "zh-HK"

  • Croatian

    Declaration

    Swift

    case Croatian = "hr-HR"

  • Czech

    Declaration

    Swift

    case Czech = "cs-CZ"

  • Danish

    Declaration

    Swift

    case Danish = "da-DK"

  • DutchBelgium

    Declaration

    Swift

    case DutchBelgium = "nl-BE"

  • DutchNetherlands

    Declaration

    Swift

    case DutchNetherlands = "nl-NL"

  • English

    Declaration

    Swift

    case English = "en-GB"

  • Finnish

    Declaration

    Swift

    case Finnish = "fi-FI"

  • French

    Declaration

    Swift

    case French = "fr-FR"

  • German

    Declaration

    Swift

    case German = "de-DE"

  • Greek

    Declaration

    Swift

    case Greek = "el-GR"

  • Hebrew

    Declaration

    Swift

    case Hebrew = "he-IL"

  • Hindi

    Declaration

    Swift

    case Hindi = "hi-IN"

  • Hungarian

    Declaration

    Swift

    case Hungarian = "hu-HU"

  • Indian English

    Declaration

    Swift

    case IndianEnglish = "en-IN"

  • Indonesian

    Declaration

    Swift

    case Indonesian = "id-ID"

  • IrishEnglish

    Declaration

    Swift

    case IrishEnglish = "en-IE"

  • Italian

    Declaration

    Swift

    case Italian = "it-IT"

  • Japanese

    Declaration

    Swift

    case Japanese = "ja-JP"

  • Korean

    Declaration

    Swift

    case Korean = "ko-KR"

  • Malaysian

    Declaration

    Swift

    case Malay = "ms-MY"

  • Mexican

    Declaration

    Swift

    case Mexican = "es-MX"

  • Norwegian

    Declaration

    Swift

    case Norwegian = "no-NO"

  • Norwegian Bokmal

    Declaration

    Swift

    case NorwegianBokmal = "nb-NO"

  • Polish

    Declaration

    Swift

    case Polish = "pl-PL"

  • Portuguese

    Declaration

    Swift

    case Portuguese = "pt-PT"

  • Romanian

    Declaration

    Swift

    case Romanian = "ro-RO"

  • Russian

    Declaration

    Swift

    case Russian = "ru-RU"

  • SaudiArabian

    Declaration

    Swift

    case SaudiArabian = "ar-SA"

  • Slovakian

    Declaration

    Swift

    case Slovakian = "sk-SK"

  • South African English

    Declaration

    Swift

    case SouthAfricanEnglish = "en-ZA"

  • Spanish

    Declaration

    Swift

    case Spanish = "es-ES"

  • Catalan

    Declaration

    Swift

    case SpanishCatalan = "ca-ES"

  • Swedish

    Declaration

    Swift

    case Swedish = "sv-SE"

  • Taiwanese

    Declaration

    Swift

    case Taiwanese = "zh-TW"

  • Thai

    Declaration

    Swift

    case Thai = "th-TH"

  • Turkish

    Declaration

    Swift

    case Turkish = "tr-TR"

  • Ukranian

    Declaration

    Swift

    case Ukranian = "uk-UA"

  • USA English

    Declaration

    Swift

    case UnitedStatesEnglish = "en-US"

  • Vietnamese

    Declaration

    Swift

    case Vietnamese = "vi-VN"

  • Arabic World

    Declaration

    Swift

    case ArabicWorld = "ar-001"

  • Will return specific information about the language as an OSSVoiceInfo object.

    Declaration

    Swift

    public func getDetails() -> OSSVoiceInfo

  • Provides the Enum key itself as a String

    Declaration

    Swift

    public var title: String { get }

  • Demo message is for returning a string in the language that will be read while also providing the name of the voice that Apple have provided.

    Declaration

    Swift

    public var demoMessage: String { get }

  • The legacy image flag for the selected language.

    You can supply your own flag image, provided it has the same name (rawValue) as the packaged image.

    If no image is found in the application bundle, the image from the SDK bundle will be provided.

    Declaration

    Swift

    @available(*, deprecated, message: "Use flagEmoji for text or renderedFlagImage(pointSize:scale:﹚ for UIKit images.")
public var flag: UIImage? { get }

  • The canonical locale used by the modern API.

    Declaration

    Swift

    var canonicalLocaleIdentifier: String { get }

  • Modern metadata corresponding to this legacy case.

    Declaration

    Swift

    var languageMetadata: OSSLanguage { get }

  • Preferred Unicode replacement for the legacy image property.

    Declaration

    Swift

    var flagEmoji: String { get }

  • Renders flagEmoji for UIKit clients.

    Declaration

    Swift

    func renderedFlagImage(
    pointSize: CGFloat = 24,
    scale: CGFloat = 1
) -> UIImage